Skip to main content
PATCH
/
api
/
automations
/
{id}
/
sms-settings
Update user-specific SMS notification settings for an automation
curl --request PATCH \
  --url https://your-instance.example.com/api/automations/{id}/sms-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "smsNotificationEnabled": true,
  "smsNotificationPhoneNumbers": [
    "+14155551234",
    "+14155555678"
  ],
  "smsNotificationMessage": "New lead pending follow-up.",
  "smsNotificationTemplateId": "new-lead-alert"
}
'
{
  "success": true,
  "message": "SMS notification settings updated successfully",
  "data": {
    "automationId": "64d2f9c5e8a1d4e001a0b1c2",
    "smsNotification": {
      "enabled": true,
      "phoneNumbers": [
        "+14165550100"
      ],
      "message": "New escalation on lead {{contact.firstName}}",
      "templateId": "64a1b2c3d4e5f60012345679"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
smsNotificationEnabled
boolean

Master switch for the per-user SMS notification on this automation.

​
smsNotificationPhoneNumbers
string[]

Phone numbers to ping when the automation fires.

​
smsNotificationMessage
string

Custom body (supports {{contact.firstName}} placeholders); ignored when smsNotificationTemplateId is set.

​
smsNotificationTemplateId
string

Template _id whose body is used; mutually exclusive with smsNotificationMessage.

Response

SMS notification settings updated

Returned after per-user SMS notification settings for an automation are updated.

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
message
string