Update a Cloud App template

Use this endpoint to update a Cloud App template.

API at a glance

Description: This API updates a Cloud App template in your Blueshift account. Send only the fields you want to change.

Authentication & testing

Testing the API on this page

How to try it here

  • Use your User API Key as the Username (leave Password blank).
  • Select the appropriate API endpoint based on your Blueshift region.
  • API - Select Region
  • Enter the necessary parameters and click Try It to run the request.
Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.


Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.


Things to know before you start

  • API key: Use your User API key.
  • Partial update: Only the fields you send change. Fields you leave out keep their current values. This includes external_fetches, transaction_mixins and tag_data.
  • Replacing lists and tags: When you send external_fetches, transaction_mixins or tag_data, what you send replaces the current value. Send an empty array, or an empty tag_data string, to remove them all.
  • Auth token: Send a new value to replace the token, or *** to keep it. To remove authentication, send both auth_header and auth_token as empty strings.
  • Headers: When you send headers or content_metadata, what you send replaces the whole object. You can't change content_metadata on a quick start template.
  • Recommendations: account_algorithm_uuid must be an active recommendation scheme in your account. To set skip_on_all_blank_recommendation_blocks to true, also send skip_user_on_blank_products: false.
  • Cloud App connection: You can change account_app_profile_uuid, but you can't remove it.
  • Can't change: app_uuid, author. If you send them, they're ignored.
  • AI-generated templates: You can't update a template that was generated by AI. The API returns 403.
  • Same rules as create: The name must stay unique, content must be valid JSON with Liquid inside quotes, and auth_header and auth_token go together.
  • Not available through the API: deleting, previewing and test-sending a template. Use the Blueshift app for these.

Request parameters

Check out the request parameters

Path parameters

ParameterTypeRequiredDescription
template_uuidstring✅ YesThe UUID of the Cloud App template.

Body parameters

All body parameters are optional. They're the same as for Create a Cloud App template, except author and resource.app_uuid.

ParameterTypeDescription
namestringName of the template.
tag_datastringFolder and tags, in the format folder_name:tag1,tag2. Separate folders with |. The folder must already exist in your account. If the folder has a list of allowed tags, each tag must be on it. Otherwise, the API returns 422. Replaces all the template's tags. Folders you leave out are removed.
skip_user_on_external_fetch_errorbooleanIf true, Blueshift doesn't send the request for a customer when an external fetch fails.
external_fetchesarrayReplaces the template's external fetches. Objects with a uuid.
transaction_mixinsarrayReplaces the template's transaction mixins. Objects with a uuid.
template_propertiesobjectRecommendation settings. Keys you leave out keep their current values. Keys: account_algorithm_uuid (an active recommendation scheme in your account; null removes it), skip_user_on_blank_products (default true), skip_user_on_blank_event_products (default true) and skip_on_all_blank_recommendation_blocks (default false). skip_user_on_blank_products and skip_on_all_blank_recommendation_blocks can't both be true. Responses return this as an array.
resourceobjectAny of external_webhook_url, http_method, content, headers, auth_header, auth_token, account_app_profile_uuid, context, is_url_encoded_form, dedupe_field, use_json_editor, content_metadata.

Example requests & responses

Rename a template and change its request

Request

curl --request PUT \
     --url 'https://api.getblueshift.com/api/v1/webhook_templates/75f48ce5-7955-48d9-a06d-88732b1b079f.json' \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>' \
     --header 'content-type: application/json' \
     --data '{
       "name": "Order confirmation webhook v2",
       "resource": {
         "content": "{ \"email\": \"{{user.email}}\", \"src\": \"api\" }",
         "auth_header": "Authorization",
         "auth_token": "<YOUR_ENDPOINT_TOKEN>",
         "headers": {
           "X-Source": "blueshift"
         }
       }
     }'

Response

{
  "name": "Order confirmation webhook v2",
  "created_at": "2026-11-19T05:53:43.000Z",
  "updated_at": "2026-11-19T05:53:52.209Z",
  "uuid": "75f48ce5-7955-48d9-a06d-88732b1b079f",
  "skip_user_on_external_fetch_error": null,
  "archived": false,
  "author": "Jane Doe",
  "template_properties": [
    {
      "name": "products",
      "context": {
        "product_count": 20
      },
      "settings": {
        "product_count": 20
      },
      "skip_user_on_blank_products": true,
      "skip_user_on_blank_event_products": true,
      "skip_on_all_blank_recommendation_blocks": false,
      "account_algorithm_uuid": null
    }
  ],
  "tag_data": "",
  "external_fetches": [],
  "transaction_mixins": [],
  "resource": {
    "auth_header": "Authorization",
    "http_method": "POST",
    "external_webhook_url": "https://example.com/orders",
    "content": "{ \"email\": \"{{user.email}}\", \"src\": \"api\" }",
    "dedupe_field": null,
    "context": null,
    "is_url_encoded_form": false,
    "headers": {
      "X-Source": "blueshift"
    },
    "content_metadata": null,
    "use_json_editor": false,
    "auth_token": "***",
    "app_uuid": null,
    "account_app_profile_uuid": null,
    "app_name": null
  }
}
Content isn't valid JSON

Response (422)

{
  "errors": [
    {
      "title": "content",
      "detail": "Content: invalid JSON: not a number or other value at line 1, column 1 [parse.c:422]"
    }
  ],
  "meta": {
    "combine_errors": false,
    "no_toast": false,
    "unformatted": {
      "content": [
        "invalid JSON: not a number or other value at line 1, column 1 [parse.c:422]"
      ]
    }
  }
}
Template not found

Response (404)

{
  "message": "Not Found"
}
Path Params
string
required

Specify the UUID of the Cloud App template. You can copy the UUID from the URL of the template on the Blueshift app. For example, if you open a template in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/webhook_template/studio/<template_uuid>/edit/info.

Body Params
string
string

Folder and tags, in the format folder_name:tag1,tag2. Separate folders with |. The folder must already exist. On update, replaces all the template's tags.

boolean

If true, Blueshift doesn't send the request for a customer when an external fetch fails.

external_fetches
array of objects
external_fetches
transaction_mixins
array of objects
transaction_mixins
template_properties
object

Recommendation settings. Returned as an array in responses.

resource
object
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json