Skip to main content
PATCH
Update user-specific SMS notification settings for an automation

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