Skip to main content
POST
Create a Contact follow-up from a thread

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. REST requires a Sanctum API key. Separately, interactive MCP clients can use registered OAuth applications with PKCE and audience-bound workspace grants; those tokens are not REST credentials.

Headers

Idempotency-Key
string

Optional 8–120 character key for replayable mutations. Send the exact same method, URI, and body on retries; receipts expire after 24 hours.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required
thread
string<uuid>
required

Body

application/json
title
string
required
Maximum string length: 500
due_at
string<date-time>
required

A time in the future.

timezone
string
required

IANA time zone.

recurrence
enum<string>
required
Available options:
none,
weekly,
two_weeks,
monthly,
six_weeks,
quarterly,
six_months,
yearly
message_id
string<uuid> | null

Response

Successful data envelope.

data
any
required
meta
object
required