API reference

The technical reference below is in English.

Personal server-side API keys bind one issuing user to one workspace. Current membership, role and seat are rechecked on every request. Read-only is the default; write includes CRM creation/updates and drafts/uploads, and publish is cumulative. Never put keys in a browser, URL, source control or analytics. Requests carrying an Origin, Sec-Fetch-Site, Sec-Fetch-Dest or Sec-Fetch-User header are rejected; a lone Sec-Fetch-Mode, which Node's built-in fetch adds on a server, is accepted. No cookies or OAuth/JWT fallback. The operator controls availability.

Base URL

https://api.lead-knight.com/v1

Authentication

developerApi

Authorization: Bearer lk_api_<43 base64url characters>

Create in Settings → Developer API. Displayed once; expires in 1–365 days (default 90), or has no expiry, and can be revoked. Store only in your server's secret environment.

Download OpenAPI 3.1

contacts

GET `/contacts`

CRM-visible contacts, newest first; cursor binds person, workspace and filters. Identifiers retain CRM redaction.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

q

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 100

stageId

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

includeLost

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	enum: ["true","false"]

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].displayName`	string \| null	Yes
`items[].phone`	string \| null	Yes
`items[].email`	string \| null	Yes
`items[].ownerUserId`	string	Yes	format: "uuid"
`items[].ownerName`	string \| null	Yes
`items[].stageId`	union	Yes
`items[].stageId (anyOf 1)`	string	—	format: "uuid"
`items[].stageId (anyOf 2)`	null	—
`items[].stageEnteredAt`	union	Yes
`items[].stageEnteredAt (anyOf 1)`	string	—	format: "date-time"
`items[].stageEnteredAt (anyOf 2)`	null	—
`items[].dealValueMinor`	union	Yes
`items[].dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`items[].dealValueMinor (anyOf 2)`	null	—
`items[].dealCurrency`	union	Yes
`items[].dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`items[].dealCurrency (anyOf 2)`	null	—
`items[].tags`	array	Yes
`items[].tags[]`	string	—
`items[].custom`	object	Yes	additionalProperties: {"type":"string"}
`items[].lossReason`	union	Yes
`items[].lossReason (anyOf 1)`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`items[].lossReason (anyOf 2)`	null	—
`items[].lossNote`	string \| null	Yes
`items[].origin`	union	Yes
`items[].origin (anyOf 1)`	object	—	additionalProperties: false
`items[].origin (anyOf 1).kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown","outreach"]
`items[].origin (anyOf 1).platform`	union	Yes
`items[].origin (anyOf 1).platform (anyOf 1)`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`items[].origin (anyOf 1).platform (anyOf 2)`	null	—
`items[].origin (anyOf 1).detail`	string \| null	Yes
`items[].origin (anyOf 2)`	null	—
`items[].pendingTransfer`	union	Yes
`items[].pendingTransfer (anyOf 1)`	object	—	additionalProperties: false
`items[].pendingTransfer (anyOf 1).id`	string	Yes	format: "uuid"
`items[].pendingTransfer (anyOf 1).toUserId`	string	Yes	format: "uuid"
`items[].pendingTransfer (anyOf 1).toName`	string \| null	Yes
`items[].pendingTransfer (anyOf 1).requestedByUserId`	string	Yes	format: "uuid"
`items[].pendingTransfer (anyOf 1).requestedByName`	string \| null	Yes
`items[].pendingTransfer (anyOf 1).reason`	string \| null	Yes
`items[].pendingTransfer (anyOf 1).createdAt`	string	Yes	format: "date-time"
`items[].pendingTransfer (anyOf 1).canDecide`	boolean	Yes
`items[].pendingTransfer (anyOf 2)`	null	—
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`items[].entryKind`	union	Yes
`items[].entryKind (anyOf 1)`	string	—	enum: ["manual","chat","assistant","booking","import","site_form","ad_form","signup","api"]
`items[].entryKind (anyOf 2)`	null	—
`nextCursor`	string \| null	Yes

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/contacts`

Write access and crm:write. Required workspace-wide externalId replays across keys/users without changing existing fields. Attribution may attach to one editable identity match. No attribution means an identity duplicate conflicts. Consent is required for click ids/IP/user agent.

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`externalId`	string	Yes	minLength: 1 · maxLength: 200 · pattern: "^[\\x21-\\x7e]+$"
`displayName`	string	Yes	minLength: 1 · maxLength: 120
`phone`	union	Yes
`phone (anyOf 1)`	string	—	maxLength: 32
`phone (anyOf 2)`	null	—
`email`	union	Yes
`email (anyOf 1)`	string	—	format: "email" · maxLength: 254
`email (anyOf 2)`	null	—
`stageId`	string	—	format: "uuid"
`ownerUserId`	string	—	format: "uuid"
`tags`	array	—	maxItems: 20
`tags[]`	string	—	minLength: 1 · maxLength: 40
`custom`	object	—	additionalProperties: {"type":"string","maxLength":500}
`dealValueMinor`	integer	—	minimum: 0 · maximum: 9007199254740991
`dealCurrency`	string	—	enum: ["ILS","USD","EUR"]
`origin`	object	—	additionalProperties: false
`origin.kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown"]
`origin.platform`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`origin.detail`	string	—	maxLength: 200
`attribution`	object	—	additionalProperties: false
`attribution.pageUrl`	string	—	format: "uri" · maxLength: 2000
`attribution.eventId`	string	—	minLength: 1 · maxLength: 500
`attribution.utm`	object	—	additionalProperties: false
`attribution.utm.source`	union	—
`attribution.utm.source (anyOf 1)`	string	—	maxLength: 200
`attribution.utm.source (anyOf 2)`	null	—
`attribution.utm.medium`	union	—
`attribution.utm.medium (anyOf 1)`	string	—	maxLength: 200
`attribution.utm.medium (anyOf 2)`	null	—
`attribution.utm.campaign`	union	—
`attribution.utm.campaign (anyOf 1)`	string	—	maxLength: 200
`attribution.utm.campaign (anyOf 2)`	null	—
`attribution.utm.term`	union	—
`attribution.utm.term (anyOf 1)`	string	—	maxLength: 200
`attribution.utm.term (anyOf 2)`	null	—
`attribution.utm.content`	union	—
`attribution.utm.content (anyOf 1)`	string	—	maxLength: 200
`attribution.utm.content (anyOf 2)`	null	—
`attribution.clickIds`	object	—	additionalProperties: false
`attribution.clickIds.fbclid`	union	—
`attribution.clickIds.fbclid (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.fbclid (anyOf 2)`	null	—
`attribution.clickIds.gclid`	union	—
`attribution.clickIds.gclid (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.gclid (anyOf 2)`	null	—
`attribution.clickIds.gbraid`	union	—
`attribution.clickIds.gbraid (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.gbraid (anyOf 2)`	null	—
`attribution.clickIds.wbraid`	union	—
`attribution.clickIds.wbraid (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.wbraid (anyOf 2)`	null	—
`attribution.clickIds.ttclid`	union	—
`attribution.clickIds.ttclid (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.ttclid (anyOf 2)`	null	—
`attribution.clickIds.li_fat_id`	union	—
`attribution.clickIds.li_fat_id (anyOf 1)`	string	—	maxLength: 500
`attribution.clickIds.li_fat_id (anyOf 2)`	null	—
`attribution.clickIds.fbc`	string	—	maxLength: 500
`attribution.clickIds.fbp`	string	—	maxLength: 500
`attribution.ip`	string	—
`attribution.ip (anyOf 1)`	value	—	format: "ipv4"
`attribution.ip (anyOf 2)`	value	—	format: "ipv6"
`attribution.userAgent`	string	—	maxLength: 300
`attribution.adConsent`	string	Yes	enum: ["granted","denied"]

Responses

HTTP 200 — Existing contact; externalId is find-or-create, not an update.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`contact`	object	Yes	additionalProperties: false
`contact.id`	string	Yes	format: "uuid"
`contact.displayName`	string \| null	Yes
`contact.phone`	string \| null	Yes
`contact.email`	string \| null	Yes
`contact.ownerUserId`	string	Yes	format: "uuid"
`contact.ownerName`	string \| null	Yes
`contact.stageId`	union	Yes
`contact.stageId (anyOf 1)`	string	—	format: "uuid"
`contact.stageId (anyOf 2)`	null	—
`contact.stageEnteredAt`	union	Yes
`contact.stageEnteredAt (anyOf 1)`	string	—	format: "date-time"
`contact.stageEnteredAt (anyOf 2)`	null	—
`contact.dealValueMinor`	union	Yes
`contact.dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`contact.dealValueMinor (anyOf 2)`	null	—
`contact.dealCurrency`	union	Yes
`contact.dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`contact.dealCurrency (anyOf 2)`	null	—
`contact.tags`	array	Yes
`contact.tags[]`	string	—
`contact.custom`	object	Yes	additionalProperties: {"type":"string"}
`contact.lossReason`	union	Yes
`contact.lossReason (anyOf 1)`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`contact.lossReason (anyOf 2)`	null	—
`contact.lossNote`	string \| null	Yes
`contact.origin`	union	Yes
`contact.origin (anyOf 1)`	object	—	additionalProperties: false
`contact.origin (anyOf 1).kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown","outreach"]
`contact.origin (anyOf 1).platform`	union	Yes
`contact.origin (anyOf 1).platform (anyOf 1)`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`contact.origin (anyOf 1).platform (anyOf 2)`	null	—
`contact.origin (anyOf 1).detail`	string \| null	Yes
`contact.origin (anyOf 2)`	null	—
`contact.pendingTransfer`	union	Yes
`contact.pendingTransfer (anyOf 1)`	object	—	additionalProperties: false
`contact.pendingTransfer (anyOf 1).id`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).toUserId`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).toName`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).requestedByUserId`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).requestedByName`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).reason`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).createdAt`	string	Yes	format: "date-time"
`contact.pendingTransfer (anyOf 1).canDecide`	boolean	Yes
`contact.pendingTransfer (anyOf 2)`	null	—
`contact.createdAt`	string	Yes	format: "date-time"
`contact.updatedAt`	string	Yes	format: "date-time"
`contact.entryKind`	union	Yes
`contact.entryKind (anyOf 1)`	string	—	enum: ["manual","chat","assistant","booking","import","site_form","ad_form","signup","api"]
`contact.entryKind (anyOf 2)`	null	—
`contact.notes`	array	Yes
`contact.notes[]`	object	—	additionalProperties: false
`contact.notes[].id`	string	Yes	format: "uuid"
`contact.notes[].authorUserId`	string	Yes	format: "uuid"
`contact.notes[].authorName`	string \| null	Yes
`contact.notes[].body`	string	Yes
`contact.notes[].createdAt`	string	Yes	format: "date-time"
`created`	boolean	Yes

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`contact`	object	Yes	additionalProperties: false
`contact.id`	string	Yes	format: "uuid"
`contact.displayName`	string \| null	Yes
`contact.phone`	string \| null	Yes
`contact.email`	string \| null	Yes
`contact.ownerUserId`	string	Yes	format: "uuid"
`contact.ownerName`	string \| null	Yes
`contact.stageId`	union	Yes
`contact.stageId (anyOf 1)`	string	—	format: "uuid"
`contact.stageId (anyOf 2)`	null	—
`contact.stageEnteredAt`	union	Yes
`contact.stageEnteredAt (anyOf 1)`	string	—	format: "date-time"
`contact.stageEnteredAt (anyOf 2)`	null	—
`contact.dealValueMinor`	union	Yes
`contact.dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`contact.dealValueMinor (anyOf 2)`	null	—
`contact.dealCurrency`	union	Yes
`contact.dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`contact.dealCurrency (anyOf 2)`	null	—
`contact.tags`	array	Yes
`contact.tags[]`	string	—
`contact.custom`	object	Yes	additionalProperties: {"type":"string"}
`contact.lossReason`	union	Yes
`contact.lossReason (anyOf 1)`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`contact.lossReason (anyOf 2)`	null	—
`contact.lossNote`	string \| null	Yes
`contact.origin`	union	Yes
`contact.origin (anyOf 1)`	object	—	additionalProperties: false
`contact.origin (anyOf 1).kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown","outreach"]
`contact.origin (anyOf 1).platform`	union	Yes
`contact.origin (anyOf 1).platform (anyOf 1)`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`contact.origin (anyOf 1).platform (anyOf 2)`	null	—
`contact.origin (anyOf 1).detail`	string \| null	Yes
`contact.origin (anyOf 2)`	null	—
`contact.pendingTransfer`	union	Yes
`contact.pendingTransfer (anyOf 1)`	object	—	additionalProperties: false
`contact.pendingTransfer (anyOf 1).id`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).toUserId`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).toName`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).requestedByUserId`	string	Yes	format: "uuid"
`contact.pendingTransfer (anyOf 1).requestedByName`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).reason`	string \| null	Yes
`contact.pendingTransfer (anyOf 1).createdAt`	string	Yes	format: "date-time"
`contact.pendingTransfer (anyOf 1).canDecide`	boolean	Yes
`contact.pendingTransfer (anyOf 2)`	null	—
`contact.createdAt`	string	Yes	format: "date-time"
`contact.updatedAt`	string	Yes	format: "date-time"
`contact.entryKind`	union	Yes
`contact.entryKind (anyOf 1)`	string	—	enum: ["manual","chat","assistant","booking","import","site_form","ad_form","signup","api"]
`contact.entryKind (anyOf 2)`	null	—
`contact.notes`	array	Yes
`contact.notes[]`	object	—	additionalProperties: false
`contact.notes[].id`	string	Yes	format: "uuid"
`contact.notes[].authorUserId`	string	Yes	format: "uuid"
`contact.notes[].authorName`	string \| null	Yes
`contact.notes[].body`	string	Yes
`contact.notes[].createdAt`	string	Yes	format: "date-time"
`created`	boolean	Yes

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

