Skip to main content
POST
Add a note to a callback

Authorizations

Authorization
string
header
required

Project API key (sk_api_…).

Path Parameters

callbackId
string
required

The callbackId from the callbacks list or a callback webhook.

Body

application/json
text
string
required

The note. Not blank, at most 2,000 bytes in UTF-8 (about 1,000 Urdu characters).

Response

The callback, with the note at the end of its timeline.

One contact's request to be called again.

callbackId
string

The callback's id.

organizationId
string<uuid>
projectId
string<uuid>
assistantId
string<uuid>

The assistant that was on the call.

campaignId
string<uuid>

Always the campaign in the path.

sessionId
string

The call that asked for it. Pass it to the session detail for the transcript.

kind
enum<string>

human: a person must call back. later: call again, and the assistant may do it. On a campaign, a later callback requeues the contact for callbackAfter. Callbacks from before kinds existed have no kind and are all for a person.

Available options:
human,
later
reason
string

One line on why.

requestedText
string

The contact's words that asked for the callback.

callbackAfter
string<date-time>

When to call, as ISO-8601 with the offset of timezone, like 2026-10-29T15:00:00+05:00. Both kinds get the time the contact named. When no time was said, a later callback gets two hours after the call, and a human callback has none. Absent when the time is tied to an event or more than 30 days away. Older callbacks can hold free text here.

timezone
string

The IANA zone callbackAfter was resolved in.

Example:

"Asia/Karachi"

status
enum<string>

open: a person must act. scheduled: the assistant calls at callbackAfter. done: a redial reached the contact, or a person closed it. failed: the redial cycle ended without reaching the contact. You can set open or done with PATCH /campaigns/callbacks/{callbackId}.

Available options:
open,
scheduled,
done,
failed
redial
object

later callbacks on campaign calls only. What became of the assistant's redial.

timeline
object[]

What happened to the callback, oldest first. Absent on older callbacks, whose history was not recorded.

createdAt
string<date-time>

When the call was analysed, not when it was placed.

updatedAt
string<date-time>

Last change; equal to createdAt until one happens.