Create a client

post

https://api.repliers.io/clients

Use this endpoint to create a client. When creating saved searches, messages or favorites a client needs to be specified.

Important - at least one of phone or email must be provided. A request that contains neither is rejected with a 400 error.

Email and phone must be unique across all clients and agents 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

agentId

int32

required

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. Required if email is not provided.

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

string

The email address of this client (May be used to send emails). Required if phone is not provided.

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

Defaults to true

If false, disables all operations for the client.

preferences

object

200200

400Bad Request

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