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": "a0c6db92-c440-4733-b135-096f0f829f46",
  "userId": "8f4e1866-fc1b-4af4-9119-630fee6b27f8",
  "agencyId": "6d6ae515-22ee-4012-a587-7797ac531007"
}

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>6d6ae515-22ee-4012-a587-7797ac531007</AgencyId>
  <MessageSubscriptionId>a0c6db92-c440-4733-b135-096f0f829f46</MessageSubscriptionId>
  <UserId>8f4e1866-fc1b-4af4-9119-630fee6b27f8</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": "858911bc-9c6f-4ec8-807f-85bf5af1494f",
  "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>858911bc-9c6f-4ec8-807f-85bf5af1494f</DatabaseId>
</NowCertsApiResultWithDatabaseId>