v1.0.0
OpenAPI 3.1.0
Link an SMS to a workflow
Client Libraries
Link an SMS to a workflow
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.
Path Parameters
- Type: string Format: uuididrequired
The UUID of the SMS.
Body
required
application/json
- Type: objecttargetrequired
The workflow to link the content to.
- Type: booleanforce
Replace an existing link if the workflow or action is already linked to different Design Studio content.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for post/v1/design_studio/sms/{id}/link
{
"target": {
"type": "campaign_action",
"action_id": 42
},
"force": false
}
{
"node_id": "123e4567-e89b-12d3-a456-426614174000",
"target": {
"type": "campaign_action",
"action_id": 42
},
"template_id": 987654
}SMS linked