HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io

Create agent

post
https://api.revioapi.com/v1/Agents

Create a new agent.

Body Params

The agent to create.

int32

Primary identifier for this agent.

int32
0 to 2147483647

Foreign identifier indicating a parent agent.

int32
0 to 2147483647

Foreign identifier indicating the type of agent.

int32
0 to 2147483647

Foreign identifier indicating the commission plan assigned to the agent.

int32
0 to 2147483647

Foreign identifier indicating the address for this agent.

string
length between 0 and 100

Customizable account identifier.

string
length between 1 and 255

Name of the agent or agency.

string
length between 0 and 500

Primary contact email (or emails separated by comma).

string
length between 0 and 50

Primary contact phone number.

string
length between 0 and 50

Primary contact fax number.

string
enum
required

Current status of the agent.

Allowed:
boolean

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.

string
length between 0 and 50

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

int32
0 to 2147483647

Foreign identifier indicating the bill profile associated with this agent.

date-time

Date and time this agent was created.

int32

Foreign identifier indicating the user who created this agent.

int32
0 to 2147483647

Foreign identifier indicating the file that contains the agent logo.

fields
array of objects

List of custom fields and their values.

fields
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html
Updated 7 months ago