API Reference

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.

Body Params
int32
required

The agentId of the agent that this client is assigned to. Each client must be assigned to an agent.

string

The first name of this client

string

The last name of this client.

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

boolean
Defaults to true

If false, disables all operations for the client.

preferences
object
tags
array of strings

You may categorize this client using tags. Tags are useful for filtering purposes and building lists of specific clients. For example, if this client is a buyer from Toronto, you may want to create tags for "Buyer" and "Toronto".

tags
string

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated 10 months ago