Create email template

post

https://api.getblueshift.com/api/v1/email_templates.json

Use this endpoint to create an email template.

Body Params

Takes the template details returns a JSON that provides the UUID of the created template.

name

string

required

Specify the name for the template.

author

string

Specify the email address of the template's author.

resource

object

required

skip_user_on_external_fetch_error

boolean

required

Defaults to true

Message is not sent to user if the external fetch encounters an error or does not return any data)

template_properties

array of objects

required

length ≤ 1

Specify the campaign behavior properties for the template.

template_properties*

external_fetches

array of objects

Specify the external fetches for the template.

external_fetches

transaction_mixins

array of objects

Specify the transaction mixins for the template. Note that when you add multiple transaction mixins, the resultant transactions are the OR result of all the queries related to the transactions mixins. For example, the resultant JSON response will contain any transaction that meets EITHER the transaction_mixin1 criteria OR the transaction_mixin2 criteria (or both).

transaction_mixins

tag_data

string

Specify a folder and then tags under the folder in the format folder_name: tag1, tag2, tag3. For example, Regions:USA,China,Brazil,Hong Kong,India,Sweden,Canada.

📘 Tag data should exist in your account.

Responses

200

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request - The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

404Not Found - The requested resource was not found.

422Unprocessable Entity - The request was well-formed but contains semantic errors.

429Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502Bad Gateway - The server received an invalid response. Retry the request.

503Service Unavailable - The service is temporarily unavailable. Try again later.

504Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.