Message Templates

Message Templates are referred to as channel templates through the API

List channeltemplates in workspace

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of ChannelTemplate (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "draft",
      "description": "text",
      "defaultLocale": "en",
      "assets": [
        {
          "key": "logoUrl",
          "isDefault": false,
          "valueString": "text"
        }
      ],
      "styles": [
        {
          "key": "text",
          "valueString": "text",
          "isDefault": false
        }
      ],
      "deployments": [
        {
          "key": "whatsappCategory",
          "value": "text",
          "locale": "text",
          "platform": "text"
        }
      ],
      "variables": [
        {
          "key": "text",
          "description": "text",
          "type": "string",
          "format": "none",
          "sourceUrl": {
            "fullyReplaced": false,
            "value": "text"
          }
        }
      ],
      "genericContent": [
        {
          "locale": "en",
          "type": "text",
          "blocks": [
            {
              "id": "text",
              "reference": "text",
              "role": "text",
              "hidden": false,
              "type": "action",
              "action": {
                "type": "link",
                "id": "text",
                "reference": "text",
                "role": "text",
                "hidden": false,
                "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": false,
              "type": "action",
              "action": {
                "type": "link",
                "id": "text",
                "reference": "text",
                "role": "text",
                "hidden": false,
                "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": "2024-11-21T08:58:55.100Z",
      "updatedAt": "2024-11-21T08:58:55.100Z",
      "isCloneable": false,
      "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": 0
      }
    }
  ],
  "nextPageToken": "text"
}

Create channeltemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

Body

application/json

descriptionstring

defaultLocalestring

assetsnullable array of Asset (one of)

stylesnullable array of Style (one of)

variablesnullable array of Variables-2 (object)

deploymentsnullable array of Deployment (object)

genericContentnullable array of GenericContent (object)

platformContentnullable array of PlatformContent (object)

supportedPlatformsnullable PlatformList (array of enum)

shortLinksnullable object

Other propertiesany

Response

201400404409422

Created

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivependingpendingReview

descriptionstring

defaultLocaleLocaleEnum (enum)

Example: "en"

ae-AZafarar-AZar-EGar-IDar-UAazaz-AZbgbg-BGbnbn-MYbn-SGcacscs-CZdada-DKdede-ATde-CHde-DEde-LIde-LUee-GHelel-CYel-GRenen-AEen-AFen-AGen-ALen-ARen-ASen-ATen-AUen-AWen-AZen-BAen-BBen-BDen-BEen-BFen-BGen-BHen-BJen-BNen-BOen-BRen-BSen-BWen-BYen-BZen-CAen-CDen-CGen-CHen-CIen-CLen-CMen-CNen-COen-CYen-CZen-DEen-DKen-DMen-DOen-ECen-EGen-ESen-FIen-FJen-FRen-GBen-GDen-GEen-GHen-GIen-GMen-GRen-GYen-HKen-HRen-HTen-HUen-IDen-IEen-ILen-INen-IQen-ISen-ITen-JMen-JOen-JPen-KEen-KHen-KNen-KRen-KWen-KYen-KZen-LAen-LBen-LTen-LVen-MDen-MKen-MMen-MSen-MTen-MVen-MXen-MYen-NGen-NLen-NOen-NPen-NZen-OMen-PAen-PEen-PGen-PHen-PKen-PLen-PSen-PTen-PYen-QAen-ROen-RUen-RWen-SAen-SBen-SDen-SEen-SGen-SIen-SKen-SNen-SRen-SSen-TCen-THen-TNen-TOen-TRen-TTen-TWen-UGen-USen-UYen-VCen-VEen-VGen-VNen-WSen-YEen-ZAen-ZWeses-ARes-BOes-BRes-CLes-COes-CRes-DOes-ECes-ESes-GTes-HNes-MXes-NIes-PAes-PEes-PYes-SVes-USes-UYes-VEetet-EEfafifi-FIfilfrfr-AEfr-BEfr-BFfr-BJfr-CAfr-CDfr-CGfr-CHfr-CIfr-CMfr-FRfr-GAfr-GFfr-LUfr-MAfr-MFfr-MGfr-MLfr-NLfr-PTfr-SNfr-TGgaguhahehihi-MYhi-SGhrhr-HRht-DOhuhu-HUidid-HKid-IDid-JPid-SGitit-AEit-BEit-CHit-ITjaja-JPkakkknkoky-KGloltlt-LTlvlv-LVmkmlmrmsms-MYmy-JPmy-MYmy-SGnbne-JPnlnl-BEnl-NLno-NOpaplpl-PLptpt-AOpt-BRpt-PTroro-MDro-ROruru-BYru-KZru-ROru-RUrw-RWsksk-SKslsl-SIsqsq-ALsrsr-RSsvsv-SEswtata-MYta-SGtethth-SGth-THtk-TMtrtr-TRukuk-UAuruzuz-UZvivi-JPvi-MYvi-USzh-CNzh-HKzh-JPzh-SGzh-TWzu

assetsarray of Asset (one of)

stylesarray of Style (one of)

deploymentsarray of Deployment (object)

variablesarray of Variables-2 (object)

genericContentarray of GenericContent (object)

platformContentarray of PlatformContent (object)

supportedPlatformsnullable PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

editorTypestring

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

publisherTypestring (string)

shortLinksnullable object

clonedFromnullable string (uuid)

The ID of the template that this template was cloned from. This field is only present if this template was cloned from another template.

reviewInfoReviewInfo (object)

Describe the status of an entity that is being reviewed through approval flows.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": false,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": false
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": false,
        "value": "text"
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": "2024-11-21T08:58:55.100Z",
  "updatedAt": "2024-11-21T08:58:55.100Z",
  "isCloneable": false,
  "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": 0
  }
}

Get ChannelTemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

200404422

OK

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivependingpendingReview

descriptionstring

defaultLocaleLocaleEnum (enum)

Example: "en"

ae-AZafarar-AZar-EGar-IDar-UAazaz-AZbgbg-BGbnbn-MYbn-SGcacscs-CZdada-DKdede-ATde-CHde-DEde-LIde-LUee-GHelel-CYel-GRenen-AEen-AFen-AGen-ALen-ARen-ASen-ATen-AUen-AWen-AZen-BAen-BBen-BDen-BEen-BFen-BGen-BHen-BJen-BNen-BOen-BRen-BSen-BWen-BYen-BZen-CAen-CDen-CGen-CHen-CIen-CLen-CMen-CNen-COen-CYen-CZen-DEen-DKen-DMen-DOen-ECen-EGen-ESen-FIen-FJen-FRen-GBen-GDen-GEen-GHen-GIen-GMen-GRen-GYen-HKen-HRen-HTen-HUen-IDen-IEen-ILen-INen-IQen-ISen-ITen-JMen-JOen-JPen-KEen-KHen-KNen-KRen-KWen-KYen-KZen-LAen-LBen-LTen-LVen-MDen-MKen-MMen-MSen-MTen-MVen-MXen-MYen-NGen-NLen-NOen-NPen-NZen-OMen-PAen-PEen-PGen-PHen-PKen-PLen-PSen-PTen-PYen-QAen-ROen-RUen-RWen-SAen-SBen-SDen-SEen-SGen-SIen-SKen-SNen-SRen-SSen-TCen-THen-TNen-TOen-TRen-TTen-TWen-UGen-USen-UYen-VCen-VEen-VGen-VNen-WSen-YEen-ZAen-ZWeses-ARes-BOes-BRes-CLes-COes-CRes-DOes-ECes-ESes-GTes-HNes-MXes-NIes-PAes-PEes-PYes-SVes-USes-UYes-VEetet-EEfafifi-FIfilfrfr-AEfr-BEfr-BFfr-BJfr-CAfr-CDfr-CGfr-CHfr-CIfr-CMfr-FRfr-GAfr-GFfr-LUfr-MAfr-MFfr-MGfr-MLfr-NLfr-PTfr-SNfr-TGgaguhahehihi-MYhi-SGhrhr-HRht-DOhuhu-HUidid-HKid-IDid-JPid-SGitit-AEit-BEit-CHit-ITjaja-JPkakkknkoky-KGloltlt-LTlvlv-LVmkmlmrmsms-MYmy-JPmy-MYmy-SGnbne-JPnlnl-BEnl-NLno-NOpaplpl-PLptpt-AOpt-BRpt-PTroro-MDro-ROruru-BYru-KZru-ROru-RUrw-RWsksk-SKslsl-SIsqsq-ALsrsr-RSsvsv-SEswtata-MYta-SGtethth-SGth-THtk-TMtrtr-TRukuk-UAuruzuz-UZvivi-JPvi-MYvi-USzh-CNzh-HKzh-JPzh-SGzh-TWzu

assetsarray of Asset (one of)

stylesarray of Style (one of)

deploymentsarray of Deployment (object)

variablesarray of Variables-2 (object)

genericContentarray of GenericContent (object)

platformContentarray of PlatformContent (object)

supportedPlatformsnullable PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

editorTypestring

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

publisherTypestring (string)

shortLinksnullable object

clonedFromnullable string (uuid)

The ID of the template that this template was cloned from. This field is only present if this template was cloned from another template.

reviewInfoReviewInfo (object)

Describe the status of an entity that is being reviewed through approval flows.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": false,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": false
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": false,
        "value": "text"
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": "2024-11-21T08:58:55.100Z",
  "updatedAt": "2024-11-21T08:58:55.100Z",
  "isCloneable": false,
  "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": 0
  }
}

