Message Templates

Message Templates are referred to as channel templates through the API

List channeltemplates in workspace

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

Query parameters

metricsbooleanOptional

Include metrics in the response

Default: false

limitinteger · max: 100Optional

Limits the number of results to return.

Default: 25

pageTokenstringOptional

The cursor that keeps track of the current position in the results.

reversebooleanOptional

Reverses the order in which the results are returned.

Default: false

Responses

200

OK

application/json

nextPageTokenstringOptional

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

404

The requested resource was not found.

application/json

get

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/projects/{projectId}/channel-templates HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "draft",
      "localeStatuses": {
        "ANY_ADDITIONAL_PROPERTY": "draft"
      },
      "platformInfo": {
        "ANY_ADDITIONAL_PROPERTY": {
          "status": "draft",
          "category": "text",
          "qualityRating": "UNKNOWN"
        }
      },
      "description": "text",
      "defaultLocale": "ae-AZ",
      "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",
                      "items": [
                        {
                          "hidden": true,
                          "id": "text",
                          "reference": "text",
                          "replyAction": {
                            "imageUrl": "text",
                            "payload": "text",
                            "text": "text"
                          },
                          "role": "text",
                          "type": "reply-action"
                        }
                      ],
                      "multipleSelection": true,
                      "title": "text"
                    }
                  ]
                }
              ]
            }
          }
        }
      ],
      "genericContent": [
        {
          "locale": "ae-AZ",
          "type": "text",
          "blocks": [
            {
              "hidden": true,
              "id": "text",
              "reference": "text",
              "role": "text",
              "type": "action",
              "action": {
                "link": {
                  "metadata": {
                    "description": {
                      "label": "text"
                    }
                  },
                  "text": "text",
                  "url": "text"
                },
                "type": "link"
              }
            }
          ]
        }
      ],
      "platformContent": [
        {
          "locale": "ae-AZ",
          "type": "text",
          "platform": "text",
          "channelIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "channelGroupIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "blocks": [
            {
              "hidden": true,
              "id": "text",
              "reference": "text",
              "role": "text",
              "type": "action",
              "action": {
                "link": {
                  "metadata": {
                    "description": {
                      "label": "text"
                    }
                  },
                  "text": "text",
                  "url": "text"
                },
                "type": "link"
              }
            }
          ],
          "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": "2026-05-16T21:09:27.288Z",
      "updatedAt": "2026-05-16T21:09:27.288Z",
      "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",
        "currentStep": 1,
        "status": "pending"
      }
    }
  ],
  "nextPageToken": "text"
}

Create channeltemplate

post

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

Query parameters

metricsbooleanOptional

Include metrics in the response

Default: false

Body

application/json

descriptionstringOptional

defaultLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird messaging products

Possible values:

shortLinksobject · nullableOptional

Other propertiesanyOptional

Responses

201

Created

application/json

400

The request was malformed.

application/json

404

The requested resource was not found.

application/json

409

The request conflicts with the current state of the resource.

application/json

422

The request contains invalid parameters or body fields.

application/json

post

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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/projects/{projectId}/channel-templates HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1827

{
  "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",
                  "items": [
                    {
                      "hidden": true,
                      "id": "text",
                      "reference": "text",
                      "replyAction": {
                        "imageUrl": "text",
                        "payload": "text",
                        "text": "text"
                      },
                      "role": "text",
                      "type": "reply-action"
                    }
                  ],
                  "multipleSelection": true,
                  "title": "text"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "genericContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ],
      "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"
  },
  "platformInfo": {
    "ANY_ADDITIONAL_PROPERTY": {
      "status": "draft",
      "category": "text",
      "qualityRating": "UNKNOWN"
    }
  },
  "description": "text",
  "defaultLocale": "ae-AZ",
  "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",
                  "items": [
                    {
                      "hidden": true,
                      "id": "text",
                      "reference": "text",
                      "replyAction": {
                        "imageUrl": "text",
                        "payload": "text",
                        "text": "text"
                      },
                      "role": "text",
                      "type": "reply-action"
                    }
                  ],
                  "multipleSelection": true,
                  "title": "text"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ],
      "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": "2026-05-16T21:09:27.288Z",
  "updatedAt": "2026-05-16T21:09:27.288Z",
  "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",
    "currentStep": 1,
    "status": "pending"
  }
}

Get ChannelTemplate

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

OK

application/json

idstring · uuidRequired

projectIdstring · uuidRequired

statusstring · enumOptionalPossible values:

descriptionstringOptional

defaultLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird messaging products

Possible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeOptional

isCloneablebooleanOptional

editorIdstring · uuidOptional

editorTypestringOptional

publisherIdstring · uuidOptional

The ID of the user that last published this ChannelTemplate.

publisherTypestring · stringOptional

shortLinksobject · nullableOptional

clonedFromstring · uuid · nullableOptional

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

metricsobjectOptional

Metrics for this template.

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

get

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "localeStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "draft"
  },
  "platformInfo": {
    "ANY_ADDITIONAL_PROPERTY": {
      "status": "draft",
      "category": "text",
      "qualityRating": "UNKNOWN"
    }
  },
  "description": "text",
  "defaultLocale": "ae-AZ",
  "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",
                  "items": [
                    {
                      "hidden": true,
                      "id": "text",
                      "reference": "text",
                      "replyAction": {
                        "imageUrl": "text",
                        "payload": "text",
                        "text": "text"
                      },
                      "role": "text",
                      "type": "reply-action"
                    }
                  ],
                  "multipleSelection": true,
                  "title": "text"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ],
      "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": "2026-05-16T21:09:27.288Z",
  "updatedAt": "2026-05-16T21:09:27.288Z",
  "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",
    "currentStep": 1,
    "status": "pending"
  }
}

