CUcustomer
WhatsApp link and publish

Link a WhatsApp template to a workflow

Changed on

Link a WhatsApp template to a workflow or action: a transactional message, a one-time send, an automation action, or an API-triggered broadcast. The workflow or action needs to send WhatsApp messages.

Linking copies the template's current content, recipient, and sender to the workflow right away. You can link a template before you submit it to Meta. After you submit the template, publish it to push it to the workflow, and wait until its status is APPROVED before you start sending.

You can only link a template to one workflow or action at a time. If you try to link a template to a workflow or action that's already linked to a different message, the request fails with a 409 unless you pass "force": true. The force parameter replaces (and unlinks) the other message.

post/v1/design_studio/whatsapp/{id}/link

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/whatsapp/{id}/link
  • Auth
    none declared

Path parameters

idstring uuid required

The UUID of the WhatsApp template.

Request body

forceboolean

Replace an existing link if the workflow or action is already linked to different Design Studio content.

Example request

{
  "target": {
    "type": "campaign_action",
    "action_id": 42
  },
  "force": false
}

Response

WhatsApp template linked

node_idstring uuid

The UUID of the linked message.

template_idinteger

The ID of the workflow template the content is now linked to.

Example response

{
  "node_id": "123e4567-e89b-12d3-a456-426614174000",
  "template_id": 987654,
  "target": {
    "type": "campaign_action",
    "action_id": 42
  }
}

Changes