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": "cd70cc89-ac0e-4871-a6ca-cb76af4e45ca",
  "userId": "ba67ba87-b817-4ddf-ba07-35f09a9cdb35",
  "agencyId": "d9440223-fed3-4bd7-8df8-b57ce1d1e407"
}

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>d9440223-fed3-4bd7-8df8-b57ce1d1e407</AgencyId>
  <MessageSubscriptionId>cd70cc89-ac0e-4871-a6ca-cb76af4e45ca</MessageSubscriptionId>
  <UserId>ba67ba87-b817-4ddf-ba07-35f09a9cdb35</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": "52f5ddc9-948c-4188-803c-63a58f4c752b",
  "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>52f5ddc9-948c-4188-803c-63a58f4c752b</DatabaseId>
</NowCertsApiResultWithDatabaseId>