Delete ChannelTemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

204404409

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404409

{
  "code": "text",
  "message": "text"
}

Update ChannelTemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Body

application/json

defaultLocalenullable string

descriptionstring

assetsnullable array of Asset (one of)

stylesnullable array of Style (one of)

variablesnullable array of Variables-2 (object)

deploymentsnullable array of Deployment (object)

genericContentnullable array of GenericContent (object)

platformContentnullable array of PlatformContent (object)

supportedPlatformsnullable PlatformList (array of enum)

forceUpdateboolean

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

statusnullable enum

activeinactivependingdraftpendingReview

Other propertiesany

Response

200400404409422

Updated

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivependingpendingReview

descriptionstring

defaultLocaleLocaleEnum (enum)

Example: "en"

ae-AZafarar-AZar-EGar-IDar-UAazaz-AZbgbg-BGbnbn-MYbn-SGcacscs-CZdada-DKdede-ATde-CHde-DEde-LIde-LUee-GHelel-CYel-GRenen-AEen-AFen-AGen-ALen-ARen-ASen-ATen-AUen-AWen-AZen-BAen-BBen-BDen-BEen-BFen-BGen-BHen-BJen-BNen-BOen-BRen-BSen-BWen-BYen-BZen-CAen-CDen-CGen-CHen-CIen-CLen-CMen-CNen-COen-CYen-CZen-DEen-DKen-DMen-DOen-ECen-EGen-ESen-FIen-FJen-FRen-GBen-GDen-GEen-GHen-GIen-GMen-GRen-GYen-HKen-HRen-HTen-HUen-IDen-IEen-ILen-INen-IQen-ISen-ITen-JMen-JOen-JPen-KEen-KHen-KNen-KRen-KWen-KYen-KZen-LAen-LBen-LTen-LVen-MDen-MKen-MMen-MSen-MTen-MVen-MXen-MYen-NGen-NLen-NOen-NPen-NZen-OMen-PAen-PEen-PGen-PHen-PKen-PLen-PSen-PTen-PYen-QAen-ROen-RUen-RWen-SAen-SBen-SDen-SEen-SGen-SIen-SKen-SNen-SRen-SSen-TCen-THen-TNen-TOen-TRen-TTen-TWen-UGen-USen-UYen-VCen-VEen-VGen-VNen-WSen-YEen-ZAen-ZWeses-ARes-BOes-BRes-CLes-COes-CRes-DOes-ECes-ESes-GTes-HNes-MXes-NIes-PAes-PEes-PYes-SVes-USes-UYes-VEetet-EEfafifi-FIfilfrfr-AEfr-BEfr-BFfr-BJfr-CAfr-CDfr-CGfr-CHfr-CIfr-CMfr-FRfr-GAfr-GFfr-LUfr-MAfr-MFfr-MGfr-MLfr-NLfr-PTfr-SNfr-TGgaguhahehihi-MYhi-SGhrhr-HRht-DOhuhu-HUidid-HKid-IDid-JPid-SGitit-AEit-BEit-CHit-ITjaja-JPkakkknkoky-KGloltlt-LTlvlv-LVmkmlmrmsms-MYmy-JPmy-MYmy-SGnbne-JPnlnl-BEnl-NLno-NOpaplpl-PLptpt-AOpt-BRpt-PTroro-MDro-ROruru-BYru-KZru-ROru-RUrw-RWsksk-SKslsl-SIsqsq-ALsrsr-RSsvsv-SEswtata-MYta-SGtethth-SGth-THtk-TMtrtr-TRukuk-UAuruzuz-UZvivi-JPvi-MYvi-USzh-CNzh-HKzh-JPzh-SGzh-TWzu

assetsarray of Asset (one of)

stylesarray of Style (one of)

deploymentsarray of Deployment (object)

variablesarray of Variables-2 (object)

genericContentarray of GenericContent (object)

platformContentarray of PlatformContent (object)

supportedPlatformsnullable PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

editorTypestring

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

publisherTypestring (string)

shortLinksnullable object

clonedFromnullable string (uuid)

The ID of the template that this template was cloned from. This field is only present if this template was cloned from another template.

reviewInfoReviewInfo (object)

Describe the status of an entity that is being reviewed through approval flows.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "description": "text",
  "defaultLocale": "en",
  "assets": [
    {
      "key": "logoUrl",
      "isDefault": false,
      "valueString": "text"
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": false
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "variables": [
    {
      "key": "text",
      "description": "text",
      "type": "string",
      "format": "none",
      "sourceUrl": {
        "fullyReplaced": false,
        "value": "text"
      }
    }
  ],
  "genericContent": [
    {
      "locale": "en",
      "type": "text",
      "blocks": [
        {
          "id": "text",
          "reference": "text",
          "role": "text",
          "hidden": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": false,
          "type": "action",
          "action": {
            "type": "link",
            "id": "text",
            "reference": "text",
            "role": "text",
            "hidden": false,
            "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": "2024-11-21T08:58:55.100Z",
  "updatedAt": "2024-11-21T08:58:55.100Z",
  "isCloneable": false,
  "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": 0
  }
}

Activate ChannelTemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

200404422

Activated

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Deactivate ChannelTemplate

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

Authorization

useraccessKey

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

200404422

Deactivated

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/deactivate', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Create ChannelTemplate Preview

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

platformstring

blocksarray of Block (object)

stylesnullable array of Style (one of)

variablesnullable object

parametersnullable array of Parameter-2 (object)

shortLinksnullable object

contactIdnullable string

Response

200404422

OK

Body

application/json

validationErrorsobject

typeenum

bodyblocks

bodyMessageBody

blocksnullable array of Block (object)

stylesnullable array of Style (one of)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/channel-templates/create-preview', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

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