PUT api/sms/update-message-subscription
Request Information
URI Parameters
None.
Body Parameters
UpdateMessageSubscriptionRequestName | Description | Type | Additional 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": "80d29ccd-035b-49b0-8107-e3f2895e8b01", "userId": "e5285027-77c4-42b4-81a3-15d1ce69ff45", "agencyId": "587f5c30-b958-4fbd-bd0e-e448fae1f381", "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>587f5c30-b958-4fbd-bd0e-e448fae1f381</AgencyId> <MessageSubscriptionId>80d29ccd-035b-49b0-8107-e3f2895e8b01</MessageSubscriptionId> <NewIsActive>true</NewIsActive> <NewIsAutoUnsubscribe>true</NewIsAutoUnsubscribe> <NewPhoneNumberFrom>sample string 5</NewPhoneNumberFrom> <NewUserPhoneNumber>sample string 4</NewUserPhoneNumber> <NewWebhookUrl>sample string 6</NewWebhookUrl> <UserId>e5285027-77c4-42b4-81a3-15d1ce69ff45</UserId> </UpdateMessageSubscriptionRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultWithDatabaseIdName | Description | Type | Additional information |
---|---|---|---|
DatabaseId | globally unique identifier |
None. |
|
Status | ApiStatus |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "databaseId": "d0f30003-7bf3-4576-88e8-c369f7dc6cef", "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>d0f30003-7bf3-4576-88e8-c369f7dc6cef</DatabaseId> </NowCertsApiResultWithDatabaseId>