Message Templates

Message Templates are referred to as channel templates through the API

List channeltemplates in workspace

get

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

Query parameters

metricsbooleanOptional

Include metrics in the response

Default: false

limitinteger · min: 1 · max: 100Optional

Limits the project of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

Responseall of

404

Project or workspace not found

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/projects/{projectId}/channel-templates HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "draft",
      "localeStatuses": {
        "ANY_ADDITIONAL_PROPERTY": "draft"
      },
      "description": "text",
      "defaultLocale": "en",
      "assets": [
        {
          "key": "logoUrl",
          "isDefault": true,
          "valueString": "text"
        }
      ],
      "styles": [
        {
          "key": "text",
          "valueString": "text",
          "isDefault": true
        }
      ],
      "deployments": [
        {
          "key": "whatsappCategory",
          "value": "text",
          "locale": "text",
          "platform": "text"
        }
      ],
      "variables": [
        {
          "key": "text",
          "description": "text",
          "type": "string",
          "format": "none",
          "sourceUrl": {
            "fullyReplaced": true,
            "value": "text"
          },
          "characterLimit": 1,
          "examplesLocale": {
            "ANY_ADDITIONAL_PROPERTY": {
              "exampleValueStrings": [
                "text"
              ],
              "exampleValues": [
                {
                  "sections": [
                    {
                      "id": "text",
                      "multipleSelection": true,
                      "title": "text",
                      "items": [
                        {
                          "id": "text",
                          "type": "reply-action",
                          "reference": "text",
                          "role": "text",
                          "hidden": true,
                          "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",
              "platformReference": "text",
              "platformAccountIdentifier": "text",
              "reasonCode": "whatsapp_scam",
              "reasonDescription": "text",
              "status": "pending",
              "platformStatus": "whatsapp_approved",
              "channelIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ],
              "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
              "platform": "whatsapp"
            }
          ]
        }
      ],
      "supportedPlatforms": [
        "all"
      ],
      "createdAt": "2025-07-05T18:04:47.120Z",
      "updatedAt": "2025-07-05T18:04:47.120Z",
      "isCloneable": true,
      "editorId": "123e4567-e89b-12d3-a456-426614174000",
      "editorType": "text",
      "publisherId": "123e4567-e89b-12d3-a456-426614174000",
      "publisherType": "text",
      "shortLinks": {},
      "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
      "metrics": {},
      "reviewInfo": {
        "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
        "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "pending",
        "currentStep": 1
      }
    }
  ],
  "nextPageToken": "text"
}

Create channeltemplate

post

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

Query parameters

metricsbooleanOptional

Include metrics in the response

Default: false

Body

descriptionstringOptional

defaultLocaleall ofOptional

string · enumOptionalExample: enPossible values:

shortLinksobject | nullableOptional

Other propertiesanyOptional

Responses

201

Created

application/json

400

Default locale must exist in the content property

application/json

404

Workspace not found

application/json

409

Duplicate channeltemplate

application/json

422

Invalid channeltemplate

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/projects/{projectId}/channel-templates HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 1881

{
  "description": "text",
  "defaultLocale": "text",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": true,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "characterLimit": 1,
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "type": "reply-action",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "replyAction": {
                        "text": "text",
                        "imageUrl": "text",
                        "payload": "text"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "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",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reasonCode": "whatsapp_scam",
          "reasonDescription": "text",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp"
        }
      ]
    }
  ],
  "supportedPlatforms": [
    "all"
  ],
  "shortLinks": {},
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "localeStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "draft"
  },
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": true,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "characterLimit": 1,
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "type": "reply-action",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "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",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reasonCode": "whatsapp_scam",
          "reasonDescription": "text",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp"
        }
      ]
    }
  ],
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-07-05T18:04:47.120Z",
  "updatedAt": "2025-07-05T18:04:47.120Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "shortLinks": {},
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metrics": {},
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  }
}

Get ChannelTemplate

get

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

OK

application/json

404

Project, channeltemplate or workspace not found

application/json

422

No active channeltemplate marked as latest

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "localeStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "draft"
  },
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": true,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "characterLimit": 1,
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "type": "reply-action",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "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",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reasonCode": "whatsapp_scam",
          "reasonDescription": "text",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp"
        }
      ]
    }
  ],
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-07-05T18:04:47.120Z",
  "updatedAt": "2025-07-05T18:04:47.120Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "shortLinks": {},
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metrics": {},
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  }
}

Delete ChannelTemplate

delete

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

channelTemplateIdstringRequired

Responses

204

Deleted

404

Project, channeltemplate or workspace not found

application/json

409

Failed to delete channeltemplate

application/json

delete

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Update ChannelTemplate

patch

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

channelTemplateIdstringRequired

Body

defaultLocaleall of | nullableOptional

string · enumOptionalExample: enPossible values:

descriptionstringOptional

forceUpdatebooleanOptional

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

statusstring · enum | nullableOptionalPossible values:

Other propertiesanyOptional

Responses

200

Updated

application/json

400

Default locale must exist in the content property

application/json

404

ChannelTemplate not found

application/json

409

Status of channeltemplate is not draft

application/json

422

Invalid project

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 1902

{
  "defaultLocale": "text",
  "description": "text",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": true,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "characterLimit": 1,
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "type": "reply-action",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "replyAction": {
                        "text": "text",
                        "imageUrl": "text",
                        "payload": "text"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "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",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reasonCode": "whatsapp_scam",
          "reasonDescription": "text",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp"
        }
      ]
    }
  ],
  "supportedPlatforms": [
    "all"
  ],
  "forceUpdate": true,
  "status": "active",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "localeStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "draft"
  },
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": true,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "characterLimit": 1,
      "examplesLocale": {
        "ANY_ADDITIONAL_PROPERTY": {
          "exampleValueStrings": [
            "text"
          ],
          "exampleValues": [
            {
              "sections": [
                {
                  "id": "text",
                  "multipleSelection": true,
                  "title": "text",
                  "items": [
                    {
                      "id": "text",
                      "type": "reply-action",
                      "reference": "text",
                      "role": "text",
                      "hidden": true,
                      "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",
          "platformReference": "text",
          "platformAccountIdentifier": "text",
          "reasonCode": "whatsapp_scam",
          "reasonDescription": "text",
          "status": "pending",
          "platformStatus": "whatsapp_approved",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "platform": "whatsapp"
        }
      ]
    }
  ],
  "supportedPlatforms": [
    "all"
  ],
  "createdAt": "2025-07-05T18:04:47.120Z",
  "updatedAt": "2025-07-05T18:04:47.120Z",
  "isCloneable": true,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "editorType": "text",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherType": "text",
  "shortLinks": {},
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metrics": {},
  "reviewInfo": {
    "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "approvalRunId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "currentStep": 1
  }
}

Activate ChannelTemplate

put

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

Activated

404

Project, channeltemplate or workspace not found

application/json

422

Failed to activate channeltemplate

application/json

put

HTTPcURLJavaScriptPython

PUT /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Deactivate ChannelTemplate

put

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

Deactivated

404

Project, channeltemplate or workspace not found

application/json

422

Failed to deactivate channeltemplate

application/json

put

HTTPcURLJavaScriptPython

PUT /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/deactivate HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Create ChannelTemplate Preview

post

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

Body

platformstring · min: 1Optional

blocksall of[]Optional

and

one ofOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

shortLinksobject | nullableOptional

contactIdstring | nullableOptional

Responses

200

OK

application/json

404

Workspace not found

application/json

422

Invalid request

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/projects/channel-templates/create-preview HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 499

{
  "platform": "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"
        }
      }
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "parameters": [
    {
      "type": "string",
      "sourceUrl": {
        "fullyReplaced": true,
        "value": "text"
      },
      "key": "text",
      "value": "text"
    }
  ],
  "shortLinks": {},
  "contactId": "text"
}

{
  "validationErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "type": "body",
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true,
          "contentId": "text"
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "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
    }
  ]
}