v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

Agents

Replace agent

Replace an existing agent.

put/v1/Agents/{id}

Path parameters

idinteger required

Format - int32. ID of the agent to replace.

Request body

agent_idinteger

Primary identifier for this agent.

parent_agent_idinteger

Foreign identifier indicating a parent agent.

agent_type_idinteger

Foreign identifier indicating the type of agent.

default_commission_plan_idinteger

Foreign identifier indicating the commission plan assigned to the agent.

address_idinteger

Foreign identifier indicating the address for this agent.

account_numberstring

Customizable account identifier.

namestring

Name of the agent or agency.

emailstring

Primary contact email (or emails separated by comma).

phonestring

Primary contact phone number.

faxstring

Primary contact fax number.

status'ACTIVE' | 'INACTIVE' required

Current status of the agent.

show_unrestricted_packagesboolean

Indicates whether the agent can see packages that are not restricted any particular agent. Even when enabled, packages restricted to a different agent are still hidden.

tax_identification_numberstring

Tax identification number (i.e. SSN, EIN).

company_bill_profile_idinteger

Foreign identifier indicating the bill profile associated with this agent.

created_datestring date-time

Date and time this agent was created.

created_byinteger

Foreign identifier indicating the user who created this agent.

logo_file_idinteger

Foreign identifier indicating the file that contains the agent logo.

Response

okboolean