Skip to main content
POST
Update CRM Overview
Creates a subscriber’s CRM deal, or updates it. Read the current deal, and the pipeline_id and stage_id it uses, with CRM Overview.

Example Request

Only phone_number_id and phone_number are required. A successful call answers {"status":"1","message":"CRM Overview updated successfully"}.

How it behaves

The first call creates the deal, in the default pipeline at its first stage, titled with the subscriber’s name and with the source WhatsApp. That happens even if you send no optional fields.
Fields you leave out are kept. Unlike Subscriber Update, changing only the lead score leaves the title, value, stage and the rest exactly as they were.
A stage or pipeline that doesn’t exist is silently ignored. The call still answers CRM Overview updated successfully and the deal stays where it was — so a success response does not prove the deal moved. Read it back with CRM Overview and compare stage_id. In the account tested, one pipeline had the stages New, Qualified, Proposal and Negotiation; ids belonging to other pipelines, or to nothing, did not move the deal.
An unknown subscriber is answered with {"status":"0","message":"Subscriber not found"}, and a missing phone_number_id or phone_number with The phone number id field is required., The phone number field is required.

Body

application/x-www-form-urlencoded
apiToken
string
required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

phone_number_id
string
required

The WhatsApp account's phone number ID. Where to find it.

Example:

"PHONE-NUMBER-ID"

phone_number
string
required

The subscriber's phone number, with country code, digits only.

Example:

"PHONE-NUMBER"

title
string

Deal title, up to 255 characters.

Example:

"New Deal"

pipeline_id
integer

Pipeline id, from CRM Overview. Ignored if it is not a pipeline of this account.

Example:

376

stage_id
integer

Stage id within the subscriber's pipeline, from CRM Overview. Ignored, with a success response, if it is not a stage of that pipeline.

Example:

2252

value
number

Deal value. Zero or more.

Example:

500

currency
string

Currency code such as USD, BDT, MYR or EUR. Stored upper-case; not validated.

Example:

"USD"

expected_close_date
string

Expected close date, YYYY-MM-DD.

Example:

"2026-10-15"

owner_user_id
integer

The deal owner: a team member id from Team Member List.

Example:

12

lead_score
enum<string>

Lead score, lower case.

Available options:
hot,
warm,
cold
Example:

"hot"

source
string

Where the lead came from.

Example:

"WhatsApp"

Response

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status
string
message
any