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": "ed642184-4a93-4fc2-9f63-d27dba7acf21",
  "userId": "af9ad49c-f836-4e4e-9414-44ac3454776c",
  "agencyId": "2ab9add2-39fc-47c1-8026-1ba2a7c25369"
}

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>2ab9add2-39fc-47c1-8026-1ba2a7c25369</AgencyId>
  <MessageSubscriptionId>ed642184-4a93-4fc2-9f63-d27dba7acf21</MessageSubscriptionId>
  <UserId>af9ad49c-f836-4e4e-9414-44ac3454776c</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": "994f1f04-893a-4c62-bca7-3d1fb2ec9fc7",
  "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>994f1f04-893a-4c62-bca7-3d1fb2ec9fc7</DatabaseId>
</NowCertsApiResultWithDatabaseId>