Message

Cancelar mensagem agendada

Changed on

Cancela uma mensagem com status SCHEDULE, alterando para CANCELED. Mensagens que não estão agendadas ou já foram processadas/canceladas retornam 400. Só opera sobre mensagens do workspace da credencial.

post/v1/message/{id}/cancel

Request

  • Base URL
    https://api.liderhub.com.br
  • URL
    https://api.liderhub.com.br/v1/message/{id}/cancel
  • Auth
    API key in header x-company-key

Path parameters

idstring uuid required

UUID da mensagem agendada

Response

Mensagem agendada cancelada com sucesso

idstring uuid required

UUID da mensagem cancelada

deliveryStatusstring required

Status após o cancelamento

Example response

{
  "id": "f8d015c2-e21b-4b96-9455-238d2e5be137",
  "deliveryStatus": "CANCELED"
}

Changes