alert

Body Params
int32

ID of the user receiving the alert, must be an active user

int32
Defaults to null

When a super user sends a global alert the account_id can be specified or can be set to all to send the alert to all users in all accounts.

string
required

Subject of the alert, <100 chars

string
required

Content of the alert

string

If the alert refers to an object, such as a Creative, you can specify the type and ID (below) to allow for deep linking into an application. Must be a valid object_type. A list of object_types can be found using the "view_name":"object_type"

int32

The object_id to link to if the object_type is specified.

boolean
Defaults to false

When set, sends the alert to all users within the account

string

A string representing an icon or emoji to associate with the alert. e.g. :POOP:

string
required

Sender of the alert. Can be a name or an email address.

boolean
Defaults to true

Is the alert unread (1) or read (0)

Responses

Language
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json