HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update Campaign Message

Update a campaign message

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
campaigns:write

Path Params
string
required

The message ID to be retrieved

Body Params

Update a message and return it

object
required
string
required
string
required

The message ID to be retrieved

object
required

The contents and settings of the campaign message

string
required
string

The type of notification to send

object

Additional attributes relating to the content of the message

string

The title of the message

string

The message body

string

The dynamic image to be used in the push notification

object

Additional device specific options for the push notification

string
required
string
string

Only supported on iOS.

required

Whether to display a badge on the app icon

boolean
Defaults to false

Only supported on iOS.

object
object
object
string
required
string
required

The associated image for mobile_push messages

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials