Create an agent

post

https://api.repliers.io/agents

Use this endpoint to create an agent. Each client that you create needs to be associated with an agent, therefore it's necessary to create at least one agent before you start creating clients.

Important - email and phone must be unique across all agents and clients in your account. A duplicate is rejected with a 409 error. Email matching is case-insensitive.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

fname

string

required

The first name of the agent.

lname

string

required

The last name of the agent.

phone

string

required

The mobile phone number of the agent. Must be 11 digits in length.

Regex pattern: ^(1)([0-9]{10})$

string

required

The email address of the agent.

Regex pattern: ^(([^<>()[]\.,;:\s@"]+(.[^<>()[]\.,;:\s@"]+)*)|(".+"))@(([[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}])|(([a-zA-Z-0-9]+.)+[a-zA-Z]{2,}))

brokerage

string

required

The name of the Brokerage/Office that this agent is registered with.

designation

string

required

This agent's designation. For example, "Sales Representative"

avatar

string

A URL/Path to an avatar/picture of this agent.

status

boolean

Defaults to true

If false, disables all operations for the agent.

location

object

externalId

string

length ≤ 255

The externalId is intended for storing agent identifiers from external systems (such as CRMs) for reference purposes. Maximum 255 characters.

Responses

409

The email or phone number is already in use by another agent or client in your account.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad Request

401The API key was not recognized by the API server, or the key is not active.