Delete a campaign

Delete campaign

delete

A campaign can be deleted if it doesn't have any active channels.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

brandIdstringRequired

A unique identifier for the brand.

campaignIdstringRequired

A unique identifier for the campaign.

Responses

200

Campaign deleted

application/json

idstring · uuidOptional

UUID of the campaign.

namestringOptional

Campaign name

statusstring · enumOptional

Campaign status

Possible values:

usecasestringOptional

A use case that best matches the purpose of the campaign.

subUsecasesstring[] · nullableOptional

If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases.

descriptionstringOptional

A detailed description of what the campaign is for.

embeddedLinkbooleanOptional

Whether messages will contain links. Provide at least one sample containing a link.

embeddedPhonebooleanOptional

Whether messages will contain phone number. Provide at least one sample containing a phone number.

numberPoolbooleanOptional

Whether a campaign will be associated with more than 50 numbers e.g. customer service use case.

ageGatedbooleanOptional

Whether a campaign contains age-gated content based on carrier/ctia guidelines.

directLendingbooleanOptional

Whether a campaign includes content related to direct lending or loan arrangements.

subscriberOptinbooleanOptional

Confirm customer opt in is collected and processed.

subscriberOptoutbooleanOptional

Confirm customer opt out is collected and processed.

subscriberHelpbooleanOptional

Confirm an info message is returned if a customer sends "HELP".

samplesstring[]Optional

Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples.

messageFlowstringOptional

Provide details of how the customer will opt into this campaign. If you have a live web opt-in provide the URL and ensure the page has details on the T&Cs/data collection for opting in, and how to opt out.

helpMessagestringOptional

Help message of the campaign. A help message shall state the name of the service, contact (email or call centre), OPT IN and OPT OUT keywords.

helpKeywordsstringOptional

A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.

optoutKeywordsstringOptional

A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.

optinKeywordsstringOptional

A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.

optinMessagestringOptional

Provide an example of the message that will be sent after a customer has opted in.

optoutMessagestringOptional

Provide an example of the message that will be sent after a customer has opted out.

termsAndConditionsbooleanOptional

Indicates the campaign follows CTIA messaging principles and best practices.

brandIdstring · uuidOptional

UUID of the brand associated with this campaign. The specified brand MUST be APPROVED.

resellerIdstring · nullableOptional

UUID of the reseller associated with this campaign. The specified reseller MUST be ACTIVE.

createdAtstring · date-timeOptional

Timestamp (UTC) when the campaign was created.

updatedAtstring · date-timeOptional

Timestamp (UTC) when the campaign was last updated.

400

Unable to delete campaign

application/json

404

Campaign or brand not found

application/json

delete

/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "subscription": {
    "status": "active",
    "subscribedAt": "2026-02-19T21:01:32.489Z",
    "updatedAt": "2026-02-19T21:01:32.489Z",
    "cancelledAt": "2026-02-19T21:01:32.489Z"
  },
  "status": "DRAFT",
  "usecase": "text",
  "subUsecases": [
    "text"
  ],
  "description": "text",
  "embeddedLink": true,
  "embeddedPhone": true,
  "numberPool": true,
  "ageGated": true,
  "directLending": true,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "subscriberHelp": true,
  "samples": [
    "text"
  ],
  "messageFlow": "text",
  "helpMessage": "text",
  "helpKeywords": "text",
  "optoutKeywords": "text",
  "optinKeywords": "text",
  "optinMessage": "text",
  "optoutMessage": "text",
  "termsAndConditions": true,
  "brandId": "123e4567-e89b-12d3-a456-426614174000",
  "resellerId": "text",
  "rejection": {
    "description": "text",
    "code": "text"
  },
  "attachments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "PENDING",
      "createdAt": "2026-02-19T21:01:32.489Z",
      "updatedAt": "2026-02-19T21:01:32.489Z",
      "filename": "attachment.txt",
      "mediaUrl": "https://example.com/attachment.txt",
      "contentType": "text/plain"
    }
  ],
  "createdAt": "2026-02-19T21:01:32.489Z",
  "updatedAt": "2026-02-19T21:01:32.489Z"
}