latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

templates

Update in-app template

post/api/templates/inapp/update

Request body

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.

campaignIdinteger

Campaign ID

clientTemplateIdstring

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

expirationDateTimestring date-time

The in-app message's absolute expiration time. If set to a time before the campaign sends, contacts will never see the message. Format is <code>YYYY-MM-DD HH:MM:SS</code> (UTC timestamp, time zones not allowed). Default expiration is 90 days after send time. For more information, read <a href="https://support.iterable.com/hc/articles/360044425951">Creating In-App Templates</a>.

expirationDurationstring

The in-app message's expiration time, relative to its send time. Should be an expression such as <code>now+90d</code>. Default expiration is 90 days after send time. For more information, read <a href="https://support.iterable.com/hc/articles/360044425951">Creating In-App Templates</a>.

htmlstring

Html of the in-app 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.

localestring

The locale for the content in this request. Leave empty for default locale. Iterable automatically sends the content with a locale that matches a user profile's <code>locale</code> field.

messageTypeIdinteger

Message Type Id

namestring

Name of the template

payloadobject

Payload

templateIdinteger required

In-app template ID

Response

successful operation