Skip to main content
POST
Create Follow-up

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
note
string
required

What to check or do when the follow-up fires.

Required string length: 1 - 4000
threadId
string
required

The assistant conversation (session) to continue.

Required string length: 1 - 200
at
string<date-time>

Future ISO 8601 time with timezone. Use only one trigger.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
after
string

Delay such as 90m, 4h, 14d or 2w.

eventType
enum<string>

Fire on this event's first matching occurrence.

Available options:
telegram.message.received,
customer.message.received,
product.created,
product.updated,
product.deleted,
product.delisted,
product.price.changed,
product.inventory.changed,
product.enrichment.started,
product.enrichment.completed,
product.listing.error,
product.geo.created,
product.geo.updated,
product.ai_visibility.measured,
agent.action.approved,
order.created,
order.updated,
order.deleted,
order.status.changed,
look.created,
look.deleted,
review.created,
review.updated,
review.status.changed,
campaign.started,
campaign.window.started,
campaign.window.completed,
campaign.window.failed,
campaign.offer.failed,
campaign.completed,
account_statement.created,
account_statement.updated,
account_statement.status.changed,
account_statement.reconciliation.changed,
account_statement.transactions.synced,
account_statement.transactions.failed,
account_statement.sync.queued,
account_statement.sync.started,
account_statement.sync.completed,
account_statement.sync.failed,
account_statement.sync.unavailable
match
string

CEL event filter, e.g. event.sku == "A-1". Only with eventType.

Maximum string length: 2000
then
enum<string>

resume continues this chat (default); notify only emails you.

Available options:
resume,
notify
expires
string

Expiry duration; events default to 10d. Must outlast a timed trigger.

organizationId
string
Required string length: 1 - 120

Response

The follow-up, waiting.

ok
boolean
operationId
string
status
string
data
object