Update SMS

This request changes the attributes of an SMS control.

The server has to support SMS messages in order for this request to succeed. See the system capabilities resource for more information.

Resource

PATCH /sms/<OID>

Where OID is the object ID of the SMS control.

Parameters

None

Payload

Patch Document

Note: changing the status from concept to scheduled schedules the SMS control for sending. An SMS message is then created for each recipient, as described in Create SMS.

Fields

name Patch Operations Comment

name	Patch Operations	Comment
sendOnDate	`replace`	Date on which this SMS should be sent, formatted as `yyyy-MM-dd HH:mm:ss`
subject	`replace`
wantConfirmation	`replace`
messageText	`replace`
smsHttpReplyTo	`replace`
status	`replace`	Valid values are `concept`, `scheduled`, `sent` and `failed`
phoneLine	`replace`	Value is the phone line oid
fromAddressee	`replace`	Value is the addressee oid
toAddressees	`add, remove`	Value is the oid of the referable (X1List or Addressable)
substitutionVars	`add, remove`

sendOnDate

replace

Date on which this SMS should be sent, formatted as yyyy-MM-dd HH:mm:ss

subject

replace

wantConfirmation

replace

messageText

replace

smsHttpReplyTo

replace

status

replace

Valid values are concept, scheduled, sent and failed

phoneLine

replace

Value is the phone line oid

fromAddressee

replace

Value is the addressee oid

toAddressees

add, remove

Value is the oid of the referable (X1List or Addressable)

substitutionVars

add, remove

Response

None

Context

Authorization

User

Errors

Common Errors

Example

Request

PATCH https://xelion.nl/api/v1/master/sms/2121029

Payload

change SMS control direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/messageText",
            "value": "Bird still lives!"
        }
    ]
}

change the send date of the SMS control

{
    "operations": [
        {
            "op": "replace",
            "path": "/sendOnDate",
            "value": "2026-01-01 10:00:00"
        }
    ]
}

schedule a concept SMS control for sending

{
    "operations": [
        {
            "op": "replace",
            "path": "/status",
            "value": "scheduled"
        }
    ]
}

change the phone line from which the SMS is sent, value is the phone line oid

{
    "operations": [
        {
            "op": "replace",
            "path": "/phoneLine",
            "value": "1651226"
        }
    ]
}

add a recipient to the SMS control, '1' is the virtual ID, value is the oid of the referable (X1List or Addressable)

{
    "operations": [
        {
            "op": "add",
            "path": "/toAddressees/1",
            "value": "1557812"
        }
    ]
}

remove a recipient from the SMS control, <OID> is the oid of the RelSMSControlReferable relation object

{
    "operations": [
        {
            "op": "remove",
            "path": "/toAddressees/2121031"
        }
    ]
}