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.

Send a Follow-ups message

POST
/api/v1/follow-ups/{id}/send
curl --request POST \
--url https://api.pitch2sale.com/api/v1/follow-ups/example/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "channel": "email", "subject": "example", "body": "example" }'

Sends the message on the chosen channel after re-running the consent, opt-out, quiet-hours and WhatsApp 24-hour checks. 422 { reason, detail } when it may not be sent; 409 when the card is already being sent or closed.

id
required
string
/^[0-9a-fA-F]{24}$/
Media typeapplication/json
object
channel
required
string
Allowed values: email whatsapp sms
subject
string
<= 500 characters
body
required
string
>= 1 characters <= 20000 characters

Sent, or (WhatsApp auto follow-ups) waiting: queued is qr (sent from your QR number within minutes) or window (an opener template went; the message goes when the lead replies), and activity_id is null.

Media typeapplication/json
object
activity_id
required
string | null
touch_id
required
string | null
queued
string
Allowed values: qr window
Example
{
"queued": "qr"
}

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; OAuth app tokens are not accepted on this route

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