Cancelar reunião

v1.0.0

POSThttps://api.staging.growthaisystem.com/api/v1/appointments/{id}/cancel

ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcalendars.write

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

idstringobrigatório
- tamanho mín. 1

Corpo da requisição

application/jsonobrigatório

reasonstring | nullopcional
- tamanho máx. 500

Respostas

11 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Reunião cancelada (cancelamento suave e idempotente) — o horário volta a ficar livre para o vendedor e o contato recebe o rastro no chat.

V1AppointmentCancelada

idstring
canceledboolean

Definição

POST/appointments/{id}/cancel

Exemplo

https://api.staging.growthaisystem.com/api/v1/appointments/SEU_ID_AQUI/cancel

Requisição

curl -X POST "https://api.staging.growthaisystem.com/api/v1/appointments/SEU_ID_AQUI/cancel" \
  -H "Authorization: Bearer gos_SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Cliente avisou pelo WhatsApp que não poderá comparecer"
}'

Isto chama a API de verdade. A requisição sai do seu navegador direto para https://api.staging.growthaisystem.com — dado real, do workspace da chave que você colar. Em escritas, o efeito é permanente.

Chave de APIBearerobrigatório

Vai no cabeçalho Authorization: Bearer …. Ela nunca aparece no cURL copiável nem sai desta aba.

Lembrar nesta aba — some ao fechá-la. Não marque em computador compartilhado: a chave dá acesso ao workspace inteiro dentro dos escopos dela.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

idtextoobrigatório

Corpoapplication/jsonobrigatório

JSON válido· 3 linhas

O exemplo vem do próprio schema da API. Troque os valores pelos seus antes de enviar.

Vai sair assim

POSThttps://api.staging.growthaisystem.com/api/v1/appointments/{id}/cancel

O botão copia o cURL equivalente — com gos_SEU_TOKEN_AQUI no lugar da sua chave.

⌘Enter

Resposta

{
  "id": "9d2e7c41-3f86-4b52-a1c9-6e0f8b47d215",
  "canceled": true
}