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": "cd8fd551-14fa-4004-8dca-524fa829c01d", "userId": "153ed64e-d49c-4198-b972-780aa24a5a7d", "agencyId": "3fd1e088-c054-4ea9-8111-38a2c7dd7eab", "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>3fd1e088-c054-4ea9-8111-38a2c7dd7eab</AgencyId> <MessageSubscriptionId>cd8fd551-14fa-4004-8dca-524fa829c01d</MessageSubscriptionId> <NewIsActive>true</NewIsActive> <NewIsAutoUnsubscribe>true</NewIsAutoUnsubscribe> <NewPhoneNumberFrom>sample string 5</NewPhoneNumberFrom> <NewUserPhoneNumber>sample string 4</NewUserPhoneNumber> <NewWebhookUrl>sample string 6</NewWebhookUrl> <UserId>153ed64e-d49c-4198-b972-780aa24a5a7d</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": "2d3d8efd-2d2f-43dc-aae4-016d036ab271", "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>2d3d8efd-2d2f-43dc-aae4-016d036ab271</DatabaseId> </NowCertsApiResultWithDatabaseId>