PUT api/sms/update-message-subscription

Request Information

URI Parameters

None.

Body Parameters

Name	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": "b0b2dc1d-63e1-4ad5-9906-48331b00280c",
  "userId": "89d98bef-033f-4753-b24c-42f082df1971",
  "agencyId": "f2ca8cca-7367-479a-97e6-f6b155ff70fb",
  "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>f2ca8cca-7367-479a-97e6-f6b155ff70fb</AgencyId>
  <MessageSubscriptionId>b0b2dc1d-63e1-4ad5-9906-48331b00280c</MessageSubscriptionId>
  <NewIsActive>true</NewIsActive>
  <NewIsAutoUnsubscribe>true</NewIsAutoUnsubscribe>
  <NewPhoneNumberFrom>sample string 5</NewPhoneNumberFrom>
  <NewUserPhoneNumber>sample string 4</NewUserPhoneNumber>
  <NewWebhookUrl>sample string 6</NewWebhookUrl>
  <UserId>89d98bef-033f-4753-b24c-42f082df1971</UserId>
</UpdateMessageSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultWithDatabaseId

Name	Type	Additional information
DatabaseId	globally unique identifier	None.
Status	ApiStatus	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "databaseId": "bcc087ea-b5d0-4703-8c83-c9c367d2390e",
  "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>bcc087ea-b5d0-4703-8c83-c9c367d2390e</DatabaseId>
</NowCertsApiResultWithDatabaseId>