AIairship
SMS

Update SMS channel

Changed on

Update an existing SMS channel to reflect opt-in date, time zone and/or locale changes. The msisdn and sender in the request must match the existing channel or the request will 404.

put/api/channels/sms/{channel_id}

Request

Request body

locale_countrystring

The ISO 3166 two-character country code. The value for this field becomes a tag in the ua_locale_country tag group.

locale_languagestring

The ISO 639-1 two-character language code. The value for this field becomes a tag in the ua_locale_language tag group.

msisdnstring required

The phone number corresponding to the channel_id in the request. You cannot change this value for the existing channel.

opted_instring date-time

The date-time that represents when explicit permission was received from the user to receive messages.

senderstring required

The sender corresponding to the channel_id in the request. You cannot change this value for an existing channel.

timezonestring

The IANA identifier for a time zone, e.g., America/Los_Angeles. The value in this field becomes a tag in the timezone tag group.

Response

The SMS channel was updated successfully.

okboolean

True if the request was successful.

operation_idstring uuid

A unique identifier for an operation; you can use this identifier to find the operation for troubleshooting purposes.

Changes

  • 3304568aaadcRevision changes
    • breaking

      the request property format changed from no format to date-time

    This list may be incomplete.