GET `/contacts/{id}`

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`displayName`	string \| null	Yes
`phone`	string \| null	Yes
`email`	string \| null	Yes
`ownerUserId`	string	Yes	format: "uuid"
`ownerName`	string \| null	Yes
`stageId`	union	Yes
`stageId (anyOf 1)`	string	—	format: "uuid"
`stageId (anyOf 2)`	null	—
`stageEnteredAt`	union	Yes
`stageEnteredAt (anyOf 1)`	string	—	format: "date-time"
`stageEnteredAt (anyOf 2)`	null	—
`dealValueMinor`	union	Yes
`dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`dealValueMinor (anyOf 2)`	null	—
`dealCurrency`	union	Yes
`dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`dealCurrency (anyOf 2)`	null	—
`tags`	array	Yes
`tags[]`	string	—
`custom`	object	Yes	additionalProperties: {"type":"string"}
`lossReason`	union	Yes
`lossReason (anyOf 1)`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`lossReason (anyOf 2)`	null	—
`lossNote`	string \| null	Yes
`origin`	union	Yes
`origin (anyOf 1)`	object	—	additionalProperties: false
`origin (anyOf 1).kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown","outreach"]
`origin (anyOf 1).platform`	union	Yes
`origin (anyOf 1).platform (anyOf 1)`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`origin (anyOf 1).platform (anyOf 2)`	null	—
`origin (anyOf 1).detail`	string \| null	Yes
`origin (anyOf 2)`	null	—
`pendingTransfer`	union	Yes
`pendingTransfer (anyOf 1)`	object	—	additionalProperties: false
`pendingTransfer (anyOf 1).id`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).toUserId`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).toName`	string \| null	Yes
`pendingTransfer (anyOf 1).requestedByUserId`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).requestedByName`	string \| null	Yes
`pendingTransfer (anyOf 1).reason`	string \| null	Yes
`pendingTransfer (anyOf 1).createdAt`	string	Yes	format: "date-time"
`pendingTransfer (anyOf 1).canDecide`	boolean	Yes
`pendingTransfer (anyOf 2)`	null	—
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`entryKind`	union	Yes
`entryKind (anyOf 1)`	string	—	enum: ["manual","chat","assistant","booking","import","site_form","ad_form","signup","api"]
`entryKind (anyOf 2)`	null	—
`notes`	array	Yes
`notes[]`	object	—	additionalProperties: false
`notes[].id`	string	Yes	format: "uuid"
`notes[].authorUserId`	string	Yes	format: "uuid"
`notes[].authorName`	string \| null	Yes
`notes[].body`	string	Yes
`notes[].createdAt`	string	Yes	format: "date-time"

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

PATCH `/contacts/{id}`

CRM stage/loss/deal/tag/custom-field rules and conversion milestones remain authoritative.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`displayName`	string	—	minLength: 1 · maxLength: 120
`phone`	union	—
`phone (anyOf 1)`	string	—	maxLength: 32
`phone (anyOf 2)`	null	—
`email`	union	—
`email (anyOf 1)`	string	—	format: "email" · maxLength: 254
`email (anyOf 2)`	null	—
`stageId`	string	—	format: "uuid"
`lossReason`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`lossNote`	union	—
`lossNote (anyOf 1)`	string	—	maxLength: 500
`lossNote (anyOf 2)`	null	—
`tags`	array	—	maxItems: 20
`tags[]`	string	—	minLength: 1 · maxLength: 40
`custom`	object	—	additionalProperties: {"type":"string","maxLength":500}
`dealValueMinor`	union	—
`dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`dealValueMinor (anyOf 2)`	null	—
`dealCurrency`	union	—
`dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`dealCurrency (anyOf 2)`	null	—

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`displayName`	string \| null	Yes
`phone`	string \| null	Yes
`email`	string \| null	Yes
`ownerUserId`	string	Yes	format: "uuid"
`ownerName`	string \| null	Yes
`stageId`	union	Yes
`stageId (anyOf 1)`	string	—	format: "uuid"
`stageId (anyOf 2)`	null	—
`stageEnteredAt`	union	Yes
`stageEnteredAt (anyOf 1)`	string	—	format: "date-time"
`stageEnteredAt (anyOf 2)`	null	—
`dealValueMinor`	union	Yes
`dealValueMinor (anyOf 1)`	integer	—	minimum: 0 · maximum: 9007199254740991
`dealValueMinor (anyOf 2)`	null	—
`dealCurrency`	union	Yes
`dealCurrency (anyOf 1)`	string	—	enum: ["ILS","USD","EUR"]
`dealCurrency (anyOf 2)`	null	—
`tags`	array	Yes
`tags[]`	string	—
`custom`	object	Yes	additionalProperties: {"type":"string"}
`lossReason`	union	Yes
`lossReason (anyOf 1)`	string	—	enum: ["price","bought_elsewhere","not_serious","no_answer","other"]
`lossReason (anyOf 2)`	null	—
`lossNote`	string \| null	Yes
`origin`	union	Yes
`origin (anyOf 1)`	object	—	additionalProperties: false
`origin (anyOf 1).kind`	string	Yes	enum: ["social_post","paid_ad","fb_group","referral","website","event","returning","sign","open_house","portal","other","unknown","outreach"]
`origin (anyOf 1).platform`	union	Yes
`origin (anyOf 1).platform (anyOf 1)`	string	—	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads","whatsapp"]
`origin (anyOf 1).platform (anyOf 2)`	null	—
`origin (anyOf 1).detail`	string \| null	Yes
`origin (anyOf 2)`	null	—
`pendingTransfer`	union	Yes
`pendingTransfer (anyOf 1)`	object	—	additionalProperties: false
`pendingTransfer (anyOf 1).id`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).toUserId`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).toName`	string \| null	Yes
`pendingTransfer (anyOf 1).requestedByUserId`	string	Yes	format: "uuid"
`pendingTransfer (anyOf 1).requestedByName`	string \| null	Yes
`pendingTransfer (anyOf 1).reason`	string \| null	Yes
`pendingTransfer (anyOf 1).createdAt`	string	Yes	format: "date-time"
`pendingTransfer (anyOf 1).canDecide`	boolean	Yes
`pendingTransfer (anyOf 2)`	null	—
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`entryKind`	union	Yes
`entryKind (anyOf 1)`	string	—	enum: ["manual","chat","assistant","booking","import","site_form","ad_form","signup","api"]
`entryKind (anyOf 2)`	null	—
`notes`	array	Yes
`notes[]`	object	—	additionalProperties: false
`notes[].id`	string	Yes	format: "uuid"
`notes[].authorUserId`	string	Yes	format: "uuid"
`notes[].authorName`	string \| null	Yes
`notes[].body`	string	Yes
`notes[].createdAt`	string	Yes	format: "date-time"

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/contacts/{id}/owner`

Returns reassigned or requested under the existing CRM ownership rules.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`toUserId`	string	Yes	format: "uuid"
`reason`	string	—	maxLength: 300

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	union	—
`(value) (anyOf 1)`	object	—	additionalProperties: false
`(value) (anyOf 1).outcome`	string	Yes	const: "reassigned"
`(value) (anyOf 2)`	object	—	additionalProperties: false
`(value) (anyOf 2).outcome`	string	Yes	const: "requested"
`(value) (anyOf 2).requestId`	string	Yes	format: "uuid"

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/contacts/{id}/notes`

Same actor/workspace/contact/key and trimmed body replays one note with 201 after reauthorization. Changed body conflicts (409); deleted note stays consumed (410).

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`body`	string	Yes	minLength: 1 · maxLength: 4000

Responses

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`contactId`	string	Yes	format: "uuid"
`authorUserId`	string	Yes	format: "uuid"
`body`	string	Yes
`createdAt`	string	Yes	format: "date-time"

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

DELETE `/contacts/{id}/notes/{noteId}`

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

noteId

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 204 — Note deleted.

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

crm

