Create bulk send audience

Upload a CSV to obtain a bulk_id for sending messages. The CSV can contain:

Channel IDs for Upload and Send endpoints: Send message with bulk ID or Schedule message with bulk ID
Email addresses, phone numbers, or open channel addresses for Create and Send endpoints: Create and Send a message or Schedule a Create and Send message

See Bulk sending for CSV formatting requirements.

post/api/bulk/{platform_name}

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/bulk/:platform_name/post.ts
A function with typed inputs. Its response is checked against the schema.

string required

A CSV of channel IDs, email addresses, MSISDNs, or open channel addresses. See Bulk sending for CSV formatting requirements.

The CSV was uploaded successfully and is now being processed.

bulk_idstring uuid

A unique string that identifies the audience provided in the CSV for bulk sending.

field_namesstring[]

A list of the field names found in the CSV.

okboolean

Success.

{
  "bulk_id": "ef625038-70a3-41f1-826f-57bc11dd625a"
}