Delete ChannelTemplate

delete

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

channelTemplateIdstringRequired

Responses

204

Deleted

404

The requested resource was not found.

application/json

409

The request conflicts with the current state of the resource.

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Update ChannelTemplate

patch

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

channelTemplateIdstringRequired

Body

application/json

defaultLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird messaging products

Possible 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

idstring · uuidRequired

projectIdstring · uuidRequired

statusstring · enumOptionalPossible values:

descriptionstringOptional

defaultLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird messaging products

Possible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeOptional

isCloneablebooleanOptional

editorIdstring · uuidOptional

editorTypestringOptional

publisherIdstring · uuidOptional

The ID of the user that last published this ChannelTemplate.

publisherTypestring · stringOptional

shortLinksobject · nullableOptional

clonedFromstring · uuid · nullableOptional

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

metricsobjectOptional

Metrics for this template.

400

The request was malformed.

application/json

404

The requested resource was not found.

application/json

409

The request conflicts with the current state of the resource.

application/json

422

The request contains invalid parameters or body fields.

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1848

{
  "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",
                  "items": [
                    {
                      "hidden": true,
                      "id": "text",
                      "reference": "text",
                      "replyAction": {
                        "imageUrl": "text",
                        "payload": "text",
                        "text": "text"
                      },
                      "role": "text",
                      "type": "reply-action"
                    }
                  ],
                  "multipleSelection": true,
                  "title": "text"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "deployments": [
    {
      "key": "whatsappCategory",
      "value": "text",
      "locale": "text",
      "platform": "text"
    }
  ],
  "genericContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ],
      "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"
  },
  "platformInfo": {
    "ANY_ADDITIONAL_PROPERTY": {
      "status": "draft",
      "category": "text",
      "qualityRating": "UNKNOWN"
    }
  },
  "description": "text",
  "defaultLocale": "ae-AZ",
  "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",
                  "items": [
                    {
                      "hidden": true,
                      "id": "text",
                      "reference": "text",
                      "replyAction": {
                        "imageUrl": "text",
                        "payload": "text",
                        "text": "text"
                      },
                      "role": "text",
                      "type": "reply-action"
                    }
                  ],
                  "multipleSelection": true,
                  "title": "text"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "genericContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ]
    }
  ],
  "platformContent": [
    {
      "locale": "ae-AZ",
      "type": "text",
      "platform": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "channelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "blocks": [
        {
          "hidden": true,
          "id": "text",
          "reference": "text",
          "role": "text",
          "type": "action",
          "action": {
            "link": {
              "metadata": {
                "description": {
                  "label": "text"
                }
              },
              "text": "text",
              "url": "text"
            },
            "type": "link"
          }
        }
      ],
      "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": "2026-05-16T21:09:27.288Z",
  "updatedAt": "2026-05-16T21:09:27.288Z",
  "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",
    "currentStep": 1,
    "status": "pending"
  }
}

Activate ChannelTemplate

put

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

Activated

No content

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

put

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

HTTPcURLJavaScriptPython

PUT /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/activate HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Deactivate ChannelTemplate

put

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

projectIdstringRequired

channelTemplateIdstringRequired

Responses

200

Deactivated

No content

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

put

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

HTTPcURLJavaScriptPython

PUT /workspaces/{workspaceId}/projects/{projectId}/channel-templates/{channelTemplateId}/deactivate HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Create ChannelTemplate Preview

post

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Body

application/json

platformstring · min: 1Optional

shortLinksobject · nullableOptional

contactIdstring · nullableOptional

localestring · locale-bcp47 · nullableOptional

Responses

200

OK

application/json

typestring · enumOptionalPossible values:

bodyone ofOptional

or

or

or

or

or

or

or

or

or

or

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

post

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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/projects/channel-templates/create-preview HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 485

{
  "platform": "text",
  "blocks": [
    {
      "hidden": true,
      "id": "text",
      "reference": "text",
      "role": "text",
      "type": "action",
      "action": {
        "link": {
          "metadata": {
            "description": {
              "label": "text"
            }
          },
          "text": "text",
          "url": "text"
        },
        "type": "link"
      }
    }
  ],
  "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",
  "locale": "text"
}

{
  "validationErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "type": "body",
  "body": {
    "text": {
      "actions": [
        {
          "link": {
            "metadata": {
              "description": {
                "label": "text"
              }
            },
            "text": "text",
            "url": "text"
          },
          "type": "link"
        }
      ],
      "attachments": [
        {
          "content": "text",
          "contentId": "text",
          "contentType": "text",
          "filename": "text",
          "inline": true,
          "mediaUrl": "text"
        }
      ],
      "metadata": {
        "apple": {
          "appClipPreview": true,
          "appClipRegion": "text",
          "summaryText": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "line": {
          "emoji": {
            "items": [
              {
                "emojiId": "text",
                "index": 1,
                "length": 1,
                "productId": "text"
              }
            ]
          }
        },
        "paymentDetails": {
          "amount": "text",
          "currency": "text",
          "sessionIdentifier": "text",
          "state": "text"
        },
        "subject": "text",
        "telegram": {
          "parseMode": "text"
        },
        "whatsapp": {
          "callPermissionExpiration": "2026-05-16T21:09:27.288Z",
          "callPermissionResponse": "accept",
          "previewUrl": true
        }
      },
      "text": "text"
    },
    "type": "text"
  },
  "blocks": [
    {
      "hidden": true,
      "id": "text",
      "reference": "text",
      "role": "text",
      "type": "action",
      "action": {
        "link": {
          "metadata": {
            "description": {
              "label": "text"
            }
          },
          "text": "text",
          "url": "text"
        },
        "type": "link"
      }
    }
  ],
  "styles": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ]
}