Skip to main content
POST
Cancelar mensagem agendada

Authorizations

Authorization
string
header
required

Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave.

Path Parameters

id
string<uuid>
required

UUID da conversa.

scheduledMessageId
string<uuid>
required

UUID da mensagem agendada.

Body

application/json
reason
string
Maximum string length: 500

Response

Operação realizada.

id
string<uuid>
chat_id
string<uuid>
company_id
string<uuid>
is_scheduled
enum<boolean>
Available options:
true
status
enum<string>
Available options:
PENDING,
PROCESSING,
SENT,
CANCELED,
FAILED
message_kind
enum<string>
Available options:
OPEN_MESSAGE,
TEMPLATE
cancel_reason
enum<string> | null
Available options:
USER_REQUEST,
CHAT_INTERACTION,
TEMPLATE_INVALID_OR_UNAVAILABLE
cancel_reason_description
string | null
failure_reason
string | null
cancel_on_inbound
boolean
scheduled_at
string<date-time>
processed_at
string<date-time> | null
sent_at
string<date-time> | null
canceled_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>
created_by_user_id
string<uuid>
sender_agent_id
string<uuid> | null
canceled_by_user_id
string<uuid> | null
payload
object
attachments
object[]
sent_message_ids
string<uuid>[]
whatsapp_ai_agent_id
string<uuid> | null

Agente de IA que criou o agendamento; null para agendamentos criados por pessoas ou pela integração.