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.

Lift a WhatsApp block on a lead (admins)

POST
/api/v1/leads/{id}/whatsapp-unblock
curl --request POST \
--url https://api.pitch2sale.com/api/v1/leads/example/whatsapp-unblock \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reason": "example" }'

For a block set by mistake. Needs the settings edit permission and a reason, which is kept in the event log. The lead goes back to “not recorded”: consent must be recorded again before anything is sent, and a STOP opt-out still applies. 404 when the lead is not blocked.

id
required
string
/^[0-9a-fA-F]{24}$/
Media typeapplication/json
object
reason
required
string
>= 3 characters <= 200 characters
Examplegenerated
{
"reason": "example"
}

Unblocked

Media typeapplication/json
object
unblocked
required
boolean
Example
{
"unblocked": true
}

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"
}
]
}