Update a client

patch

https://api.repliers.io/clients/{clientId}

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

Important - a client must always have at least one of phone or email. Neither can be removed through this endpoint, and an update that would leave the client with neither is rejected with a 400 error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

int32

required

Body Params

agentId

int32

The agentId of the agent that this client is assigned to. Each client must be assigned to an agent. Must be an existing agent in your account, otherwise a 400 error is returned.

fname

string

The first name of this client

lname

string

The last name of this client.

phone

string

The mobile phone number of this client (May be used to deliver text messages). Must be 11 digits in length.

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

string

The email address of this client (May be used to send emails).

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,}))

status

boolean

If false, disables all operations for the client.

preferences

object

tags

externalId

string

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

Responses

404

No client with the supplied clientId exists in your account.

409

The email or phone number is already in use by another client or agent 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.