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": "14404766-7852-4248-9809-519d3386fd5e",
  "userId": "4d0cccf2-d39a-48e3-aa7e-bb886b2ea09f",
  "agencyId": "891352fc-b35a-49c2-925e-e4c3d4d79a63"
}

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>891352fc-b35a-49c2-925e-e4c3d4d79a63</AgencyId>
  <MessageSubscriptionId>14404766-7852-4248-9809-519d3386fd5e</MessageSubscriptionId>
  <UserId>4d0cccf2-d39a-48e3-aa7e-bb886b2ea09f</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": "3bca9407-5b61-4c5b-aa6f-71af4797b217",
  "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>3bca9407-5b61-4c5b-aa6f-71af4797b217</DatabaseId>
</NowCertsApiResultWithDatabaseId>