GET `/crm/stages`

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].label`	value	Yes
`items[].label (allOf 1)`	string	—	minLength: 1 · maxLength: 60
`items[].label (allOf 2)`	string	—	minLength: 1
`items[].position`	integer	Yes	minimum: 0
`items[].meaning`	string	Yes	enum: ["open","qualified","meeting_held","won","lost","not_relevant"]

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

GET `/crm/members`

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes
`items[]`	object	—	additionalProperties: false
`items[].userId`	string	Yes	format: "uuid"
`items[].fullName`	string \| null	Yes
`items[].role`	string	Yes	enum: ["owner","admin","member","viewer"]

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

campaigns

GET `/campaigns`

Newest first. Seek pagination defaults to 20, max 50; cursors are collection/user/workspace-bound, preserve timestamp microseconds and are not a snapshot. Status is journey-derived, not proof of delivery.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].workspaceId`	string	Yes	format: "uuid"
`items[].name`	string	Yes	minLength: 1 · maxLength: 200
`items[].kind`	string	—	enum: ["advanced","quick"] · default: "advanced"
`items[].goal`	string	—	enum: ["leads","event","sales","traffic","other"] · default: "other"
`items[].goalDetail`	union	—	default: null
`items[].goalDetail (anyOf 1)`	string	—	maxLength: 200
`items[].goalDetail (anyOf 2)`	null	—
`items[].priorityStars`	integer	—	default: 3 · minimum: 1 · maximum: 5
`items[].creationState`	union	—	default: null
`items[].creationState (anyOf 1)`	string	—	enum: ["creating","failed"]
`items[].creationState (anyOf 2)`	null	—
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`items[].status`	string	Yes	enum: ["archived","creating","active","scheduled","paused","finished","draft"]
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/campaigns`

Requires write access. Creates a standalone draft. Reuse the exact key and normalized body after an uncertain response, including after rotating the API key. Changed content conflicts. Deleted creations remain consumed; live/archived replay never reactivates work or repeats creation effects. No automatic retry.

Parameters

Name In Required Description Schema

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`name`	string	Yes	minLength: 1 · maxLength: 200
`kind`	string	—	enum: ["advanced","quick"] · default: "advanced"
`brief`	object	—	additionalProperties: false
`brief.brief`	object	—	default: {} · additionalProperties: {"type":"string","maxLength":2000}
`brief.description`	string	—	default: "" · maxLength: 10000
`brief.sellingPoints`	array	—	default: [] · maxItems: 20
`brief.sellingPoints[]`	string	—	maxLength: 2000
`brief.currency`	union	—	default: ""
`brief.currency (anyOf 1)`	string	—	pattern: "^[A-Z]{3}$"
`brief.currency (anyOf 2)`	string	—	const: ""
`brief.audience`	object	—	default: {} · additionalProperties: false
`brief.audience.ageMin`	string	—	default: "" · maxLength: 8
`brief.audience.ageMax`	string	—	default: "" · maxLength: 8
`brief.audience.gender`	string	—	enum: ["all","female","male"] · default: "all"
`brief.audience.geography`	string	—	default: "" · maxLength: 200
`brief.audience.languages`	array	—	default: [] · maxItems: 20
`brief.audience.languages[]`	string	—	minLength: 1 · maxLength: 40
`brief.audience.background`	string	—	default: "" · maxLength: 2000
`brief.audience.interests`	array	—	default: [] · maxItems: 40
`brief.audience.interests[]`	string	—	minLength: 1 · maxLength: 60
`brief.audience.occupation`	string	—	default: "" · maxLength: 2000
`brief.audience.incomeLevel`	string	—	enum: ["unspecified","low","medium","medium_high","high","premium"] · default: "unspecified"
`brief.audience.painPoints`	string	—	default: "" · maxLength: 4000
`brief.audience.fears`	string	—	default: "" · maxLength: 4000
`brief.audience.motivations`	string	—	default: "" · maxLength: 4000
`brief.audience.keyMessages`	array	—	default: [] · maxItems: 20
`brief.audience.keyMessages[]`	string	—	maxLength: 2000
`brief.paid`	object	—	default: {} · additionalProperties: false
`brief.paid.dailyBudget`	union	—	default: null
`brief.paid.dailyBudget (anyOf 1)`	number	—	minimum: 0 · maximum: 1000000
`brief.paid.dailyBudget (anyOf 2)`	null	—
`brief.paid.budgetType`	string	—	enum: ["daily","lifetime"] · default: "daily"
`brief.paid.objective`	string	—	enum: ["leads","sales","traffic","awareness","engagement"] · default: "leads"
`brief.paid.optimizationEvent`	string	—	enum: ["form_submit","purchase","lead","click","view"] · default: "form_submit"
`brief.plan`	object	—	default: {} · additionalProperties: false
`brief.plan.contentTypes`	array	—	default: [] · maxItems: 5
`brief.plan.contentTypes[]`	string	—	enum: ["reels","stories","imagePosts","flyers","textPosts"]
`brief.plan.endDate`	string	—
`brief.plan.ideaCount`	integer	—	default: 3 · minimum: 1 · maximum: 10
`goal`	string	—	enum: ["leads","event","sales","traffic","other"]
`goalDetail`	union	—
`goalDetail (anyOf 1)`	string	—	maxLength: 200
`goalDetail (anyOf 2)`	null	—
`priorityStars`	integer	—	minimum: 1 · maximum: 5

Responses

HTTP 201 — Current campaign state, on first creation or authorized replay.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`workspaceId`	string	Yes	format: "uuid"
`name`	string	Yes	minLength: 1 · maxLength: 200
`kind`	string	—	enum: ["advanced","quick"] · default: "advanced"
`goal`	string	—	enum: ["leads","event","sales","traffic","other"] · default: "other"
`goalDetail`	union	—	default: null
`goalDetail (anyOf 1)`	string	—	maxLength: 200
`goalDetail (anyOf 2)`	null	—
`priorityStars`	integer	—	default: 3 · minimum: 1 · maximum: 5
`creationState`	union	—	default: null
`creationState (anyOf 1)`	string	—	enum: ["creating","failed"]
`creationState (anyOf 2)`	null	—
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`status`	string	Yes	enum: ["archived","creating","active","scheduled","paused","finished","draft"]
`brief`	union	—	default: null
`brief (anyOf 1)`	object	—	additionalProperties: false
`brief (anyOf 1).brief`	object	—	default: {} · additionalProperties: {"type":"string","maxLength":2000}
`brief (anyOf 1).description`	string	—	default: "" · maxLength: 10000
`brief (anyOf 1).sellingPoints`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).sellingPoints[]`	string	—	maxLength: 2000
`brief (anyOf 1).currency`	union	—	default: ""
`brief (anyOf 1).currency (anyOf 1)`	string	—	pattern: "^[A-Z]{3}$"
`brief (anyOf 1).currency (anyOf 2)`	string	—	const: ""
`brief (anyOf 1).audience`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).audience.ageMin`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.ageMax`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.gender`	string	—	enum: ["all","female","male"] · default: "all"
`brief (anyOf 1).audience.geography`	string	—	default: "" · maxLength: 200
`brief (anyOf 1).audience.languages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.languages[]`	string	—	minLength: 1 · maxLength: 40
`brief (anyOf 1).audience.background`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.interests`	array	—	default: [] · maxItems: 40
`brief (anyOf 1).audience.interests[]`	string	—	minLength: 1 · maxLength: 60
`brief (anyOf 1).audience.occupation`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.incomeLevel`	string	—	enum: ["unspecified","low","medium","medium_high","high","premium"] · default: "unspecified"
`brief (anyOf 1).audience.painPoints`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.fears`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.motivations`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.keyMessages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.keyMessages[]`	string	—	maxLength: 2000
`brief (anyOf 1).paid`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).paid.dailyBudget`	union	—	default: null
`brief (anyOf 1).paid.dailyBudget (anyOf 1)`	number	—	minimum: 0 · maximum: 1000000
`brief (anyOf 1).paid.dailyBudget (anyOf 2)`	null	—
`brief (anyOf 1).paid.budgetType`	string	—	enum: ["daily","lifetime"] · default: "daily"
`brief (anyOf 1).paid.objective`	string	—	enum: ["leads","sales","traffic","awareness","engagement"] · default: "leads"
`brief (anyOf 1).paid.optimizationEvent`	string	—	enum: ["form_submit","purchase","lead","click","view"] · default: "form_submit"
`brief (anyOf 1).plan`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).plan.contentTypes`	array	—	default: [] · maxItems: 5
`brief (anyOf 1).plan.contentTypes[]`	string	—	enum: ["reels","stories","imagePosts","flyers","textPosts"]
`brief (anyOf 1).plan.endDate`	string	—
`brief (anyOf 1).plan.ideaCount`	integer	—	default: 3 · minimum: 1 · maximum: 10
`brief (anyOf 2)`	null	—
`scheduleMode`	union	Yes
`scheduleMode (anyOf 1)`	string	—	enum: ["auto","range"]
`scheduleMode (anyOf 2)`	null	—
`startsAt`	union	Yes
`startsAt (anyOf 1)`	string	—	format: "date-time"
`startsAt (anyOf 2)`	null	—
`endsAt`	union	Yes
`endsAt (anyOf 1)`	string	—	format: "date-time"
`endsAt (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

GET `/campaigns/{id}`

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`workspaceId`	string	Yes	format: "uuid"
`name`	string	Yes	minLength: 1 · maxLength: 200
`kind`	string	—	enum: ["advanced","quick"] · default: "advanced"
`goal`	string	—	enum: ["leads","event","sales","traffic","other"] · default: "other"
`goalDetail`	union	—	default: null
`goalDetail (anyOf 1)`	string	—	maxLength: 200
`goalDetail (anyOf 2)`	null	—
`priorityStars`	integer	—	default: 3 · minimum: 1 · maximum: 5
`creationState`	union	—	default: null
`creationState (anyOf 1)`	string	—	enum: ["creating","failed"]
`creationState (anyOf 2)`	null	—
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`status`	string	Yes	enum: ["archived","creating","active","scheduled","paused","finished","draft"]
`brief`	union	—	default: null
`brief (anyOf 1)`	object	—	additionalProperties: false
`brief (anyOf 1).brief`	object	—	default: {} · additionalProperties: {"type":"string","maxLength":2000}
`brief (anyOf 1).description`	string	—	default: "" · maxLength: 10000
`brief (anyOf 1).sellingPoints`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).sellingPoints[]`	string	—	maxLength: 2000
`brief (anyOf 1).currency`	union	—	default: ""
`brief (anyOf 1).currency (anyOf 1)`	string	—	pattern: "^[A-Z]{3}$"
`brief (anyOf 1).currency (anyOf 2)`	string	—	const: ""
`brief (anyOf 1).audience`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).audience.ageMin`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.ageMax`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.gender`	string	—	enum: ["all","female","male"] · default: "all"
`brief (anyOf 1).audience.geography`	string	—	default: "" · maxLength: 200
`brief (anyOf 1).audience.languages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.languages[]`	string	—	minLength: 1 · maxLength: 40
`brief (anyOf 1).audience.background`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.interests`	array	—	default: [] · maxItems: 40
`brief (anyOf 1).audience.interests[]`	string	—	minLength: 1 · maxLength: 60
`brief (anyOf 1).audience.occupation`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.incomeLevel`	string	—	enum: ["unspecified","low","medium","medium_high","high","premium"] · default: "unspecified"
`brief (anyOf 1).audience.painPoints`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.fears`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.motivations`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.keyMessages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.keyMessages[]`	string	—	maxLength: 2000
`brief (anyOf 1).paid`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).paid.dailyBudget`	union	—	default: null
`brief (anyOf 1).paid.dailyBudget (anyOf 1)`	number	—	minimum: 0 · maximum: 1000000
`brief (anyOf 1).paid.dailyBudget (anyOf 2)`	null	—
`brief (anyOf 1).paid.budgetType`	string	—	enum: ["daily","lifetime"] · default: "daily"
`brief (anyOf 1).paid.objective`	string	—	enum: ["leads","sales","traffic","awareness","engagement"] · default: "leads"
`brief (anyOf 1).paid.optimizationEvent`	string	—	enum: ["form_submit","purchase","lead","click","view"] · default: "form_submit"
`brief (anyOf 1).plan`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).plan.contentTypes`	array	—	default: [] · maxItems: 5
`brief (anyOf 1).plan.contentTypes[]`	string	—	enum: ["reels","stories","imagePosts","flyers","textPosts"]
`brief (anyOf 1).plan.endDate`	string	—
`brief (anyOf 1).plan.ideaCount`	integer	—	default: 3 · minimum: 1 · maximum: 10
`brief (anyOf 2)`	null	—
`scheduleMode`	union	Yes
`scheduleMode (anyOf 1)`	string	—	enum: ["auto","range"]
`scheduleMode (anyOf 2)`	null	—
`startsAt`	union	Yes
`startsAt (anyOf 1)`	string	—	format: "date-time"
`startsAt (anyOf 2)`	null	—
`endsAt`	union	Yes
`endsAt (anyOf 1)`	string	—	format: "date-time"
`endsAt (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

PATCH `/campaigns/{id}`

Rename or change urgency. Write access is restricted to an unarmed draft campaign; otherwise publish access and the current publishing role are required. No status, goal or lead-owner override. A matching retry returns current state without overwriting a later edit.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`name`	string	—	minLength: 1 · maxLength: 200
`urgency`	integer	—	minimum: 1 · maximum: 5

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`workspaceId`	string	Yes	format: "uuid"
`name`	string	Yes	minLength: 1 · maxLength: 200
`kind`	string	—	enum: ["advanced","quick"] · default: "advanced"
`goal`	string	—	enum: ["leads","event","sales","traffic","other"] · default: "other"
`goalDetail`	union	—	default: null
`goalDetail (anyOf 1)`	string	—	maxLength: 200
`goalDetail (anyOf 2)`	null	—
`priorityStars`	integer	—	default: 3 · minimum: 1 · maximum: 5
`creationState`	union	—	default: null
`creationState (anyOf 1)`	string	—	enum: ["creating","failed"]
`creationState (anyOf 2)`	null	—
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`status`	string	Yes	enum: ["archived","creating","active","scheduled","paused","finished","draft"]
`brief`	union	—	default: null
`brief (anyOf 1)`	object	—	additionalProperties: false
`brief (anyOf 1).brief`	object	—	default: {} · additionalProperties: {"type":"string","maxLength":2000}
`brief (anyOf 1).description`	string	—	default: "" · maxLength: 10000
`brief (anyOf 1).sellingPoints`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).sellingPoints[]`	string	—	maxLength: 2000
`brief (anyOf 1).currency`	union	—	default: ""
`brief (anyOf 1).currency (anyOf 1)`	string	—	pattern: "^[A-Z]{3}$"
`brief (anyOf 1).currency (anyOf 2)`	string	—	const: ""
`brief (anyOf 1).audience`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).audience.ageMin`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.ageMax`	string	—	default: "" · maxLength: 8
`brief (anyOf 1).audience.gender`	string	—	enum: ["all","female","male"] · default: "all"
`brief (anyOf 1).audience.geography`	string	—	default: "" · maxLength: 200
`brief (anyOf 1).audience.languages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.languages[]`	string	—	minLength: 1 · maxLength: 40
`brief (anyOf 1).audience.background`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.interests`	array	—	default: [] · maxItems: 40
`brief (anyOf 1).audience.interests[]`	string	—	minLength: 1 · maxLength: 60
`brief (anyOf 1).audience.occupation`	string	—	default: "" · maxLength: 2000
`brief (anyOf 1).audience.incomeLevel`	string	—	enum: ["unspecified","low","medium","medium_high","high","premium"] · default: "unspecified"
`brief (anyOf 1).audience.painPoints`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.fears`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.motivations`	string	—	default: "" · maxLength: 4000
`brief (anyOf 1).audience.keyMessages`	array	—	default: [] · maxItems: 20
`brief (anyOf 1).audience.keyMessages[]`	string	—	maxLength: 2000
`brief (anyOf 1).paid`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).paid.dailyBudget`	union	—	default: null
`brief (anyOf 1).paid.dailyBudget (anyOf 1)`	number	—	minimum: 0 · maximum: 1000000
`brief (anyOf 1).paid.dailyBudget (anyOf 2)`	null	—
`brief (anyOf 1).paid.budgetType`	string	—	enum: ["daily","lifetime"] · default: "daily"
`brief (anyOf 1).paid.objective`	string	—	enum: ["leads","sales","traffic","awareness","engagement"] · default: "leads"
`brief (anyOf 1).paid.optimizationEvent`	string	—	enum: ["form_submit","purchase","lead","click","view"] · default: "form_submit"
`brief (anyOf 1).plan`	object	—	default: {} · additionalProperties: false
`brief (anyOf 1).plan.contentTypes`	array	—	default: [] · maxItems: 5
`brief (anyOf 1).plan.contentTypes[]`	string	—	enum: ["reels","stories","imagePosts","flyers","textPosts"]
`brief (anyOf 1).plan.endDate`	string	—
`brief (anyOf 1).plan.ideaCount`	integer	—	default: 3 · minimum: 1 · maximum: 10
`brief (anyOf 2)`	null	—
`scheduleMode`	union	Yes
`scheduleMode (anyOf 1)`	string	—	enum: ["auto","range"]
`scheduleMode (anyOf 2)`	null	—
`startsAt`	union	Yes
`startsAt (anyOf 1)`	string	—	format: "date-time"
`startsAt (anyOf 2)`	null	—
`endsAt`	union	Yes
`endsAt (anyOf 1)`	string	—	format: "date-time"
`endsAt (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

GET `/campaigns/{id}/posts`

Current journey posts and derived card standings; no recipient lists or provider envelopes.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].campaignId`	string	Yes	format: "uuid"
`items[].name`	union	Yes
`items[].name (anyOf 1)`	string	—	maxLength: 120
`items[].name (anyOf 2)`	null	—
`items[].body`	string	Yes	minLength: 1 · maxLength: 10000
`items[].stars`	integer	Yes	minimum: 1 · maximum: 5
`items[].revision`	integer	Yes	minimum: 1
`items[].updatedAt`	string	Yes	format: "date-time"
`items[].media`	array	Yes	maxItems: 25
`items[].media[]`	object	—	additionalProperties: false
`items[].media[].id`	string	Yes	format: "uuid"
`items[].media[].kind`	string	Yes	enum: ["post_media","studio_creative","minisite_file","agent_upload","agent_media","user_avatar","business_logo"]
`items[].media[].mime`	string	Yes	minLength: 1 · maxLength: 100
`items[].media[].sizeBytes`	integer	Yes	minimum: 0
`items[].media[].createdAt`	string	Yes	format: "date-time"
`items[].media[].updatedAt`	string	Yes	format: "date-time"
`items[].media[].url`	union	Yes
`items[].media[].url (anyOf 1)`	string	—	format: "uri"
`items[].media[].url (anyOf 2)`	null	—
`items[].cards`	array	Yes	maxItems: 20
`items[].cards[]`	object	—	additionalProperties: false
`items[].cards[].id`	string	Yes	format: "uuid"
`items[].cards[].channel`	string	Yes	enum: ["feed","facebook_groups","facebook_marketplace","whatsapp","email"]
`items[].cards[].status`	string	Yes	enum: ["draft","scheduled","active","paused","finished"]
`items[].cards[].attention`	union	Yes
`items[].cards[].attention (anyOf 1)`	string	—	enum: ["kill_switch","account_paused","duplicate_post_quarantine","extension_offline","unknown_session","cloud_offline","cloud_phone_not_ready","cloud_account_in_flight","connected_account_inactive","unroutable_destination","lease_held","account_rail_unreadable","mechanism_not_allowed","media_needs_extension","posting_permission_revoked","posting_principal_unknown","content_rewrite_pending","cloud_identity_choice_required","extension_cannot_post_as_identity","cloud_phone_warming_up","publishing_paused","facebook_refusing_posts","platform_content_rules","no_media_for_platform","publish_failed","grant_stale","whatsapp_needs_review","whatsapp_number_paused","whatsapp_permission_revoked","whatsapp_workspace_stopped","rewrite_failed","recipients_grew","missed_slots","needs_republish","cloud_no_video","send_failed","sender_unavailable","stopped","not_published","story_incomplete"]
`items[].cards[].attention (anyOf 2)`	null	—
`items[].cards[].held`	boolean	Yes
`items[].cards[].pausedAt`	union	Yes
`items[].cards[].pausedAt (anyOf 1)`	string	—	format: "date-time"
`items[].cards[].pausedAt (anyOf 2)`	null	—
`items[].cards[].missedSlots`	integer	Yes	minimum: 0
`items[].cards[].nextRunAt`	union	Yes
`items[].cards[].nextRunAt (anyOf 1)`	string	—	format: "date-time"
`items[].cards[].nextRunAt (anyOf 2)`	null	—
`items[].grant`	object	Yes	additionalProperties: false
`items[].grant.state`	string	Yes	enum: ["none","current","stale"]
`items[].grant.approvedAt`	union	Yes
`items[].grant.approvedAt (anyOf 1)`	string	—	format: "date-time"
`items[].grant.approvedAt (anyOf 2)`	null	—
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/campaigns/{id}/cards/actions`

Publish access/current publishing role required for pause and resume. Applies once to the selected cards, including message channels. Resume does not catch up missed recurring slots, but can start a never-run matching-grant card. Existing email sender/recipient reconfirmation rules apply. An original-key retry returns current surviving captured cards: it cannot undo a later pause/resume or affect newly added cards. Does not control independent paid-ad budgets or recall in-flight sends.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`scope`	union	Yes
`scope (anyOf 1)`	object	—	additionalProperties: false
`scope (anyOf 1).cardIds`	array	Yes	minItems: 1 · maxItems: 200
`scope (anyOf 1).cardIds[]`	string	—	format: "uuid"
`scope (anyOf 2)`	object	—	additionalProperties: false
`scope (anyOf 2).all`	boolean	Yes	const: true
`action`	string	Yes	enum: ["pause","resume"]
`confirmRecipientCount`	integer	—	minimum: 1 · maximum: 1000000

Responses

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`affected`	integer	Yes	minimum: 0
`cards`	array	Yes
`cards[]`	object	—	additionalProperties: false
`cards[].id`	string	Yes	format: "uuid"
`cards[].status`	string	Yes	enum: ["draft","scheduled","active","paused","finished"]
`cards[].attention`	union	Yes
`cards[].attention (anyOf 1)`	string	—	enum: ["kill_switch","account_paused","duplicate_post_quarantine","extension_offline","unknown_session","cloud_offline","cloud_phone_not_ready","cloud_account_in_flight","connected_account_inactive","unroutable_destination","lease_held","account_rail_unreadable","mechanism_not_allowed","media_needs_extension","posting_permission_revoked","posting_principal_unknown","content_rewrite_pending","cloud_identity_choice_required","extension_cannot_post_as_identity","cloud_phone_warming_up","publishing_paused","facebook_refusing_posts","platform_content_rules","no_media_for_platform","publish_failed","grant_stale","whatsapp_needs_review","whatsapp_number_paused","whatsapp_permission_revoked","whatsapp_workspace_stopped","rewrite_failed","recipients_grew","missed_slots","needs_republish","cloud_no_video","send_failed","sender_unavailable","stopped","not_published","story_incomplete"]
`cards[].attention (anyOf 2)`	null	—
`cards[].pausedAt`	union	Yes
`cards[].pausedAt (anyOf 1)`	string	—	format: "date-time"
`cards[].pausedAt (anyOf 2)`	null	—
`cards[].missedSlots`	integer	Yes	minimum: 0
`cards[].nextRunAt`	union	Yes
`cards[].nextRunAt (anyOf 1)`	string	—	format: "date-time"
`cards[].nextRunAt (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/campaigns/{id}/archive`

Publish access/current publishing role required. Terminally archives and stops future/queued work, including WhatsApp and email; already in-flight requests may complete and published content remains. Separate paid-ad budgets are unaffected. A matching retry can finish remaining queued-job cancellation while still archived, but cannot re-archive a legacy/manual reactivation.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false

Responses

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`status`	string	Yes	const: "archived"

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

posts

POST `/posts`

Save a post in an existing campaign on any existing journey channel: feeds, Facebook groups, WhatsApp, email or Marketplace. Drafts need write access; intent publish needs publish access/current role. Publication is the audited grant over this supplied reviewed payload and schedule, not proof of external delivery. Recipient consent/caps, sender/account rights and media custody still apply. Non-null WhatsApp caps cannot be widened. Marketplace retains the app's guarded property-record side effect. Retry only with the original key and body.

Parameters

Name In Required Description Schema

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`post`	object	Yes	additionalProperties: false
`post.name`	union	—
`post.name (anyOf 1)`	string	—	minLength: 1 · maxLength: 120
`post.name (anyOf 2)`	null	—
`post.body`	string	Yes	minLength: 1 · maxLength: 10000
`post.mediaIds`	array	Yes	maxItems: 25
`post.mediaIds[]`	string	—	format: "uuid"
`post.stars`	integer	Yes	minimum: 1 · maximum: 5
`cards`	array	Yes	minItems: 1 · maxItems: 20
`cards[]`	union	—
`cards[] (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).id`	string	—	format: "uuid"
`cards[] (anyOf 1).channel`	string	Yes	const: "feed"
`cards[] (anyOf 1).destinationId`	string	Yes	format: "uuid"
`cards[] (anyOf 1).format`	string	—	enum: ["feed","story","reel","video","article","listing","ad"] · default: "feed"
`cards[] (anyOf 1).config`	object	—	default: {} · additionalProperties: false
`cards[] (anyOf 1).config.targetId`	union	—	default: null
`cards[] (anyOf 1).config.targetId (anyOf 1)`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.targetId (anyOf 2)`	null	—
`cards[] (anyOf 1).config.platformFields`	union	—	default: null
`cards[] (anyOf 1).config.platformFields (anyOf 1)`	union	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).platform`	string	Yes	const: "reddit"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).subreddit`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).title`	string	—	minLength: 1 · maxLength: 300
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).flairId`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).flairText`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).nsfw`	boolean	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).spoiler`	boolean	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).platform`	string	Yes	const: "pinterest"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).boardId`	string	Yes	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).title`	string	—	minLength: 1 · maxLength: 100
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).link`	string	—	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).platform`	string	Yes	const: "googlebusiness"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).locationId`	string	Yes	pattern: "^locations\\/\\d{1,30}$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).topicType`	string	Yes	enum: ["STANDARD","EVENT","OFFER"]
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction.type`	string	Yes	enum: ["LEARN_MORE","BOOK","ORDER","SHOP","SIGN_UP","CALL"]
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction.url`	string	Yes	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.title`	string	Yes	minLength: 1 · maxLength: 58
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.startDate`	string	Yes	pattern: "^\\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\\d\|3[01])$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.endDate`	string	Yes	pattern: "^\\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\\d\|3[01])$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.startTime`	string	—	pattern: "^([01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.endTime`	string	—	pattern: "^([01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.couponCode`	string	—	minLength: 1 · maxLength: 58
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.redeemOnlineUrl`	string	—	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.termsConditions`	string	—	minLength: 1 · maxLength: 5000
`cards[] (anyOf 1).config.platformFields (anyOf 2)`	null	—
`cards[] (anyOf 1).schedule`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 1).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 1).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 1).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 1).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 1).schedule (anyOf 2).until (anyOf 2)`	null	—
`cards[] (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 2).id`	string	—	format: "uuid"
`cards[] (anyOf 2).channel`	string	Yes	const: "facebook_groups"
`cards[] (anyOf 2).socialAccountId`	string	Yes	format: "uuid"
`cards[] (anyOf 2).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 2).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 2).config.folderIds`	array	Yes	maxItems: 2000
`cards[] (anyOf 2).config.folderIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.groupIds`	array	Yes	maxItems: 2000
`cards[] (anyOf 2).config.groupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.excludedGroupIds`	array	—	maxItems: 2000
`cards[] (anyOf 2).config.excludedGroupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.liveFolderConsent`	boolean	—	default: false
`cards[] (anyOf 2).schedule`	object	Yes	additionalProperties: false
`cards[] (anyOf 2).schedule.kind`	string	Yes	const: "fbgroups"
`cards[] (anyOf 2).schedule.start`	union	Yes
`cards[] (anyOf 2).schedule.start (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 2).schedule.start (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 2).schedule.end`	union	Yes
`cards[] (anyOf 2).schedule.end (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 2).schedule.end (anyOf 2)`	null	—
`cards[] (anyOf 3)`	object	—	additionalProperties: false
`cards[] (anyOf 3).id`	string	—	format: "uuid"
`cards[] (anyOf 3).channel`	string	Yes	const: "facebook_marketplace"
`cards[] (anyOf 3).destinationId`	string	Yes	format: "uuid"
`cards[] (anyOf 3).format`	string	—	const: "listing" · default: "listing"
`cards[] (anyOf 3).config`	union	Yes
`cards[] (anyOf 3).config (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 3).config (anyOf 1).kind`	string	Yes	const: "item"
`cards[] (anyOf 3).config (anyOf 1).title`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 3).config (anyOf 1).price`	integer	Yes	minimum: 0 · maximum: 1000000000
`cards[] (anyOf 3).config (anyOf 1).location`	string	Yes	minLength: 2 · maxLength: 120
`cards[] (anyOf 3).config (anyOf 1).category`	string	Yes	enum: ["tools","furniture","household","garden","appliances","video_games","books_movies_music","bags_luggage","womens_clothing_shoes","mens_clothing_shoes","jewelry_accessories","health_beauty","pet_supplies","baby_kids","toys_games","electronics_computers","mobile_phones","bicycles","arts_crafts","sports_outdoors","auto_parts","musical_instruments","antiques_collectibles","garage_sale","miscellaneous"]
`cards[] (anyOf 3).config (anyOf 1).condition`	string	Yes	enum: ["new","used_like_new","used_good","used_fair"]
`cards[] (anyOf 3).config (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 3).config (anyOf 2).kind`	string	Yes	const: "property"
`cards[] (anyOf 3).config (anyOf 2).title`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 3).config (anyOf 2).price`	integer	Yes	minimum: 0 · maximum: 1000000000
`cards[] (anyOf 3).config (anyOf 2).location`	string	Yes	minLength: 2 · maxLength: 120
`cards[] (anyOf 3).config (anyOf 2).offer`	string	Yes	enum: ["sale","rent"]
`cards[] (anyOf 3).config (anyOf 2).propertyType`	string	Yes	enum: ["apartment","house","room","townhouse","other"]
`cards[] (anyOf 3).config (anyOf 2).sizeSqm`	integer	—	minimum: 1 · maximum: 100000
`cards[] (anyOf 3).config (anyOf 2).rooms`	number	Yes	minimum: 0 · maximum: 50
`cards[] (anyOf 3).config (anyOf 2).bathrooms`	integer	Yes	minimum: 0 · maximum: 20
`cards[] (anyOf 3).schedule`	object	Yes	additionalProperties: false
`cards[] (anyOf 3).schedule.kind`	string	Yes	const: "once"
`cards[] (anyOf 3).schedule.at`	union	Yes
`cards[] (anyOf 3).schedule.at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 3).schedule.at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 4)`	object	—	additionalProperties: false
`cards[] (anyOf 4).id`	string	—	format: "uuid"
`cards[] (anyOf 4).channel`	string	Yes	const: "whatsapp"
`cards[] (anyOf 4).whatsappAccountId`	string	Yes	format: "uuid"
`cards[] (anyOf 4).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 4).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 4).config.recipients`	object	Yes	additionalProperties: false
`cards[] (anyOf 4).config.recipients.mode`	string	Yes	enum: ["all_consented","selected"]
`cards[] (anyOf 4).config.recipients.leadIds`	array	Yes	maxItems: 5000
`cards[] (anyOf 4).config.recipients.leadIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.groupIds`	array	Yes	maxItems: 200
`cards[] (anyOf 4).config.recipients.groupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.labelIds`	array	—	default: [] · maxItems: 20
`cards[] (anyOf 4).config.recipients.labelIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.memberGroupIds`	array	—	default: [] · maxItems: 20
`cards[] (anyOf 4).config.recipients.memberGroupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.audienceIds`	array	—	default: [] · maxItems: 50
`cards[] (anyOf 4).config.recipients.audienceIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.consentConfirmed`	boolean	—	default: false
`cards[] (anyOf 4).config.recipientCap`	union	—	default: null
`cards[] (anyOf 4).config.recipientCap (anyOf 1)`	integer	—	minimum: 0 · maximum: 100000
`cards[] (anyOf 4).config.recipientCap (anyOf 2)`	null	—
`cards[] (anyOf 4).schedule`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 4).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 4).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 4).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 4).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 4).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 4).schedule (anyOf 2).until (anyOf 2)`	null	—
`cards[] (anyOf 5)`	object	—	additionalProperties: false
`cards[] (anyOf 5).id`	string	—	format: "uuid"
`cards[] (anyOf 5).channel`	string	Yes	const: "email"
`cards[] (anyOf 5).gmailSenderId`	string	Yes	format: "uuid"
`cards[] (anyOf 5).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 5).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 5).config.senderIds`	array	Yes	minItems: 1 · maxItems: 10
`cards[] (anyOf 5).config.senderIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.divide`	boolean	—	default: false
`cards[] (anyOf 5).config.subject`	string	Yes	minLength: 1 · maxLength: 200
`cards[] (anyOf 5).config.bodyHtml`	union	—	default: null
`cards[] (anyOf 5).config.bodyHtml (anyOf 1)`	string	—	maxLength: 100000
`cards[] (anyOf 5).config.bodyHtml (anyOf 2)`	null	—
`cards[] (anyOf 5).config.templateKind`	string	—	enum: ["announcement","listing","newsletter","personal"] · default: "announcement"
`cards[] (anyOf 5).config.trackLinks`	boolean	—	default: true
`cards[] (anyOf 5).config.trackOpens`	boolean	—	default: false
`cards[] (anyOf 5).config.recipients`	object	Yes	additionalProperties: false
`cards[] (anyOf 5).config.recipients.mode`	string	Yes	enum: ["all_consented","selected"]
`cards[] (anyOf 5).config.recipients.leadIds`	array	Yes	maxItems: 5000
`cards[] (anyOf 5).config.recipients.leadIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.recipients.audienceIds`	array	Yes	maxItems: 50
`cards[] (anyOf 5).config.recipients.audienceIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.consentConfirmed`	boolean	—	default: false
`cards[] (anyOf 5).config.recipientCap`	union	—	default: null
`cards[] (anyOf 5).config.recipientCap (anyOf 1)`	integer	—	minimum: 0 · maximum: 1000000
`cards[] (anyOf 5).config.recipientCap (anyOf 2)`	null	—
`cards[] (anyOf 5).schedule`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 5).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 5).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 5).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 5).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 5).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 5).schedule (anyOf 2).until (anyOf 2)`	null	—
`intent`	string	Yes	enum: ["draft","publish"]
`campaignId`	string	Yes	format: "uuid"

Responses

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`campaignId`	string	Yes	format: "uuid"
`postId`	string	Yes	format: "uuid"
`revision`	integer	Yes	minimum: 1
`cards`	array	Yes	maxItems: 20
`cards[]`	object	—	additionalProperties: false
`cards[].id`	string	Yes	format: "uuid"
`cards[].channel`	string	Yes	enum: ["feed","facebook_groups","facebook_marketplace","whatsapp","email"]
`cards[].status`	string	Yes	enum: ["draft","scheduled","active","paused","finished"]
`cards[].setAside`	string	—	enum: ["marketplace_unavailable","marketplace_disabled","marketplace_listing_exists","marketplace_replaced","connected_account_inactive","text_too_long","media_not_supported","destination_unavailable","media_unavailable","content_unavailable","whatsapp_send_refused","email_send_refused"]
`replayed`	boolean	Yes

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

GET `/posts/{id}`

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`campaignId`	string	Yes	format: "uuid"
`name`	union	Yes
`name (anyOf 1)`	string	—	maxLength: 120
`name (anyOf 2)`	null	—
`body`	string	Yes	minLength: 1 · maxLength: 10000
`stars`	integer	Yes	minimum: 1 · maximum: 5
`revision`	integer	Yes	minimum: 1
`updatedAt`	string	Yes	format: "date-time"
`media`	array	Yes	maxItems: 25
`media[]`	object	—	additionalProperties: false
`media[].id`	string	Yes	format: "uuid"
`media[].kind`	string	Yes	enum: ["post_media","studio_creative","minisite_file","agent_upload","agent_media","user_avatar","business_logo"]
`media[].mime`	string	Yes	minLength: 1 · maxLength: 100
`media[].sizeBytes`	integer	Yes	minimum: 0
`media[].createdAt`	string	Yes	format: "date-time"
`media[].updatedAt`	string	Yes	format: "date-time"
`media[].url`	union	Yes
`media[].url (anyOf 1)`	string	—	format: "uri"
`media[].url (anyOf 2)`	null	—
`cards`	array	Yes	maxItems: 20
`cards[]`	object	—	additionalProperties: false
`cards[].id`	string	Yes	format: "uuid"
`cards[].channel`	string	Yes	enum: ["feed","facebook_groups","facebook_marketplace","whatsapp","email"]
`cards[].status`	string	Yes	enum: ["draft","scheduled","active","paused","finished"]
`cards[].attention`	union	Yes
`cards[].attention (anyOf 1)`	string	—	enum: ["kill_switch","account_paused","duplicate_post_quarantine","extension_offline","unknown_session","cloud_offline","cloud_phone_not_ready","cloud_account_in_flight","connected_account_inactive","unroutable_destination","lease_held","account_rail_unreadable","mechanism_not_allowed","media_needs_extension","posting_permission_revoked","posting_principal_unknown","content_rewrite_pending","cloud_identity_choice_required","extension_cannot_post_as_identity","cloud_phone_warming_up","publishing_paused","facebook_refusing_posts","platform_content_rules","no_media_for_platform","publish_failed","grant_stale","whatsapp_needs_review","whatsapp_number_paused","whatsapp_permission_revoked","whatsapp_workspace_stopped","rewrite_failed","recipients_grew","missed_slots","needs_republish","cloud_no_video","send_failed","sender_unavailable","stopped","not_published","story_incomplete"]
`cards[].attention (anyOf 2)`	null	—
`cards[].held`	boolean	Yes
`cards[].pausedAt`	union	Yes
`cards[].pausedAt (anyOf 1)`	string	—	format: "date-time"
`cards[].pausedAt (anyOf 2)`	null	—
`cards[].missedSlots`	integer	Yes	minimum: 0
`cards[].nextRunAt`	union	Yes
`cards[].nextRunAt (anyOf 1)`	string	—	format: "date-time"
`cards[].nextRunAt (anyOf 2)`	null	—
`grant`	object	Yes	additionalProperties: false
`grant.state`	string	Yes	enum: ["none","current","stale"]
`grant.approvedAt`	union	Yes
`grant.approvedAt (anyOf 1)`	string	—	format: "date-time"
`grant.approvedAt (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

PUT `/posts/{id}`

Full desired card set and exact reviewed expectedRevision. Existing card IDs are retained, omitted cards removed. Use intent publish to publish/schedule a reviewed draft; keep your reviewed configurations because GET never exposes recipient/configuration data. Never reconstruct a newer version. Stale new edits conflict. Draft-only keys cannot alter approved or previously started posts even with intent draft. Verified retries return current surviving-card metadata (possibly empty), not a historical snapshot, and never reapply publication.

Parameters

Name In Required Description Schema

id

path

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Idempotency-Key

header

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 255 · pattern: "^[\\x21-\\x7e]+$"

Request body (required)

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`expectedRevision`	integer	Yes	minimum: 1
`post`	object	Yes	additionalProperties: false
`post.name`	union	—
`post.name (anyOf 1)`	string	—	minLength: 1 · maxLength: 120
`post.name (anyOf 2)`	null	—
`post.body`	string	Yes	minLength: 1 · maxLength: 10000
`post.mediaIds`	array	Yes	maxItems: 25
`post.mediaIds[]`	string	—	format: "uuid"
`post.stars`	integer	Yes	minimum: 1 · maximum: 5
`cards`	array	Yes	minItems: 1 · maxItems: 20
`cards[]`	union	—
`cards[] (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).id`	string	—	format: "uuid"
`cards[] (anyOf 1).channel`	string	Yes	const: "feed"
`cards[] (anyOf 1).destinationId`	string	Yes	format: "uuid"
`cards[] (anyOf 1).format`	string	—	enum: ["feed","story","reel","video","article","listing","ad"] · default: "feed"
`cards[] (anyOf 1).config`	object	—	default: {} · additionalProperties: false
`cards[] (anyOf 1).config.targetId`	union	—	default: null
`cards[] (anyOf 1).config.targetId (anyOf 1)`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.targetId (anyOf 2)`	null	—
`cards[] (anyOf 1).config.platformFields`	union	—	default: null
`cards[] (anyOf 1).config.platformFields (anyOf 1)`	union	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).platform`	string	Yes	const: "reddit"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).subreddit`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).title`	string	—	minLength: 1 · maxLength: 300
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).flairId`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).flairText`	string	—	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).nsfw`	boolean	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 1).spoiler`	boolean	—
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).platform`	string	Yes	const: "pinterest"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).boardId`	string	Yes	minLength: 1 · maxLength: 200
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).title`	string	—	minLength: 1 · maxLength: 100
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 2).link`	string	—	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3)`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).platform`	string	Yes	const: "googlebusiness"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).locationId`	string	Yes	pattern: "^locations\\/\\d{1,30}$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).topicType`	string	Yes	enum: ["STANDARD","EVENT","OFFER"]
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction.type`	string	Yes	enum: ["LEARN_MORE","BOOK","ORDER","SHOP","SIGN_UP","CALL"]
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).callToAction.url`	string	Yes	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.title`	string	Yes	minLength: 1 · maxLength: 58
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.startDate`	string	Yes	pattern: "^\\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\\d\|3[01])$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.endDate`	string	Yes	pattern: "^\\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\\d\|3[01])$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.startTime`	string	—	pattern: "^([01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).event.endTime`	string	—	pattern: "^([01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer`	object	—	additionalProperties: false
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.couponCode`	string	—	minLength: 1 · maxLength: 58
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.redeemOnlineUrl`	string	—	format: "uri" · maxLength: 2000
`cards[] (anyOf 1).config.platformFields (anyOf 1) (anyOf 3).offer.termsConditions`	string	—	minLength: 1 · maxLength: 5000
`cards[] (anyOf 1).config.platformFields (anyOf 2)`	null	—
`cards[] (anyOf 1).schedule`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 1).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 1).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 1).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 1).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 1).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 1).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 1).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 1).schedule (anyOf 2).until (anyOf 2)`	null	—
`cards[] (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 2).id`	string	—	format: "uuid"
`cards[] (anyOf 2).channel`	string	Yes	const: "facebook_groups"
`cards[] (anyOf 2).socialAccountId`	string	Yes	format: "uuid"
`cards[] (anyOf 2).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 2).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 2).config.folderIds`	array	Yes	maxItems: 2000
`cards[] (anyOf 2).config.folderIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.groupIds`	array	Yes	maxItems: 2000
`cards[] (anyOf 2).config.groupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.excludedGroupIds`	array	—	maxItems: 2000
`cards[] (anyOf 2).config.excludedGroupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 2).config.liveFolderConsent`	boolean	—	default: false
`cards[] (anyOf 2).schedule`	object	Yes	additionalProperties: false
`cards[] (anyOf 2).schedule.kind`	string	Yes	const: "fbgroups"
`cards[] (anyOf 2).schedule.start`	union	Yes
`cards[] (anyOf 2).schedule.start (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 2).schedule.start (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 2).schedule.end`	union	Yes
`cards[] (anyOf 2).schedule.end (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 2).schedule.end (anyOf 2)`	null	—
`cards[] (anyOf 3)`	object	—	additionalProperties: false
`cards[] (anyOf 3).id`	string	—	format: "uuid"
`cards[] (anyOf 3).channel`	string	Yes	const: "facebook_marketplace"
`cards[] (anyOf 3).destinationId`	string	Yes	format: "uuid"
`cards[] (anyOf 3).format`	string	—	const: "listing" · default: "listing"
`cards[] (anyOf 3).config`	union	Yes
`cards[] (anyOf 3).config (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 3).config (anyOf 1).kind`	string	Yes	const: "item"
`cards[] (anyOf 3).config (anyOf 1).title`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 3).config (anyOf 1).price`	integer	Yes	minimum: 0 · maximum: 1000000000
`cards[] (anyOf 3).config (anyOf 1).location`	string	Yes	minLength: 2 · maxLength: 120
`cards[] (anyOf 3).config (anyOf 1).category`	string	Yes	enum: ["tools","furniture","household","garden","appliances","video_games","books_movies_music","bags_luggage","womens_clothing_shoes","mens_clothing_shoes","jewelry_accessories","health_beauty","pet_supplies","baby_kids","toys_games","electronics_computers","mobile_phones","bicycles","arts_crafts","sports_outdoors","auto_parts","musical_instruments","antiques_collectibles","garage_sale","miscellaneous"]
`cards[] (anyOf 3).config (anyOf 1).condition`	string	Yes	enum: ["new","used_like_new","used_good","used_fair"]
`cards[] (anyOf 3).config (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 3).config (anyOf 2).kind`	string	Yes	const: "property"
`cards[] (anyOf 3).config (anyOf 2).title`	string	Yes	minLength: 1 · maxLength: 100
`cards[] (anyOf 3).config (anyOf 2).price`	integer	Yes	minimum: 0 · maximum: 1000000000
`cards[] (anyOf 3).config (anyOf 2).location`	string	Yes	minLength: 2 · maxLength: 120
`cards[] (anyOf 3).config (anyOf 2).offer`	string	Yes	enum: ["sale","rent"]
`cards[] (anyOf 3).config (anyOf 2).propertyType`	string	Yes	enum: ["apartment","house","room","townhouse","other"]
`cards[] (anyOf 3).config (anyOf 2).sizeSqm`	integer	—	minimum: 1 · maximum: 100000
`cards[] (anyOf 3).config (anyOf 2).rooms`	number	Yes	minimum: 0 · maximum: 50
`cards[] (anyOf 3).config (anyOf 2).bathrooms`	integer	Yes	minimum: 0 · maximum: 20
`cards[] (anyOf 3).schedule`	object	Yes	additionalProperties: false
`cards[] (anyOf 3).schedule.kind`	string	Yes	const: "once"
`cards[] (anyOf 3).schedule.at`	union	Yes
`cards[] (anyOf 3).schedule.at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 3).schedule.at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 4)`	object	—	additionalProperties: false
`cards[] (anyOf 4).id`	string	—	format: "uuid"
`cards[] (anyOf 4).channel`	string	Yes	const: "whatsapp"
`cards[] (anyOf 4).whatsappAccountId`	string	Yes	format: "uuid"
`cards[] (anyOf 4).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 4).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 4).config.recipients`	object	Yes	additionalProperties: false
`cards[] (anyOf 4).config.recipients.mode`	string	Yes	enum: ["all_consented","selected"]
`cards[] (anyOf 4).config.recipients.leadIds`	array	Yes	maxItems: 5000
`cards[] (anyOf 4).config.recipients.leadIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.groupIds`	array	Yes	maxItems: 200
`cards[] (anyOf 4).config.recipients.groupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.labelIds`	array	—	default: [] · maxItems: 20
`cards[] (anyOf 4).config.recipients.labelIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.memberGroupIds`	array	—	default: [] · maxItems: 20
`cards[] (anyOf 4).config.recipients.memberGroupIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.recipients.audienceIds`	array	—	default: [] · maxItems: 50
`cards[] (anyOf 4).config.recipients.audienceIds[]`	string	—	format: "uuid"
`cards[] (anyOf 4).config.consentConfirmed`	boolean	—	default: false
`cards[] (anyOf 4).config.recipientCap`	union	—	default: null
`cards[] (anyOf 4).config.recipientCap (anyOf 1)`	integer	—	minimum: 0 · maximum: 100000
`cards[] (anyOf 4).config.recipientCap (anyOf 2)`	null	—
`cards[] (anyOf 4).schedule`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 4).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 4).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 4).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 4).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 4).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 4).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 4).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 4).schedule (anyOf 2).until (anyOf 2)`	null	—
`cards[] (anyOf 5)`	object	—	additionalProperties: false
`cards[] (anyOf 5).id`	string	—	format: "uuid"
`cards[] (anyOf 5).channel`	string	Yes	const: "email"
`cards[] (anyOf 5).gmailSenderId`	string	Yes	format: "uuid"
`cards[] (anyOf 5).format`	string	—	const: "feed" · default: "feed"
`cards[] (anyOf 5).config`	object	Yes	additionalProperties: false
`cards[] (anyOf 5).config.senderIds`	array	Yes	minItems: 1 · maxItems: 10
`cards[] (anyOf 5).config.senderIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.divide`	boolean	—	default: false
`cards[] (anyOf 5).config.subject`	string	Yes	minLength: 1 · maxLength: 200
`cards[] (anyOf 5).config.bodyHtml`	union	—	default: null
`cards[] (anyOf 5).config.bodyHtml (anyOf 1)`	string	—	maxLength: 100000
`cards[] (anyOf 5).config.bodyHtml (anyOf 2)`	null	—
`cards[] (anyOf 5).config.templateKind`	string	—	enum: ["announcement","listing","newsletter","personal"] · default: "announcement"
`cards[] (anyOf 5).config.trackLinks`	boolean	—	default: true
`cards[] (anyOf 5).config.trackOpens`	boolean	—	default: false
`cards[] (anyOf 5).config.recipients`	object	Yes	additionalProperties: false
`cards[] (anyOf 5).config.recipients.mode`	string	Yes	enum: ["all_consented","selected"]
`cards[] (anyOf 5).config.recipients.leadIds`	array	Yes	maxItems: 5000
`cards[] (anyOf 5).config.recipients.leadIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.recipients.audienceIds`	array	Yes	maxItems: 50
`cards[] (anyOf 5).config.recipients.audienceIds[]`	string	—	format: "uuid"
`cards[] (anyOf 5).config.consentConfirmed`	boolean	—	default: false
`cards[] (anyOf 5).config.recipientCap`	union	—	default: null
`cards[] (anyOf 5).config.recipientCap (anyOf 1)`	integer	—	minimum: 0 · maximum: 1000000
`cards[] (anyOf 5).config.recipientCap (anyOf 2)`	null	—
`cards[] (anyOf 5).schedule`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 1).kind`	string	Yes	const: "once"
`cards[] (anyOf 5).schedule (anyOf 1).at`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 1).at (anyOf 1)`	string	—	const: "now"
`cards[] (anyOf 5).schedule (anyOf 1).at (anyOf 2)`	string	—	format: "date-time"
`cards[] (anyOf 5).schedule (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).kind`	string	Yes	const: "recurring"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).kind`	string	Yes	const: "weekly"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).days`	array	Yes	minItems: 1 · maxItems: 7
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 1).days[]`	integer	—	minimum: 0 · maximum: 6
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2)`	object	—	additionalProperties: false
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2).kind`	string	Yes	const: "monthly"
`cards[] (anyOf 5).schedule (anyOf 2).recurrence (anyOf 2).dayOfMonth`	integer	Yes	minimum: 1 · maximum: 31
`cards[] (anyOf 5).schedule (anyOf 2).time`	string	Yes	pattern: "^(?:[01]\\d\|2[0-3]):[0-5]\\d$"
`cards[] (anyOf 5).schedule (anyOf 2).until`	union	Yes
`cards[] (anyOf 5).schedule (anyOf 2).until (anyOf 1)`	string	—	format: "date-time"
`cards[] (anyOf 5).schedule (anyOf 2).until (anyOf 2)`	null	—
`intent`	string	Yes	enum: ["draft","publish"]

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`campaignId`	string	Yes	format: "uuid"
`postId`	string	Yes	format: "uuid"
`revision`	integer	Yes	minimum: 1
`cards`	array	Yes	maxItems: 20
`cards[]`	object	—	additionalProperties: false
`cards[].id`	string	Yes	format: "uuid"
`cards[].channel`	string	Yes	enum: ["feed","facebook_groups","facebook_marketplace","whatsapp","email"]
`cards[].status`	string	Yes	enum: ["draft","scheduled","active","paused","finished"]
`cards[].setAside`	string	—	enum: ["marketplace_unavailable","marketplace_disabled","marketplace_listing_exists","marketplace_replaced","connected_account_inactive","text_too_long","media_not_supported","destination_unavailable","media_unavailable","content_unavailable","whatsapp_send_refused","email_send_refused"]
`replayed`	boolean	Yes

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

