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": "90aedfd9-5147-418a-bd01-c737f11c3c26", "userId": "caf449db-0991-4b94-8ea3-e4ff7acaa1a4", "agencyId": "9dc8e9ea-2930-43a7-97f1-2b5621b01959", "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>9dc8e9ea-2930-43a7-97f1-2b5621b01959</AgencyId> <MessageSubscriptionId>90aedfd9-5147-418a-bd01-c737f11c3c26</MessageSubscriptionId> <NewIsActive>true</NewIsActive> <NewIsAutoUnsubscribe>true</NewIsAutoUnsubscribe> <NewPhoneNumberFrom>sample string 5</NewPhoneNumberFrom> <NewUserPhoneNumber>sample string 4</NewUserPhoneNumber> <NewWebhookUrl>sample string 6</NewWebhookUrl> <UserId>caf449db-0991-4b94-8ea3-e4ff7acaa1a4</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": "f3a6bcd5-302b-4be0-ba01-9caa5a8fc437", "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>f3a6bcd5-302b-4be0-ba01-9caa5a8fc437</DatabaseId> </NowCertsApiResultWithDatabaseId>