Update an agent

patch

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

Updates one or more fields for an existing agent. Only include the fields you wish to change — omitted fields retain their current values.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

length ≤ 255

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

Responses

404

No agent with the supplied agentId exists in your account.

409

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

200200

400Bad Request

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