DELETE api/sms/unsubscribe-from-inbound-message

Request Information

URI Parameters

None.

Body Parameters

UnsubscribeForInboundMessageRequest
NameDescriptionTypeAdditional information
MessageSubscriptionId

globally unique identifier

None.

UserId

globally unique identifier

None.

AgencyId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "messageSubscriptionId": "e83ed814-a479-484f-ae74-141d196cdf2e",
  "userId": "b0f93eb8-b5ea-4148-9faf-cc47e73cd790",
  "agencyId": "bd71ee68-f279-4d2e-b087-71ff9235798d"
}

application/xml, text/xml

Sample:
<UnsubscribeForInboundMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS">
  <AgencyId>bd71ee68-f279-4d2e-b087-71ff9235798d</AgencyId>
  <MessageSubscriptionId>e83ed814-a479-484f-ae74-141d196cdf2e</MessageSubscriptionId>
  <UserId>b0f93eb8-b5ea-4148-9faf-cc47e73cd790</UserId>
</UnsubscribeForInboundMessageRequest>

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": "8b6992ab-deb5-480a-b416-cedebb2964eb",
  "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>8b6992ab-deb5-480a-b416-cedebb2964eb</DatabaseId>
</NowCertsApiResultWithDatabaseId>