Update an agent

patch

https://api.repliers.io/agents/{agentId}

Use this endpoint to update information associated with an agent.

Path Params

agentId

int32

required

Body Params

fname

string

The first name of the agent.

lname

string

The last name of the agent.

phone

string

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

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

string

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

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

designation

string

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

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

Responses

Language

Credentials

Header

Response

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

application/json

200200

400Bad Request