---
title: "Cancel a broadcast"
method: DELETE
path: "/companies/{company_key}/mobiledb/broadcasts/{broadcast_id}"
tags: ["Broadcast API"]
---

# Cancel a broadcast

`DELETE /companies/{company_key}/mobiledb/broadcasts/{broadcast_id}`

## Request

- Base URL: `https://public-api.vibescm.com`
- URL: `https://public-api.vibescm.com/companies/{company_key}/mobiledb/broadcasts/{broadcast_id}`
- Auth: HTTP basic

## Path parameters

- `company_key` string, required
- `broadcast_id` string, required

## Headers

- `X-API-Version` string
- `Content-Type` string, required

## Response `200`

Successful response

- BroadcastResponse
  - `broadcast_id` string: Vibes unique identifier for the broadcast.
  - `status` 'scheduled' | 'in_progress' | 'sent' | 'canceled' | 'deleted' | 'paused' | 'failed': The status of the broadcast.
  - `name` string: The name of the campaign.
  - `send_scheduled_date` string: The date the campaign is scheduled to send.
  - `created_by` string: The user that created the campaign.
  - `created_by_application` string: The application that created the campaign, if applicable.
  - `targeting` object
    - `message_template` string: Body of the broadcast message.
    - `short_url_base` string: Base URL to use when shortening URLs.
    - `shorten_urls` boolean: Should URLs be shortened?
    - `channel` string: Message channel for broadcast.
    - `source_short_code` string: Short code the broadcast will be delviered on (if SMS or MMS).
    - `source_lists` string[]
    - `filters` object[]: Any filters used to target recipients.
    - `mms` MmsPayload: MMS content for the broadcast. Only text-only MMS is supported; media cannot be uploaded through the API. Requires a source code that is enabled for MMS.
      - `subject` string: Subject line of the MMS, including custom fields or incentive tags. Cannot be an empty string.
      - `content` object[]: The message content. Provide a single text element.
        - `body` string: Text of the message, including custom fields or incentive tags.
        - `mime_type` 'text/plain': Must be `text/plain`.
    - `rcs` RcsPayload: RCS content for the broadcast. Requires a source code that is enabled for RCS. Include `message_template` (SMS) or `mms` alongside `rcs` to provide fallback content for recipients who cannot receive RCS.
      - `content_message` RcsContentMessage: The RCS message. Provide exactly one of `text` or `rich_card`.
        - `text` string: Plain text of the message, including custom fields or incentive tags. Maximum 3072 characters.
        - `rich_card` RcsRichCard: A rich card. Provide exactly one of `standalone_card` or `carousel_card`.
          - `standalone_card` RcsStandaloneCard
            - `card_orientation` 'CARD_ORIENTATION_UNSPECIFIED' | 'HORIZONTAL' | 'VERTICAL': Orientation of the card.
            - `thumbnail_image_alignment` 'THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED' | 'LEFT' | 'RIGHT': Required when `card_orientation` is `HORIZONTAL`, and not allowed otherwise.
            - `card_content` RcsCardContent: Content of a card. At least one of `title`, `description`, or `media` is required.
              - …
          - `carousel_card` RcsCarouselCard
            - `card_width` 'CARD_WIDTH_UNSPECIFIED' | 'SMALL' | 'MEDIUM': Width of the cards in the carousel. Media with a `height` of `TALL` is not supported when this is `SMALL`.
            - `card_contents` RcsCardContent[]: The cards in the carousel. Between 2 and 10.
              - …
        - `suggestions` RcsSuggestion[]: Suggested replies and actions shown below the message. Maximum 11.
          - `reply` RcsSuggestedReply
            - `text` string: Text of the reply chip. Maximum 25 characters.
            - `postback_data` string: A JSON object, as a string, returned to you when the recipient taps the reply. Defaults to `{}`. Maximum 2048 characters.
          - `action` RcsSuggestedAction: A suggested action. Provide exactly one of `open_url_action`, `dial_action`, `view_location_action`, or `create_calendar_event_action`.
            - `text` string: Text of the action chip. Maximum 25 characters.
            - `postback_data` string: A JSON object, as a string, returned to you when the recipient taps the action. Defaults to `{}`. Maximum 2048 characters.
            - `fallback_url` string: An `http` or `https` URL opened if the recipient's device does not support the action.
            - `open_url_action` object
              - …
            - `dial_action` object
              - …
            - `view_location_action` object
              - …
            - `create_calendar_event_action` object
              - …
    - `delivery` object
      - `send_start_date` string: Date the broadcast started.
      - `enqueue_completed_date` string: Date the final message was queued for delivery.
      - `recipient_count` integer: Number of recipients.
    - `url` string: Unique resource URL for the Broadcast Campaign.
    - `created_at` string: Date that the broadcast campaign was created in ISO-8601 format.
    - `updated_at` string: Date that the broadcast campaign was last updated in ISO-8601 format.

## Other responses

- `403`: Returned if the broadcast cannot be canceled because it has already been sent.
- `404`: The `broadcast_id` cannot be found.

## Changes

- **2026-11-03** `e235838f2e50`: 2 info
  - added the optional property `targeting/mms` to the response with the `200` status
  - added the optional property `targeting/rcs` to the response with the `200` status

[Operation history](https://skmtc.dev/vibes/apis/vibes-platform-api/changes/companies/:company_key/mobiledb/broadcasts/:broadcast_id/delete.md)

---

[API](https://skmtc.dev/vibes/apis/vibes-platform-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-platform-api/revisions/e235838f2e50?raw)