In this area

Approval queue

Send a message to a customer (approval required)

post/v1/public/messages/send

Needs approvalAccepts Idempotency-Key

Creates a PENDING action — does NOT send the message immediately. An organization admin (OWNER or ADMIN) must approve in the dashboard. Returns the action id, preview (contact, channel, body excerpt), and expiresAt. Use GET /v1/public/pending-actions/:id to poll status.

Answers 202 with the request: the action only happens after someone approves it in To review or in the AI approvals tab.

Parameters

No parameters.

Responses

202

Examples

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/messages/send" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Book an appointment (approval required)

post/v1/public/scheduling/appointments

Needs approvalAccepts Idempotency-Key

Queues a PENDING booking. An admin reviews attendant, service, contact, and time slot before the appointment is created and notifications fire.

Answers 202 with the request: the action only happens after someone approves it in To review or in the AI approvals tab.

Parameters

No parameters.

Responses

202

Examples

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/scheduling/appointments" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Cancel an appointment (approval required)

post/v1/public/scheduling/appointments/{id}/cancel

Needs approvalAccepts Idempotency-Key

Queues a PENDING cancellation. Once approved, the appointment is cancelled and the configured notification fires to the contact.

Answers 202 with the request: the action only happens after someone approves it in To review or in the AI approvals tab.

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

202

Examples

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/scheduling/appointments/<id>/cancel" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Reschedule an appointment (approval required)

post/v1/public/scheduling/appointments/{id}/reschedule

Needs approvalAccepts Idempotency-Key

Queues a PENDING reschedule. Once approved, the existing slot is cancelled and a new appointment is created at the requested time. The returned executionResult includes the NEW appointment id.

Answers 202 with the request: the action only happens after someone approves it in To review or in the AI approvals tab.

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

202

Examples

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/scheduling/appointments/<id>/reschedule" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Launch a marketing campaign (approval required)

post/v1/public/campaigns/{id}/launch

Needs approvalAccepts Idempotency-Key

Queues a PENDING launch. Highest-risk write — touches many contacts. TTL is 1 hour (shorter than the default 24h) because campaign content is typically time-bound. Admin sees contact count, channel, and message preview before approving.

Answers 202 with the request: the action only happens after someone approves it in To review or in the AI approvals tab.

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

202

Examples

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/campaigns/<id>/launch" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Full reference