Post Announcement

Posts an Annonucement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request data for posting an announcement

string
required

String, required, one of everyone, program_access, default_location

programs
array of objects
required

List of programs, required when targeting_method is program_access, ignored when everyone

programs*
locations
array of objects
required

List of locations, required when targeting_method is default_location, ignored when everyone

locations*
string
required

String, required, max 1,000 characters, matching the UI's character counter. Accepts the rich text the UI editor produces (bold, italic, underline, lists, indents, color, links). Note: dev to define the accepted format (HTML subset, sanitized) and whether the 1,000 count includes markup. The UI counter appears to count visible characters only

date
required

Date, required

date
required

Date, required

boolean

Boolean, optional, default true, matching the UI's "Publish externally?" toggle

boolean

Boolean, optional, default false

string

String, required when enable_push_notification is true, one of now, scheduled

date

Date, required when push_send_method is scheduled

string

Time, required when push_send_method is scheduled

Headers
string
required

A valid API key. If you don't have one, please request one through the Automations → Integrations page.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json