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": "00bbaa54-d8da-450a-bce7-8fce6b004db5",
  "userId": "d518b60b-9b73-405e-823f-32582becfa22",
  "agencyId": "ecc91bc2-b8ce-4861-a675-b6fb449ecdc8"
}

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>ecc91bc2-b8ce-4861-a675-b6fb449ecdc8</AgencyId>
  <MessageSubscriptionId>00bbaa54-d8da-450a-bce7-8fce6b004db5</MessageSubscriptionId>
  <UserId>d518b60b-9b73-405e-823f-32582becfa22</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": "7d411876-e65e-490a-9301-13dbc9bfdd7e",
  "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>7d411876-e65e-490a-9301-13dbc9bfdd7e</DatabaseId>
</NowCertsApiResultWithDatabaseId>