Powersoft 365 API Documentation

agent


GET /agent

To get a specific agent.

/agent?token=XXXXX&agent_code_365=JD

field description
token Credentials provided by Powersoft that allow access to the API
agent_code_365 Agent code as is registered in 365

Returns


POST /agent

To create an agent.


field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
agent
agent_code_365 string The unique code of the agent in your system. It will be saved the same in 365. It must not exceeds 50 characters.
agent_first_name string First name of the agent.
agent_last_name string Surname of the agent. Pass "" if none
store_code_365 string The store code in 365 to which this agent belongs to.
active bool If the agent is active, then true, else false.
tel_1 string The telephone 1 of the agent. Pass "" if none.
tel_2 string The telephone 2 of the agent. Pass "" if none.
mobile string The mobile number of the agent. Pass "" if none.
fax string The fax of the agent. Pass "" if none.
email string The email address of the agent. Pass "" if none.
website string The website address of the agent. Pass "" if none.
country_code_iso2 string The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none.

Returns

The standard api_response object. When a new record is created, the Powersoft365 id is returned in the response_id field.


PUT /agent

To modify an existing agent.


field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
agent
agent_code_365 string The 365 agent code.
agent_first_name string First name of the agent.
agent_last_name string Surname of the agent. Pass "" if none
store_code_365 string The store code in 365 to which this agent belongs to.
active bool If the agent is active, then true, else false.
tel_1 string The telephone 1 of the agent. Pass "" if none.
tel_2 string The telephone 2 of the agent. Pass "" if none.
mobile string The mobile number of the agent. Pass "" if none.
fax string The fax of the agent. Pass "" if none.
email string The email address of the agent. Pass "" if none.
website string The website address of the agent. Pass "" if none.
country_code_iso2 string The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none.

Returns

The standard api_response object. The Powersoft365 id is returned in the response_id field.