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

# Create a broadcast

`POST /companies/{company_key}/mobiledb/broadcasts/`

## Path parameters

- `company_key` string, required

## Headers

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

## Request body

- BroadcastRequest
  - `name` string, required — The name of the campaign.
  - `send_scheduled_date` string, required — The date and time the campaign is scheduled to send in ISO-8601 format.
  - `send_schedule` object — <b>Optional</b>. Include if you would like to schedule the message to be sent by time zone.
    - `method` string — To send by timezone, use by_time_zone. Defaults to by_date.
    - `send_date` string
    - `send_time` string — Use a 24-hour clock in HH:MM format.
    - `field_name` string — If you are sending the broadcast by time zone, use this field to indicate the name of the custom field used to collect users’ time zones.
    - `default_time_zone` string — Use the zone's IANA Time Zone Database identifier. See a list of TZ identifiers <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target=”_blank”>here</a>.
  - `targeting` object
    - `message_template` string, required — Text of your message, including custom fields or incentive tags.
    - `short_url_base` string — Base URL to use when shortening URLs, if a <a href="https://developer-platform.vibes.com/docs/creating-a-custom-short-domain" target="_blank">custom short domain</a> is being used.
    - `shorten_urls` boolean — Should URLs be shortened?
    - `channel` 'SMS' | 'Push' — Message channel for broadcast.
    - `source_short_code` object — Code the broadcast will be delivered on (if SMS or MMS).
      - `short_code` string
      - `country_code` string
      - `source_type` string — SC for short or long numeric codes; ANC for alphanumeric codes.
    - `source_lists` string[], required — Insert ids of the subscription lists being targeted in this broadcast.
    - `filters` object[] — Filters used to target recipients.
      - `name` string — Name of filter
      - `selector` string
      - `value` string[] — Add each value in its own string

## 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.
    - `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

- `201` — Broadcast has been created.

---

[API](https://skmtc.net/vibes/apis/vibes-platform-api.md) · [All operations](https://skmtc.net/vibes/apis/vibes-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vibes/vibes-platform-api/revisions/2d5797ce1b84/schema)