FOfolk
Campaigns

Delete a campaign

Changed on

Delete a campaign that is a draft or in review, with its messages. Other campaigns can't be deleted: stop a scheduled or sending campaign instead.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

delete/v1/campaigns/{campaignId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/campaigns/{campaignId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

The ID of the campaign.

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Response

The ID of the deleted campaign.

deprecationsstring[]

Example response

{
  "data": {
    "id": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes