Create Chat

Create a new chat conversation and contact record for a phone number in the CRM.

Call this before sending a message to a new contact. If a chat already exists for this phone number on the same channel, a new record will still be created.

Required steps before calling:

  1. Obtain a JWT via POST /api/wp-crm/token
  2. Get your channelId from GET /api/wp-crm/channels/:orgId

Returns a chatId — use this in POST /api/wp-crm/messaging/send-message to send messages to this contact.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a new chat conversation and contact record for a phone number in the CRM.

Call this before sending a message to a new contact. If a chat already exists for this phone number on the same channel, a new record will still be created.

**Required steps before calling:**

1. Obtain a JWT via POST

2. Get your channelId from GET /api/wp-crm/channels/:orgIdReturns a chatId — use this in POST /api/wp-crm/messaging/send-message to send messages to this contact.

Body Params
string
required

First name of the contact

string
required

Last name of the contact

string
required

Country calling code including the + prefix (e.g., +91 for India, +1 for US)

string
required

Phone number without country code or spaces

string
required

Channel UUID from GET /api/wp-crm/channels/:orgId — the channel through which this chat will be created

string
required

Your organisation UUID (returned as org from the /token endpoint)

boolean
Defaults to false

When true, a newly created chat is NOT surfaced at the top of the agents' chat list. Pair with a silent send so automated/transactional outreach to brand-new contacts does not flood the inbox. Has no effect if the chat already exists.

Responses

400

Bad request — missing or invalid fields

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — the specified channel does not belong to this organisation

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json