PUT api/sms/update-message-subscription

Request Information

URI Parameters

None.

Body Parameters

UpdateMessageSubscriptionRequest
NameDescriptionTypeAdditional information
MessageSubscriptionId

globally unique identifier

None.

UserId

globally unique identifier

None.

AgencyId

globally unique identifier

None.

NewUserPhoneNumber

string

None.

NewPhoneNumberFrom

string

None.

NewWebhookUrl

string

None.

NewIsAutoUnsubscribe

boolean

None.

NewIsActive

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "messageSubscriptionId": "5a6155b9-eb0b-4cdf-afca-49798e4696ac",
  "userId": "1fa59381-0ce0-4114-81a5-d532b4d05572",
  "agencyId": "dff426a4-12e3-46e3-a842-42927e1bbcc9",
  "newUserPhoneNumber": "sample string 4",
  "newPhoneNumberFrom": "sample string 5",
  "newWebhookUrl": "sample string 6",
  "newIsAutoUnsubscribe": true,
  "newIsActive": true
}

application/xml, text/xml

Sample:
<UpdateMessageSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS">
  <AgencyId>dff426a4-12e3-46e3-a842-42927e1bbcc9</AgencyId>
  <MessageSubscriptionId>5a6155b9-eb0b-4cdf-afca-49798e4696ac</MessageSubscriptionId>
  <NewIsActive>true</NewIsActive>
  <NewIsAutoUnsubscribe>true</NewIsAutoUnsubscribe>
  <NewPhoneNumberFrom>sample string 5</NewPhoneNumberFrom>
  <NewUserPhoneNumber>sample string 4</NewUserPhoneNumber>
  <NewWebhookUrl>sample string 6</NewWebhookUrl>
  <UserId>1fa59381-0ce0-4114-81a5-d532b4d05572</UserId>
</UpdateMessageSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultWithDatabaseId
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Status

ApiStatus

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "fe6aa2e5-c88d-4220-9267-089678e466d8",
  "status": 0,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<NowCertsApiResultWithDatabaseId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Message>sample string 2</Message>
  <Status>Error</Status>
  <DatabaseId>fe6aa2e5-c88d-4220-9267-089678e466d8</DatabaseId>
</NowCertsApiResultWithDatabaseId>