destinations

GET `/destinations`

Newest first; limit up to 500. Facebook group and Marketplace rows appear only when a Facebook identity you may post with reaches them, listed in socialAccountIds (every active member identity of a group). connectedAccountId is the official-API account and is null for Facebook groups and Marketplace. Filters: type, socialAccountId, connectedAccountId; a cursor is bound to its filters.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 500

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

type

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	enum: ["facebook_group","facebook_page","instagram_account","tiktok_account","x_account","linkedin_account","youtube_channel","pinterest_account","googlebusiness_location","snapchat_profile","reddit_account","threads_account","facebook_marketplace"]

socialAccountId

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

connectedAccountId

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 500
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].type`	string	Yes	enum: ["facebook_group","facebook_page","instagram_account","tiktok_account","x_account","linkedin_account","youtube_channel","pinterest_account","googlebusiness_location","snapchat_profile","reddit_account","threads_account","facebook_marketplace"]
`items[].externalId`	string	Yes	minLength: 1 · maxLength: 100
`items[].name`	union	Yes
`items[].name (anyOf 1)`	string	—	maxLength: 200
`items[].name (anyOf 2)`	null	—
`items[].connectedAccountId`	union	Yes
`items[].connectedAccountId (anyOf 1)`	string	—	format: "uuid"
`items[].connectedAccountId (anyOf 2)`	null	—
`items[].targetId`	union	—	default: null
`items[].targetId (anyOf 1)`	string	—	minLength: 1 · maxLength: 100
`items[].targetId (anyOf 2)`	null	—
`items[].marketplaceEligibility`	union	—	default: null
`items[].marketplaceEligibility (anyOf 1)`	string	—	enum: ["unknown","eligible","ineligible"]
`items[].marketplaceEligibility (anyOf 2)`	null	—
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`items[].socialAccountIds`	array	Yes
`items[].socialAccountIds[]`	string	—	format: "uuid"
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

facebook-identities

GET `/facebook-identities`

Facebook profiles and Pages you may post with, including disconnected ones. id is a card's socialAccountId. status: active, needs_attention, paused or disconnected, with statusReason and per-rail readiness.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].type`	string	Yes	enum: ["profile","page"]
`items[].name`	string \| null	Yes
`items[].status`	string	Yes	enum: ["active","needs_attention","paused","disconnected"]
`items[].statusReason`	union	Yes
`items[].statusReason (anyOf 1)`	string	—	enum: ["paused_by_safety","posting_disabled","paused_by_user","facebook_cooldown","reconnect_required","offline","not_paired","signed_out","page_not_visible","recent_refusal","switch_account","not_set_up","setting_up","warming_up","choose_who_posts"]
`items[].statusReason (anyOf 2)`	null	—
`items[].statusUntil`	union	Yes
`items[].statusUntil (anyOf 1)`	string	—	format: "date-time"
`items[].statusUntil (anyOf 2)`	null	—
`items[].readiness`	object	Yes	additionalProperties: false
`items[].readiness.extension`	string	Yes	enum: ["ready","offline","not_paired","signed_out","page_not_visible","recent_refusal","switch_account"]
`items[].readiness.cloud`	string	Yes	enum: ["ready","not_set_up","setting_up","signed_out","warming_up","choose_who_posts","page_not_visible","offline"]
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

