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": "256aab17-aea6-4493-8a3e-d348244b9d30",
  "userId": "118d62e4-f467-405d-a0ef-616a08d97072",
  "agencyId": "6462eb38-a000-4a93-9867-7f4a0777e485"
}

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>6462eb38-a000-4a93-9867-7f4a0777e485</AgencyId>
  <MessageSubscriptionId>256aab17-aea6-4493-8a3e-d348244b9d30</MessageSubscriptionId>
  <UserId>118d62e4-f467-405d-a0ef-616a08d97072</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": "b7ad276e-a346-4900-becb-e00f15c732cf",
  "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>b7ad276e-a346-4900-becb-e00f15c732cf</DatabaseId>
</NowCertsApiResultWithDatabaseId>