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": "5a8fa509-d1d1-4280-bc19-109d7d943208",
  "userId": "7b60678a-0edf-41a8-bad9-cd36c1735642",
  "agencyId": "a8616169-6bd0-41fb-b399-5a5402e19933"
}

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>a8616169-6bd0-41fb-b399-5a5402e19933</AgencyId>
  <MessageSubscriptionId>5a8fa509-d1d1-4280-bc19-109d7d943208</MessageSubscriptionId>
  <UserId>7b60678a-0edf-41a8-bad9-cd36c1735642</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": "86563423-9f04-4467-94e5-aeb51904cf2a",
  "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>86563423-9f04-4467-94e5-aeb51904cf2a</DatabaseId>
</NowCertsApiResultWithDatabaseId>