connected-accounts

GET `/connected-accounts`

Official-API accounts you may post with, including expired and revoked ones. id is a destination's connectedAccountId.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].platform`	string	Yes	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads"]
`items[].name`	string \| null	Yes
`items[].handle`	string \| null	Yes
`items[].pictureUrl`	union	Yes
`items[].pictureUrl (anyOf 1)`	string	—	format: "uri"
`items[].pictureUrl (anyOf 2)`	null	—
`items[].status`	string	Yes	enum: ["active","needs_attention","paused","disconnected"]
`items[].statusReason`	union	Yes
`items[].statusReason (anyOf 1)`	string	—	enum: ["paused_by_safety","posting_disabled","paused_by_user","facebook_cooldown","reconnect_required","offline","not_paired","signed_out","page_not_visible","recent_refusal","switch_account","not_set_up","setting_up","warming_up","choose_who_posts"]
`items[].statusReason (anyOf 2)`	null	—
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

media

GET `/media`

Only postable media visible/attachable by the current uploader; never colleague-private chat uploads or storage credentials.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`items`	array	Yes	maxItems: 50
`items[]`	object	—	additionalProperties: false
`items[].id`	string	Yes	format: "uuid"
`items[].kind`	string	Yes	enum: ["post_media","studio_creative","minisite_file","agent_upload","agent_media","user_avatar","business_logo"]
`items[].mime`	string	Yes	minLength: 1 · maxLength: 100
`items[].sizeBytes`	integer	Yes	minimum: 0
`items[].createdAt`	string	Yes	format: "date-time"
`items[].updatedAt`	string	Yes	format: "date-time"
`items[].url`	union	Yes
`items[].url (anyOf 1)`	string	—	format: "uri"
`items[].url (anyOf 2)`	null	—
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

