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": "8161cc2e-91e8-46f7-8846-4e64df2491ff",
  "userId": "63108e04-5124-48b7-9f24-770e0ffcc349",
  "agencyId": "31bf5c43-8639-4e4a-88b4-385da5a73826"
}

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>31bf5c43-8639-4e4a-88b4-385da5a73826</AgencyId>
  <MessageSubscriptionId>8161cc2e-91e8-46f7-8846-4e64df2491ff</MessageSubscriptionId>
  <UserId>63108e04-5124-48b7-9f24-770e0ffcc349</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": "b74c979c-de64-49e3-b8e0-eacf9d29488b",
  "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>b74c979c-de64-49e3-b8e0-eacf9d29488b</DatabaseId>
</NowCertsApiResultWithDatabaseId>