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": "1f7d8d94-3e8e-4393-9ce7-b7b5a45bb6d3",
  "userId": "b9fa972b-e6ee-4d9b-af06-b8c03ec6afaf",
  "agencyId": "9f6a2ee4-467d-46c7-8a80-31c9f7527c94"
}

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>9f6a2ee4-467d-46c7-8a80-31c9f7527c94</AgencyId>
  <MessageSubscriptionId>1f7d8d94-3e8e-4393-9ce7-b7b5a45bb6d3</MessageSubscriptionId>
  <UserId>b9fa972b-e6ee-4d9b-af06-b8c03ec6afaf</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": "4c649536-9998-401b-a4d6-4b7f2841aeb6",
  "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>4c649536-9998-401b-a4d6-4b7f2841aeb6</DatabaseId>
</NowCertsApiResultWithDatabaseId>