Message Templates

Message Templates are referred to as channel templates through the API.

List channeltemplates in workspace

GEThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates

Path parameters

workspaceId*string

projectId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Touchpoints_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

JavaScriptCurl

const response = await fetch('https://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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-04-29T13:20:55.443Z",
      "updatedAt": "2024-04-29T13:20:55.443Z",
      "isCloneable": false,
      "editorId": "123e4567-e89b-12d3-a456-426614174000",
      "publisherId": "123e4567-e89b-12d3-a456-426614174000",
      "clonedFrom": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "nextPageToken": "text"
}

Create channeltemplate

POSThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates

Path parameters

workspaceId*string

projectId*string

Body

application/json

descriptionstring

defaultLocalestring

assetsnullable array of Touchpoints_Asset (one of)

stylesnullable array of Touchpoints_Style (one of)

variablesnullable array of Touchpoints_Variables (object)

deploymentsnullable array of Touchpoints_Deployment (object)

genericContentnullable array of Touchpoints_GenericContent (object)

platformContentnullable array of Touchpoints_PlatformContent (object)

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

shortLinksnullable object

Other propertiesany

Response

201400404409422

Created

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivepending

descriptionstring

defaultLocaleTouchpoints_LocaleEnum (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

assetsarray of Touchpoints_Asset (one of)

stylesarray of Touchpoints_Style (one of)

deploymentsarray of Touchpoints_Deployment (object)

variablesarray of Touchpoints_Variables (object)

genericContentarray of Touchpoints_GenericContent (object)

platformContentarray of Touchpoints_PlatformContent (object)

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

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.

Request

JavaScriptCurl

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

Response

{
  "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-04-29T13:20:55.443Z",
  "updatedAt": "2024-04-29T13:20:55.443Z",
  "isCloneable": false,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000"
}

Get ChannelTemplate

GEThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

200404422

OK

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivepending

descriptionstring

defaultLocaleTouchpoints_LocaleEnum (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

assetsarray of Touchpoints_Asset (one of)

stylesarray of Touchpoints_Style (one of)

deploymentsarray of Touchpoints_Deployment (object)

variablesarray of Touchpoints_Variables (object)

genericContentarray of Touchpoints_GenericContent (object)

platformContentarray of Touchpoints_PlatformContent (object)

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

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.

Request

JavaScriptCurl

const response = await fetch('https://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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-04-29T13:20:55.443Z",
  "updatedAt": "2024-04-29T13:20:55.443Z",
  "isCloneable": false,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000"
}

Delete ChannelTemplate

DELETEhttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

204404409

Deleted

Request

JavaScriptCurl

const response = await fetch('https://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update ChannelTemplate

PATCHhttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Body

application/json

defaultLocalenullable string

descriptionstring

assetsnullable array of Touchpoints_Asset (one of)

stylesnullable array of Touchpoints_Style (one of)

variablesnullable array of Touchpoints_Variables (object)

deploymentsnullable array of Touchpoints_Deployment (object)

genericContentnullable array of Touchpoints_GenericContent (object)

platformContentnullable array of Touchpoints_PlatformContent (object)

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

forceUpdateboolean

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

Other propertiesany

Response

200400404409422

Updated

Body

application/json

id*string (uuid)

projectId*string (uuid)

statusenum

draftactiveinactivepending

descriptionstring

defaultLocaleTouchpoints_LocaleEnum (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

assetsarray of Touchpoints_Asset (one of)

stylesarray of Touchpoints_Style (one of)

deploymentsarray of Touchpoints_Deployment (object)

variablesarray of Touchpoints_Variables (object)

genericContentarray of Touchpoints_GenericContent (object)

platformContentarray of Touchpoints_PlatformContent (object)

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

createdAt*string (date-time)

updatedAtstring (date-time)

isCloneableboolean

editorIdstring (uuid)

publisherIdstring (uuid)

The ID of the user that last published this ChannelTemplate.

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.

Request

JavaScriptCurl

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

Response

{
  "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-04-29T13:20:55.443Z",
  "updatedAt": "2024-04-29T13:20:55.443Z",
  "isCloneable": false,
  "editorId": "123e4567-e89b-12d3-a456-426614174000",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000",
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000"
}

Activate ChannelTemplate

PUThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Response

200404422

Activated

Request

JavaScriptCurl

const response = await fetch('https://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Get ChannelTemplate Embeds

POSThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/embeds

Path parameters

workspaceId*string

projectId*string

channelTemplateId*string

Body

application/json

localeall of

platformstring

variablesnullable object

parametersnullable array of Touchpoints_Parameter (object)

Response

200404409422

OK

Body

application/json

validationErrorsobject

typeenum

bodyblocks

bodyMessageBody

blocksnullable array of Touchpoints_Block (object)

stylesnullable array of Touchpoints_Style (one of)

Request

JavaScriptCurl

const response = await fetch('https://nest.messagebird.one/workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/embeds', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "body",
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "https://example.com"
          }
        }
      ],
      "metadata": {
        "subject": "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"
        }
      }
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": false
    }
  ]
}

Create ChannelTemplate Preview

POSThttps://nest.messagebird.one/workspaces/{workspaceId}/projects/channel-templates/create-preview

Path parameters

workspaceId*string

Body

application/json

platformstring

blocksarray of Touchpoints_Block (object)

stylesnullable array of Touchpoints_Style (one of)

variablesnullable object

parametersnullable array of Touchpoints_Parameter (object)

shortLinksnullable object

Response

200404422

OK

Body

application/json

validationErrorsobject

typeenum

bodyblocks

bodyMessageBody

blocksnullable array of Touchpoints_Block (object)

stylesnullable array of Touchpoints_Style (one of)

Request

JavaScriptCurl

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

Response

{
  "type": "body",
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "https://example.com"
          }
        }
      ],
      "metadata": {
        "subject": "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"
        }
      }
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": false
    }
  ]
}