CUcustomer
SMS link and publish

Link an SMS to a workflow

Changed on

Link an existing SMS to a workflow—a transactional message, a one-time send, an automation action, or an API-triggered broadcast—to send it to your audience.

If your workflow is already live, people start receiving this SMS as soon as you link it. If you make changes to the message after linking it, you need to publish the SMS to send the latest content to your audience.

You can only link an SMS to one workflow at a time. If you try to link an SMS 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/sms/{id}/link

Request

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

Path parameters

idstring uuid required

The UUID of the SMS.

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

SMS 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