Message Templates

Message Templates are referred to as channel templates through the API

Last updated 5 months ago

Was this helpful?

List channeltemplates in workspace

get

/workspaces/{workspaceId}/projects/{projectId}/channel-templates

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the project of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "defaultLocale": "en",
      "supportedPlatforms": [
        "all"
      ],
      "createdAt": "2025-02-21T18:13:51.526Z",
      "updatedAt": "2025-02-21T18:13:51.526Z",
      "isCloneable": true,
      "editorId": "123e4567-e89b-12d3-a456-426614174000",
      "editorType": "text",
      "publisherId": "123e4567-e89b-12d3-a456-426614174000",
      "publisherType": "text",
      "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
      "reviewInfo": {
        "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
        "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "pending",
        "currentStep": 1
      },
      "status": "draft",
      "assets": [
        {
          "isDefault": true,
          "valueString": "text",
          "key": "logoUrl"
        }
      ],
      "styles": [
        {
          "key": "text",
          "valueString": "text",
          "isDefault": true
        }
      ],
      "deployments": [
        {
          "value": "text",
          "locale": "text",
          "platform": "text",
          "key": "whatsappCategory",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "variables": [
        {
          "key": "text",
          "description": "text",
          "characterLimit": 1,
          "type": "string",
          "format": "none",
          "sourceUrl": {
            "fullyReplaced": true,
            "value": "text"
          },
          "examplesLocale": {
            "ANY_ADDITIONAL_PROPERTY": {
              "exampleValueStrings": [
                "text"
              ],
              "exampleValues": [
                {
                  "sections": [
                    {
                      "id": "text",
                      "multipleSelection": true,
                      "title": "text",
                      "items": [
                        {
                          "id": "text",
                          "reference": "text",
                          "role": "text",
                          "hidden": true,
                          "type": "reply-action",
                          "replyAction": {
                            "text": "text",
                            "imageUrl": "text",
                            "payload": "text"
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        }
      ],
      "genericContent": [
        {
          "locale": "en",
          "type": "text",
          "blocks": [
            {
              "id": "text",
              "reference": "text",
              "role": "text",
              "hidden": true,
              "type": "action",
              "action": {
                "type": "link",
                "id": "text",
                "reference": "text",
                "role": "text",
                "hidden": true,
                "link": {
                  "text": "text",
                  "url": "https://example.com"
                }
              }
            }
          ]
        }
      ],
      "platformContent": [
        {
          "locale": "en",
          "type": "text",
          "platform": "text",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "blocks": [
            {
              "id": "text",
              "reference": "text",
              "role": "text",
              "hidden": true,
              "type": "action",
              "action": {
                "type": "link",
                "id": "text",
                "reference": "text",
                "role": "text",
                "hidden": true,
                "link": {
                  "text": "text",
                  "url": "https://example.com"
                }
              }
            }
          ],
          "approvals": [
            {
              "approvalReference": "123e4567-e89b-12d3-a456-426614174000",
              "channelId": "123e4567-e89b-12d3-a456-426614174000",
              "platformReference": "text",
              "platformAccountIdentifier": "text",
              "reason": "text",
              "reasonDescription": "text",
              "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
              "platform": "whatsapp",
              "reasonCode": "whatsapp_scam",
              "status": "pending",
              "platformStatus": "whatsapp_approved",
              "channelIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          ]
        }
      ],
      "shortLinks": {}
    }
  ],
  "nextPageToken": "text"
}

Create channeltemplate

post

/workspaces/{workspaceId}/projects/{projectId}/channel-templates

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

Body

descriptionstring

supportedPlatformsstring · enum[] | nullable

assetsone of[] | nullable

stylesone of[] | nullable

variablesobject[] | nullable

deploymentsobject[] | nullable

genericContentobject[] | nullable

platformContentobject[] | nullable

shortLinksobject | nullable

defaultLocalestring

Other propertiesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"supportedPlatforms":["all"],"assets":[{"isDefault":true,"valueString":"text","key":"logoUrl"}],"styles":[{"key":"text","valueString":"text","isDefault":true}],"variables":[{"key":"text","type":"string","format":"none","sourceUrl":{"fullyReplaced":true,"value":"text"},"examplesLocale":{"ANY_ADDITIONAL_PROPERTY":{"exampleValueStrings":["text"],"exampleValues":[{"sections":[{"id":"text","multipleSelection":true,"title":"text","items":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"reply-action","replyAction":{"text":"text","imageUrl":"text","payload":"text"}}]}]}]}}}],"deployments":[{"value":"text","key":"whatsappCategory","channelIds":[null]}],"genericContent":[{"locale":"en","blocks":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"action","action":{"type":"link","id":"text","reference":"text","role":"text","hidden":true,"link":{"text":"text","url":"https://example.com"}}}]}],"platformContent":[{"locale":"en","platform":"text","channelIds":[null],"channelGroupIds":[null],"blocks":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"action","action":{"type":"link","id":"text","reference":"text","role":"text","hidden":true,"link":{"text":"text","url":"https://example.com"}}}],"approvals":[{"approvalReference":"123e4567-e89b-12d3-a456-426614174000","channelId":"123e4567-e89b-12d3-a456-426614174000","platformReference":"text","platformAccountIdentifier":"text","reason":"text","reasonDescription":"text","channelGroupId":"123e4567-e89b-12d3-a456-426614174000","platform":"whatsapp","reasonCode":"whatsapp_scam","status":"pending","platformStatus":"whatsapp_approved","channelIds":["123e4567-e89b-12d3-a456-426614174000"]}]}],"shortLinks":{},"defaultLocale":"text","ANY_ADDITIONAL_PROPERTY":"anything"}'

201

400

404

409

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "defaultLocale": "en",
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-02-21T18:13:51.526Z",
  "updatedAt": "2025-02-21T18:13:51.526Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  },
  "status": "draft",
  "assets": [
    {
      "isDefault": true,
      "valueString": "text",
      "key": "logoUrl"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "value": "text",
      "locale": "text",
      "platform": "text",
      "key": "whatsappCategory",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "characterLimit": 1,
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "type": "reply-action",
                      "replyAction": {
                        "text": "text",
                        "imageUrl": "text",
                        "payload": "text"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "en",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ],
      "approvals": [
        {
          "approvalReference": "123e4567-e89b-12d3-a456-426614174000",
          "channelId": "123e4567-e89b-12d3-a456-426614174000",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reason": "text",
          "reasonDescription": "text",
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp",
          "reasonCode": "whatsapp_scam",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "shortLinks": {}
}

Created

Get ChannelTemplate

get

/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

channelTemplateIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}' \
  --header 'Authorization: Bearer jwt'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "defaultLocale": "en",
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-02-21T18:13:51.526Z",
  "updatedAt": "2025-02-21T18:13:51.526Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  },
  "status": "draft",
  "assets": [
    {
      "isDefault": true,
      "valueString": "text",
      "key": "logoUrl"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "value": "text",
      "locale": "text",
      "platform": "text",
      "key": "whatsappCategory",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "characterLimit": 1,
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "type": "reply-action",
                      "replyAction": {
                        "text": "text",
                        "imageUrl": "text",
                        "payload": "text"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "en",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ],
      "approvals": [
        {
          "approvalReference": "123e4567-e89b-12d3-a456-426614174000",
          "channelId": "123e4567-e89b-12d3-a456-426614174000",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reason": "text",
          "reasonDescription": "text",
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp",
          "reasonCode": "whatsapp_scam",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "shortLinks": {}
}

Delete ChannelTemplate

delete

/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

channelTemplateIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}' \
  --header 'Authorization: Bearer jwt'

204

404

409

No body

Deleted

Update ChannelTemplate

patch

/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

channelTemplateIdstringrequired

Body

descriptionstring

supportedPlatformsstring · enum[] | nullable

forceUpdateboolean

If true and template is already published, a new template will be created with the new parameters and activated.

statusstring · enum | nullable

Options: active, inactive, pending, draft, pendingReview

assetsone of[] | nullable

stylesone of[] | nullable

variablesobject[] | nullable

deploymentsobject[] | nullable

genericContentobject[] | nullable

platformContentobject[] | nullable

defaultLocalestring | nullable

Other propertiesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"supportedPlatforms":["all"],"status":"active","assets":[{"isDefault":true,"valueString":"text","key":"logoUrl"}],"styles":[{"key":"text","valueString":"text","isDefault":true}],"variables":[{"key":"text","type":"string","format":"none","sourceUrl":{"fullyReplaced":true,"value":"text"},"examplesLocale":{"ANY_ADDITIONAL_PROPERTY":{"exampleValueStrings":["text"],"exampleValues":[{"sections":[{"id":"text","multipleSelection":true,"title":"text","items":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"reply-action","replyAction":{"text":"text","imageUrl":"text","payload":"text"}}]}]}]}}}],"deployments":[{"value":"text","key":"whatsappCategory","channelIds":[null]}],"genericContent":[{"locale":"en","blocks":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"action","action":{"type":"link","id":"text","reference":"text","role":"text","hidden":true,"link":{"text":"text","url":"https://example.com"}}}]}],"platformContent":[{"locale":"en","platform":"text","channelIds":[null],"channelGroupIds":[null],"blocks":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"action","action":{"type":"link","id":"text","reference":"text","role":"text","hidden":true,"link":{"text":"text","url":"https://example.com"}}}],"approvals":[{"approvalReference":"123e4567-e89b-12d3-a456-426614174000","channelId":"123e4567-e89b-12d3-a456-426614174000","platformReference":"text","platformAccountIdentifier":"text","reason":"text","reasonDescription":"text","channelGroupId":"123e4567-e89b-12d3-a456-426614174000","platform":"whatsapp","reasonCode":"whatsapp_scam","status":"pending","platformStatus":"whatsapp_approved","channelIds":["123e4567-e89b-12d3-a456-426614174000"]}]}],"defaultLocale":"text","ANY_ADDITIONAL_PROPERTY":"anything"}'

