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": "df7a7ca7-963f-4689-9fc3-3a6631e62abb",
  "userId": "2d20ebb7-ddd5-4bf9-b166-1d5ffa0b5172",
  "agencyId": "8ad45cc5-0ca6-48da-b954-b78efe35ee09"
}

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>8ad45cc5-0ca6-48da-b954-b78efe35ee09</AgencyId>
  <MessageSubscriptionId>df7a7ca7-963f-4689-9fc3-3a6631e62abb</MessageSubscriptionId>
  <UserId>2d20ebb7-ddd5-4bf9-b166-1d5ffa0b5172</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": "f60b78e8-9600-4b16-b748-1953d2bd840e",
  "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>f60b78e8-9600-4b16-b748-1953d2bd840e</DatabaseId>
</NowCertsApiResultWithDatabaseId>