ITiterable
templates

Create an embedded message template

Create an embedded message template if it doesn't exist yet, otherwise update all embedded message templates that match the name provided.

post/api/templates/embedded/upsert

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

bodystring

Body text of the embedded message

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.

clientTemplateIdstring required

ID used by the client to identify a template. If multiple templates exist with the ID, all will be updated

creatorUserIdstring

Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.

isDefaultLocaleboolean

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

Sets the locale associated with the request content as 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 will automatically send the content with locale that matches a 'locale' field in the user profile.

messageTypeIdinteger

Message type ID

namestring

Name of the template

placementIdobject

Placement ID that this template is associated with

titlestring

Title of the embedded message

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

No recorded changes to this operation across all 4 revisions of this API.