Update SMS service settings

POST/api/crm/v2/integration_sms.updatev2

operationId: integrationSms.update

Updates SMS service settings. Service fields are passed as {field}; secret fields are encrypted before saving.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

Key template: ${field}

object

One of the options

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 1

api_idstring

Example: secret

fromstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 2

loginstring

Example: secret

pswstring

Example: secret

senderstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 3

apikeystring

Example: secret

fromstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 5

loginstring

Example: secret

passwordstring

Example: secret

senderstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 6

userstring

Example: secret

passwordstring

Example: secret

fromstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 8

usernamestring

Example: secret

passwordstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 9

loginstring

Example: secret

passwordstring

Example: secret

senderstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 10

keystring

Example: secret

senderstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 11

tokenstring

Example: secret

senderstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 12

loginstring

Example: secret

passwordstring

Example: secret

fromstring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 13

api_keystring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 14

senderstring

Example: secret

api_keystring

Example: secret

object (IntegrationSmsUpdateCommon)

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

idintegerrequired

Example: 15

loginstring

Example: secret

passwordstring

Example: secret

source_numberstring

Example: secret

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

Update SMS service settings

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`