API referenceMessages

Cancel a scheduled outbound message

Cancels a scheduled outbound send before it fires, by messageId.

Endpoint
POST https://api.dairo.app/v1/messages/{messageId}/cancel

Cancels a scheduled outbound send before it fires, by messageId. This succeeds only while the message is still in scheduled status; the response is the message with status: canceled and a canceledAt timestamp. If the send has already left scheduled — sent, queued, canceled, or unknown — the call returns 409. Cancellation stops only the future dispatch and emits no webhook event. Requires the messages:send scope.

Scope: messages:send. Send the API key as a bearer token; Scopes lists what each one reaches.

Request

cURL
curl -X POST "https://api.dairo.app/v1/messages/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer $DAIRO_API_KEY"

Path parameters

NameTypeRequiredDescription
messageIdstringyesThe outbound email id to cancel.

Response

200 Success. Body: application/json, CancelOutboundMessageResponse.

FieldTypeRequiredDescription
messageOutboundMessageyes
200
{
  "message": {
    "id": "string",
    "from": null,
    "to": [
      "string"
    ],
    "subject": "Hello from Acme",
    "status": null,
    "sentAt": null,
    "error": null,
    "providerMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastEventType": null,
    "lastEventAt": null,
    "bouncedAt": null,
    "complainedAt": null,
    "createdAt": null,
    "scheduledAt": "2026-10-19T09:30:00Z",
    "canceledAt": "2026-10-19T09:30:00Z"
  }
}

Errors

Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.

StatusMeaning
400The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch).
401The API key is missing or invalid.
403The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted).
404No such resource in this account (resource_not_found).
409The resource already exists or its state does not allow this (duplicate_resource or a condition-specific code).
422The request is well-formed but a field failed validation (validation_failed).
429Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached).
500An unexpected error; retry with backoff, then contact support (internal_error).

On this page