Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Record or withdraw WhatsApp consent on up to 500 leads

POST
/api/v1/leads/bulk/whatsapp-consent
curl --request POST \
--url https://api.pitch2sale.com/api/v1/leads/bulk/whatsapp-consent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "lead_ids": [ "example" ], "source": "example", "state": "explicit" }'

For leads who agreed to WhatsApp elsewhere (for example on LinkedIn). source says where; state: "none" withdraws consent. Leads you cannot edit, leads outside your organization and blocked leads are skipped; updated counts what changed. WhatsApp auto follow-ups only message leads with recorded consent.

Media typeapplication/json
object
lead_ids
required
Array<string>
>= 1 items <= 500 items
source
required
string
>= 1 characters <= 60 characters
state
string
default: explicit
Allowed values: explicit none

Number of leads changed

Media typeapplication/json
object
updated
required
number
Examplegenerated
{
"updated": 1
}

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}