Outbound

Delete an Outbound message

Permanently deletes the message. No body or query is required. Optionally supply revision and/or idempotencyKey as query parameters. This stops future delivery, cancels timers and removes recipient-ledger and analytics rows. Untouched outbound chat conversations are soft-deleted. Survey response documents are retained internally, but these message-scoped reporting routes are no longer available after deletion. Export reports before deleting. The action cannot be undone.

DELETE

/v2/outbound/messages/{outboundMessageId}

curl --request DELETE \
  --url 'https://do.featurebase.app/v2/outbound/messages/{outboundMessageId}?idempotencyKey=welcome-campaign-2026-10-01&revision=123' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "deleted": true,
  "id": "6457e3ff70afca5d8c27dccc",
  "object": "outbound_message"
}

Optional protections: idempotencyKey enables safe retries; revision on existing campaigns rejects stale changes. Neither is required, and they can be used independently. Without a key, each request is a new operation and does not create an operation receipt; do not blindly retry an uncertain create or send. Without a revision, a change can overwrite a concurrent edit. With a key, keep the exact request on retries. Completed results replay for at least 7 days. Changed input returns idempotency_conflict; a concurrent retry returns operation_pending. For operation_outcome_unknown, inspect the Outbound-Operation-Id receipt before another operation. Schedule synchronization stays durable with or without these fields.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

outboundMessageIdstringrequired

Outbound message ID

Example: 6457e3ff70afca5d8c27dccc

Query Parameters

idempotencyKeystringquery

Optional retry protection. Keep the same key and request when retrying. Without a key, each request is a new operation.

Required string length: 8 - 128

Pattern: ^[a-zA-Z0-9_.:-]+$

Example: welcome-campaign-2026-10-01

revisioninteger | nullquery

Required range: 0 <= x

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Response

Success

deletedenum<boolean>required

Indicates the resource was deleted

Available options: true

Example: true

idstringrequired

Unique identifier of the deleted message

Example: 6457e3ff70afca5d8c27dccc

objectenum<string>required

Object type identifier

Available options: outbound_message

Example: outbound_message

Still need help? Ask the team