Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

The canceled follow-up

id
string
required
object
string
required
reason
enum<string>
required
Available options:
lead,
reactivation
status
enum<string>
required
Available options:
active,
replied,
booked,
opted_out,
canceled,
failed,
completed
step
integer
required
next_at
string<date-time> | null
required
message
string | null
required
launch_id
string | null
required
error
string | null
required
ended_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
counterpart
string
required
customer
string | null
required