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": "3b0bd635-fcf5-4cec-803e-98f7f74a58af",
  "userId": "2267a853-19cc-4d42-ae75-e65472d4e7a6",
  "agencyId": "2453b9e6-1642-4401-aece-e2b8d6d87358"
}

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>2453b9e6-1642-4401-aece-e2b8d6d87358</AgencyId>
  <MessageSubscriptionId>3b0bd635-fcf5-4cec-803e-98f7f74a58af</MessageSubscriptionId>
  <UserId>2267a853-19cc-4d42-ae75-e65472d4e7a6</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": "7da77cf5-1380-41a5-a23a-ad20aeaf788b",
  "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>7da77cf5-1380-41a5-a23a-ad20aeaf788b</DatabaseId>
</NowCertsApiResultWithDatabaseId>