200

400

404

409

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "defaultLocale": "en",
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-02-21T18:13:51.526Z",
  "updatedAt": "2025-02-21T18:13:51.526Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  },
  "status": "draft",
  "assets": [
    {
      "isDefault": true,
      "valueString": "text",
      "key": "logoUrl"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "value": "text",
      "locale": "text",
      "platform": "text",
      "key": "whatsappCategory",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "characterLimit": 1,
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "type": "reply-action",
                      "replyAction": {
                        "text": "text",
                        "imageUrl": "text",
                        "payload": "text"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "en",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": true,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": true,
            "link": {
              "text": "text",
              "url": "https://example.com"
            }
          }
        }
      ],
      "approvals": [
        {
          "approvalReference": "123e4567-e89b-12d3-a456-426614174000",
          "channelId": "123e4567-e89b-12d3-a456-426614174000",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reason": "text",
          "reasonDescription": "text",
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp",
          "reasonCode": "whatsapp_scam",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "shortLinks": {}
}

Updated

Activate ChannelTemplate

put

/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

channelTemplateIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate' \
  --header 'Authorization: Bearer jwt'

200

404

422

No body

Activated

Deactivate ChannelTemplate

put

/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/deactivate

Authorizations

Path parameters

workspaceIdstringrequired

projectIdstringrequired

channelTemplateIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/deactivate' \
  --header 'Authorization: Bearer jwt'

200

404

422

No body

Deactivated

Create ChannelTemplate Preview

post

/workspaces/{workspaceId}/projects/channel-templates/create-preview

Authorizations

Path parameters

workspaceIdstringrequired

Body

platformstring · min: 1

contactIdstring | nullable

blocksobject[]

stylesone of[] | nullable

variablesobject | nullable

parametersobject[] · min: 1 | nullable

shortLinksobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/projects/channel-templates/create-preview' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"blocks":[{"id":"text","reference":"text","role":"text","hidden":true,"type":"action","action":{"type":"link","id":"text","reference":"text","role":"text","hidden":true,"link":{"text":"text","url":"https://example.com"}}}],"styles":[{"key":"text","valueString":"text","isDefault":true}],"variables":{},"parameters":[{"sourceUrl":{"fullyReplaced":true,"value":"text"},"type":"string"}],"shortLinks":{}}'

200

404

422

{
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true
        }
      ],
      "metadata": {
        "subject": "text",
        "telegram": {
          "parseMode": "Markdown"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        }
      }
    }
  },
  "type": "body",
  "blocks": [
    {
      "id": "text",
      "reference": "text",
      "role": "text",
      "hidden": true,
      "type": "action",
      "action": {
        "type": "link",
        "id": "text",
        "reference": "text",
        "role": "text",
        "hidden": true,
        "link": {
          "text": "text",
          "url": "https://example.com"
        }
      }
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "validationErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}