Nesta área
Approval queue
Send a message to a customer (approval required)
post/v1/public/messages/send
Pede aprovaçãoAceita 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.
Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.
Parâmetros
Sem parâmetros.
Respostas
202
Exemplos
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
Pede aprovaçãoAceita Idempotency-Key
Queues a PENDING booking. An admin reviews attendant, service, contact, and time slot before the appointment is created and notifications fire.
Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.
Parâmetros
Sem parâmetros.
Respostas
202
Exemplos
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
Pede aprovaçãoAceita Idempotency-Key
Queues a PENDING cancellation. Once approved, the appointment is cancelled and the configured notification fires to the contact.
Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.
Parâmetros
idstringobrigatório· caminho
| Campo | Onde | Tipo | Descrição |
|---|---|---|---|
idobrigatório | caminho | string |
Respostas
202
Exemplos
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
Pede aprovaçãoAceita 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.
Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.
Parâmetros
idstringobrigatório· caminho
| Campo | Onde | Tipo | Descrição |
|---|---|---|---|
idobrigatório | caminho | string |
Respostas
202
Exemplos
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
Pede aprovaçãoAceita 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.
Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.
Parâmetros
idstringobrigatório· caminho
| Campo | Onde | Tipo | Descrição |
|---|---|---|---|
idobrigatório | caminho | string |
Respostas
202
Exemplos
curl -X POST "https://api.cognizy.ai/api/v1/public/campaigns/<id>/launch" \
-H "Authorization: Bearer $COGNIZY_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"