latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

templates

Update push template

post/api/templates/push/update

Request body

badgestring

Badge to set for push notification

cacheDataFeedboolean

Cache data feed lookups for 1 hour

campaignDataFieldsobject

Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name.

campaignIdobject

Campaign ID

clientTemplateIdstring

Client template ID. Used as a secondary key to reference the template

createdAtstring date-time

Date created [Read only]

dataFeedIdsnumber[]

Ids for data feeds used in template rendering

interruptionLevel'passive' | 'active' | 'time-sensitive' | 'critical'

An interruption level helps iOS determine when to alert a user about the arrival of a push notification

isDefaultLocaleboolean

Ask your Iterable CSM to enroll you in the beta for this feature.

Identifies if the locale associated with the response is the template's default. If empty or flexible default locales are not enabled for the project, the project's default locale is assigned.

isSilentPushboolean

Whether or not this is a silent push notification template

localestring

The locale for the content in this request. Leave empty for default locale. Iterable will automatically send the content with locale that matches a 'locale' field in the user profile.

mergeDataFeedContextboolean

Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]]

messagestring

Push message

messageTypeIdinteger

Message Type Id

namestring

Name of the template

payloadobject

Payload to send with push notification

relevanceScorenumber double

Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0

soundstring

Sound

templateIdinteger required

Push template ID

titlestring

Push message title

updatedAtstring date-time

Date last updated [Read only]

wakeboolean

Set the content-available flag on iOS notifications, which will wake the app in the background

Response

successful operation