POST `/media`

Requires write access. One file: JPEG/PNG/WebP/GIF ≤10 MiB, or MP4 ≤256 MiB, validated by MIME/signature. Quota/authorization precede upload buffering. At-least-once: manual retry can create an extra unlinked asset. Unlinked staging becomes cleanup-eligible after 24 hours (15-minute bounded sweep); legitimate app attachments protect it. No exact deletion time or automatic retry.

Request body (required)

`multipart/form-data`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`file`	string	Yes	Binary JPEG, PNG, WebP or GIF (10 MiB maximum), or MP4 (256 MiB maximum). · format: "binary"

Responses

HTTP 201 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`id`	string	Yes	format: "uuid"
`kind`	string	Yes	enum: ["post_media","studio_creative","minisite_file","agent_upload","agent_media","user_avatar","business_logo"]
`mime`	string	Yes	minLength: 1 · maxLength: 100
`sizeBytes`	integer	Yes	minimum: 0
`createdAt`	string	Yes	format: "date-time"
`updatedAt`	string	Yes	format: "date-time"
`url`	union	Yes
`url (anyOf 1)`	string	—	format: "uri"
`url (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

analytics

GET `/analytics`

Parameters

Name In Required Description Schema

from

query

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "date-time"

to

query

Yes

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "date-time"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`totals`	object	Yes	additionalProperties: false
`totals.impressions`	union	Yes
`totals.impressions (anyOf 1)`	integer	—	minimum: 0
`totals.impressions (anyOf 2)`	null	—
`totals.reach`	union	Yes
`totals.reach (anyOf 1)`	integer	—	minimum: 0
`totals.reach (anyOf 2)`	null	—
`totals.views`	union	Yes
`totals.views (anyOf 1)`	integer	—	minimum: 0
`totals.views (anyOf 2)`	null	—
`totals.likes`	union	Yes
`totals.likes (anyOf 1)`	integer	—	minimum: 0
`totals.likes (anyOf 2)`	null	—
`totals.comments`	union	Yes
`totals.comments (anyOf 1)`	integer	—	minimum: 0
`totals.comments (anyOf 2)`	null	—
`totals.shares`	union	Yes
`totals.shares (anyOf 1)`	integer	—	minimum: 0
`totals.shares (anyOf 2)`	null	—
`totals.saves`	union	Yes
`totals.saves (anyOf 1)`	integer	—	minimum: 0
`totals.saves (anyOf 2)`	null	—
`totals.clicks`	union	Yes
`totals.clicks (anyOf 1)`	integer	—	minimum: 0
`totals.clicks (anyOf 2)`	null	—
`byPlatform`	array	Yes
`byPlatform[]`	object	—	additionalProperties: false
`byPlatform[].engagement`	object	Yes	additionalProperties: false
`byPlatform[].engagement.impressions`	union	Yes
`byPlatform[].engagement.impressions (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.impressions (anyOf 2)`	null	—
`byPlatform[].engagement.reach`	union	Yes
`byPlatform[].engagement.reach (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.reach (anyOf 2)`	null	—
`byPlatform[].engagement.views`	union	Yes
`byPlatform[].engagement.views (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.views (anyOf 2)`	null	—
`byPlatform[].engagement.likes`	union	Yes
`byPlatform[].engagement.likes (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.likes (anyOf 2)`	null	—
`byPlatform[].engagement.comments`	union	Yes
`byPlatform[].engagement.comments (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.comments (anyOf 2)`	null	—
`byPlatform[].engagement.shares`	union	Yes
`byPlatform[].engagement.shares (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.shares (anyOf 2)`	null	—
`byPlatform[].engagement.saves`	union	Yes
`byPlatform[].engagement.saves (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.saves (anyOf 2)`	null	—
`byPlatform[].engagement.clicks`	union	Yes
`byPlatform[].engagement.clicks (anyOf 1)`	integer	—	minimum: 0
`byPlatform[].engagement.clicks (anyOf 2)`	null	—
`byPlatform[].posts`	integer	Yes	minimum: 0
`byPlatform[].platform`	string	Yes	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads"]
`byCampaign`	array	Yes
`byCampaign[]`	object	—	additionalProperties: false
`byCampaign[].engagement`	object	Yes	additionalProperties: false
`byCampaign[].engagement.impressions`	union	Yes
`byCampaign[].engagement.impressions (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.impressions (anyOf 2)`	null	—
`byCampaign[].engagement.reach`	union	Yes
`byCampaign[].engagement.reach (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.reach (anyOf 2)`	null	—
`byCampaign[].engagement.views`	union	Yes
`byCampaign[].engagement.views (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.views (anyOf 2)`	null	—
`byCampaign[].engagement.likes`	union	Yes
`byCampaign[].engagement.likes (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.likes (anyOf 2)`	null	—
`byCampaign[].engagement.comments`	union	Yes
`byCampaign[].engagement.comments (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.comments (anyOf 2)`	null	—
`byCampaign[].engagement.shares`	union	Yes
`byCampaign[].engagement.shares (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.shares (anyOf 2)`	null	—
`byCampaign[].engagement.saves`	union	Yes
`byCampaign[].engagement.saves (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.saves (anyOf 2)`	null	—
`byCampaign[].engagement.clicks`	union	Yes
`byCampaign[].engagement.clicks (anyOf 1)`	integer	—	minimum: 0
`byCampaign[].engagement.clicks (anyOf 2)`	null	—
`byCampaign[].posts`	integer	Yes	minimum: 0
`byCampaign[].campaignId`	string	Yes	format: "uuid"
`followers`	array	Yes
`followers[]`	object	—	additionalProperties: false
`followers[].connectedAccountId`	string	Yes	format: "uuid"
`followers[].platform`	string	Yes	enum: ["instagram","facebook","tiktok","x","linkedin","youtube","pinterest","googlebusiness","snapchat","reddit","threads"]
`followers[].followers`	union	Yes
`followers[].followers (anyOf 1)`	integer	—	minimum: 0
`followers[].followers (anyOf 2)`	null	—
`followers[].deltaInRange`	union	Yes
`followers[].deltaInRange (anyOf 1)`	integer	—
`followers[].deltaInRange (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

posting-activity

GET `/posting-activity`

Cursor pins the time window and filters. Keep filters and limit unchanged. For bulkSendsNextCursor from a mixed page, continue with network=whatsapp. Sending/scheduling remains asynchronous; activity is evidence, not an exactly-once delivery guarantee.

Parameters

Name In Required Description Schema

limit

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	default: 20 · minimum: 1 · maximum: 50

cursor

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	minLength: 1 · maxLength: 2048

date

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	pattern: "^\\d{4}-\\d{2}-\\d{2}$"

period

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	enum: ["past_week","past_month"]

network

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	enum: ["facebook_groups","facebook_page","facebook_marketplace","instagram","tiktok","linkedin","x","youtube","pinterest","google_business","threads","reddit","snapchat","whatsapp"]

includeFailures

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	enum: ["true","false"] · default: "false"

bulkSendId

query

Schema fields
Field	Type	Required	Description / constraints
`(value)`	string	—	format: "uuid"

Responses

HTTP 200 — Success.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`activity`	union	Yes
`activity (anyOf 1)`	object	—	additionalProperties: false
`activity (anyOf 1).mode`	string	Yes	const: "period"
`activity (anyOf 1).period`	object	Yes	additionalProperties: false
`activity (anyOf 1).period.from`	string	Yes	format: "date-time"
`activity (anyOf 1).period.to`	string	Yes	format: "date-time"
`activity (anyOf 1).period.timeZone`	string	Yes
`activity (anyOf 1).period.label`	string	Yes
`activity (anyOf 1).networks`	union	Yes
`activity (anyOf 1).networks (anyOf 1)`	array	—
`activity (anyOf 1).networks (anyOf 1)[]`	string	—	enum: ["facebook_groups","facebook_page","facebook_marketplace","instagram","tiktok","linkedin","x","youtube","pinterest","google_business","threads","reddit","snapchat","whatsapp"]
`activity (anyOf 1).networks (anyOf 2)`	null	—
`activity (anyOf 1).totals`	array	Yes
`activity (anyOf 1).totals[]`	object	—	additionalProperties: false
`activity (anyOf 1).totals[].network`	string	Yes	enum: ["facebook_groups","facebook_page","facebook_marketplace","instagram","tiktok","linkedin","x","youtube","pinterest","google_business","threads","reddit","snapchat","whatsapp"]
`activity (anyOf 1).totals[].posted`	integer	Yes	minimum: 0
`activity (anyOf 1).totals[].partlyPosted`	integer	Yes	minimum: 0
`activity (anyOf 1).totals[].needsChecking`	integer	Yes	minimum: 0
`activity (anyOf 1).totals[].failed`	integer	Yes	minimum: 0
`activity (anyOf 1).totals[].waiting`	integer	Yes	minimum: 0
`activity (anyOf 1).posts`	array	Yes
`activity (anyOf 1).posts[]`	object	—	additionalProperties: false
`activity (anyOf 1).posts[].jobId`	string	Yes	format: "uuid"
`activity (anyOf 1).posts[].postId`	string	Yes	format: "uuid"
`activity (anyOf 1).posts[].at`	string	Yes	format: "date-time"
`activity (anyOf 1).posts[].network`	string	Yes	enum: ["facebook_groups","facebook_page","facebook_marketplace","instagram","tiktok","linkedin","x","youtube","pinterest","google_business","threads","reddit","snapchat","whatsapp"]
`activity (anyOf 1).posts[].destination`	string \| null	Yes
`activity (anyOf 1).posts[].account`	string \| null	Yes
`activity (anyOf 1).posts[].campaign`	string \| null	Yes
`activity (anyOf 1).posts[].outcome`	string	Yes	enum: ["posted","partly_posted","needs_checking","failed","waiting"]
`activity (anyOf 1).posts[].reason`	union	Yes
`activity (anyOf 1).posts[].reason (anyOf 1)`	string	—	pattern: "^[a-z0-9_.:-]{1,64}$"
`activity (anyOf 1).posts[].reason (anyOf 2)`	null	—
`activity (anyOf 1).posts[].permalink`	union	Yes
`activity (anyOf 1).posts[].permalink (anyOf 1)`	string	—	format: "uri"
`activity (anyOf 1).posts[].permalink (anyOf 2)`	null	—
`activity (anyOf 1).posts[].excerpt`	string	Yes
`activity (anyOf 1).postsMatched`	integer	Yes	minimum: 0
`activity (anyOf 1).hiddenFailed`	integer	Yes	minimum: 0
`activity (anyOf 1).hiddenWaiting`	integer	Yes	minimum: 0
`activity (anyOf 1).nextOffset`	union	Yes
`activity (anyOf 1).nextOffset (anyOf 1)`	integer	—	minimum: 0
`activity (anyOf 1).nextOffset (anyOf 2)`	null	—
`activity (anyOf 1).bulkSends`	array	Yes
`activity (anyOf 1).bulkSends[]`	object	—	additionalProperties: false
`activity (anyOf 1).bulkSends[].sendId`	string	Yes	format: "uuid"
`activity (anyOf 1).bulkSends[].startedAt`	union	Yes
`activity (anyOf 1).bulkSends[].startedAt (anyOf 1)`	string	—	format: "date-time"
`activity (anyOf 1).bulkSends[].startedAt (anyOf 2)`	null	—
`activity (anyOf 1).bulkSends[].lastActivityAt`	union	Yes
`activity (anyOf 1).bulkSends[].lastActivityAt (anyOf 1)`	string	—	format: "date-time"
`activity (anyOf 1).bulkSends[].lastActivityAt (anyOf 2)`	null	—
`activity (anyOf 1).bulkSends[].whatsappNumber`	string \| null	Yes
`activity (anyOf 1).bulkSends[].whatsappAccount`	string \| null	Yes
`activity (anyOf 1).bulkSends[].campaign`	string \| null	Yes
`activity (anyOf 1).bulkSends[].status`	string	Yes	enum: ["draft","active","paused","stopped","done"]
`activity (anyOf 1).bulkSends[].recipients`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSends[].sent`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSends[].failed`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSends[].needsReview`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSends[].left`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSends[].skipped`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSendsMatched`	integer	Yes	minimum: 0
`activity (anyOf 1).bulkSendsNextOffset`	union	Yes
`activity (anyOf 1).bulkSendsNextOffset (anyOf 1)`	integer	—	minimum: 0
`activity (anyOf 1).bulkSendsNextOffset (anyOf 2)`	null	—
`activity (anyOf 2)`	object	—	additionalProperties: false
`activity (anyOf 2).mode`	string	Yes	const: "bulk_send"
`activity (anyOf 2).bulkSend`	object	Yes	additionalProperties: false
`activity (anyOf 2).bulkSend.sendId`	string	Yes	format: "uuid"
`activity (anyOf 2).bulkSend.startedAt`	union	Yes
`activity (anyOf 2).bulkSend.startedAt (anyOf 1)`	string	—	format: "date-time"
`activity (anyOf 2).bulkSend.startedAt (anyOf 2)`	null	—
`activity (anyOf 2).bulkSend.lastActivityAt`	union	Yes
`activity (anyOf 2).bulkSend.lastActivityAt (anyOf 1)`	string	—	format: "date-time"
`activity (anyOf 2).bulkSend.lastActivityAt (anyOf 2)`	null	—
`activity (anyOf 2).bulkSend.whatsappNumber`	string \| null	Yes
`activity (anyOf 2).bulkSend.whatsappAccount`	string \| null	Yes
`activity (anyOf 2).bulkSend.campaign`	string \| null	Yes
`activity (anyOf 2).bulkSend.status`	string	Yes	enum: ["draft","active","paused","stopped","done"]
`activity (anyOf 2).bulkSend.recipients`	integer	Yes	minimum: 0
`activity (anyOf 2).bulkSend.sent`	integer	Yes	minimum: 0
`activity (anyOf 2).bulkSend.failed`	integer	Yes	minimum: 0
`activity (anyOf 2).bulkSend.needsReview`	integer	Yes	minimum: 0
`activity (anyOf 2).bulkSend.left`	integer	Yes	minimum: 0
`activity (anyOf 2).bulkSend.skipped`	integer	Yes	minimum: 0
`activity (anyOf 2).onlyProblems`	boolean	Yes
`activity (anyOf 2).recipients`	array	Yes
`activity (anyOf 2).recipients[]`	object	—	additionalProperties: false
`activity (anyOf 2).recipients[].contactId`	union	Yes
`activity (anyOf 2).recipients[].contactId (anyOf 1)`	string	—	format: "uuid"
`activity (anyOf 2).recipients[].contactId (anyOf 2)`	null	—
`activity (anyOf 2).recipients[].kind`	string	Yes	enum: ["contact","group","member"]
`activity (anyOf 2).recipients[].name`	string \| null	Yes
`activity (anyOf 2).recipients[].status`	string	Yes	enum: ["sent","failed","needs_review","skipped","left"]
`activity (anyOf 2).recipients[].reason`	union	Yes
`activity (anyOf 2).recipients[].reason (anyOf 1)`	string	—	pattern: "^[a-z0-9_.:-]{1,64}$"
`activity (anyOf 2).recipients[].reason (anyOf 2)`	null	—
`activity (anyOf 2).recipients[].at`	union	Yes
`activity (anyOf 2).recipients[].at (anyOf 1)`	string	—	format: "date-time"
`activity (anyOf 2).recipients[].at (anyOf 2)`	null	—
`activity (anyOf 2).recipientsMatched`	integer	Yes	minimum: 0
`activity (anyOf 2).nextOffset`	union	Yes
`activity (anyOf 2).nextOffset (anyOf 1)`	integer	—	minimum: 0
`activity (anyOf 2).nextOffset (anyOf 2)`	null	—
`nextCursor`	union	Yes
`nextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`nextCursor (anyOf 2)`	null	—
`bulkSendsNextCursor`	union	Yes
`bulkSendsNextCursor (anyOf 1)`	string	—	minLength: 1 · maxLength: 2048
`bulkSendsNextCursor (anyOf 2)`	null	—

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

HTTP 400 — Invalid input, cursor, idempotency key or conflicting workspace selector.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 401 — Missing, expired, revoked or otherwise invalid API credential/current identity, or a browser request (browser_request_not_allowed).

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 403 — Key access, current role or seat denies the operation.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 404 — Resource absent, foreign or API disabled.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 409 — Current seat/resource conflict, or an operation key reused with changed content.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 410 — A consumed operation refers to a deleted resource or parent and cannot recreate it.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 413 — Upload exceeds the media byte bound.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 415 — Unsupported media type, content encoding or charset.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 422 — The reviewed content has no currently publishable channel.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 429 — Per-key minute or shared workspace/user UTC-day quota exhausted.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

Response headers

`X-RateLimit-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Limit`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Remaining`

Quota limit or remaining requests.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`X-RateLimit-Day-Reset`

Reset time as Unix epoch seconds.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 0

`Retry-After`

Seconds to wait before quota admission can succeed.

Schema fields
Field	Type	Required	Description / constraints
`(value)`	integer	—	minimum: 1

HTTP 500 — Unexpected read failure, or unknown write outcome. Inspect state; retry a keyed write only with its original key.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

HTTP 503 — Authentication, storage or distributed quota dependency unavailable; admission fails closed.

`application/json`

Schema fields
Field	Type	Required	Description / constraints
`(value)`	object	—	additionalProperties: false
`error`	string	Yes	pattern: "^[a-z][a-z0-9_]{0,63}$"
`message`	string	Yes	minLength: 1 · maxLength: 300
`details`	object	—	additionalProperties: false
`details.issues`	array	Yes	maxItems: 8
`details.issues[]`	object	—	additionalProperties: false
`details.issues[].path`	array	Yes	maxItems: 12
`details.issues[].path[]`	union	—
`details.issues[].path[] (anyOf 1)`	string	—	maxLength: 80
`details.issues[].path[] (anyOf 2)`	number	—
`details.issues[].message`	string	Yes	maxLength: 240
`requestId`	string	—	minLength: 1 · maxLength: 128
`contactId`	string	—	format: "uuid"
`retryable`	boolean	—	const: true

API reference

Base URL

Authentication

developerApi

contacts

GET /contacts

Parameters

Responses

application/json

Response headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

X-RateLimit-Day-Limit

X-RateLimit-Day-Remaining

X-RateLimit-Day-Reset

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Response headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

X-RateLimit-Day-Limit

X-RateLimit-Day-Remaining

X-RateLimit-Day-Reset

Retry-After

application/json

application/json

POST /contacts

Request body (required)

application/json

Responses

application/json

Response headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

X-RateLimit-Day-Limit

X-RateLimit-Day-Remaining

X-RateLimit-Day-Reset

application/json

Response headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

X-RateLimit-Day-Limit

X-RateLimit-Day-Remaining

X-RateLimit-Day-Reset

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Response headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

X-RateLimit-Day-Limit

X-RateLimit-Day-Remaining

X-RateLimit-Day-Reset

Retry-After

application/json

application/json

GET /contacts/{id}

Parameters

Responses

application/json

GET `/contacts`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`Retry-After`

`application/json`

`application/json`

POST `/contacts`

`application/json`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`Retry-After`

`application/json`

`application/json`

GET `/contacts/{id}`

`application/json`

`X-RateLimit-Limit`

`X-RateLimit-Remaining`

`X-RateLimit-Reset`

`X-RateLimit-Day-Limit`

`X-RateLimit-Day-Remaining`

`X-RateLimit-Day-Reset`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`