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": "dff63dde-37d5-4f42-b9f1-45ce52c1e2f0",
  "userId": "b04e9c47-8c96-4c2d-861a-74627c98f008",
  "agencyId": "805fd914-f27e-493c-80c2-7ca4b4f8163d"
}

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>805fd914-f27e-493c-80c2-7ca4b4f8163d</AgencyId>
  <MessageSubscriptionId>dff63dde-37d5-4f42-b9f1-45ce52c1e2f0</MessageSubscriptionId>
  <UserId>b04e9c47-8c96-4c2d-861a-74627c98f008</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": "f378ce38-eea5-4885-b285-3f6ceec867dc",
  "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>f378ce38-eea5-4885-b285-3f6ceec867dc</DatabaseId>
</NowCertsApiResultWithDatabaseId>