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": "606f7d38-b97c-4077-9ade-a71c131fac06",
  "userId": "2cc10baf-cdaa-4990-a00c-bf38a57adfad",
  "agencyId": "ea8660d4-be0c-462e-9ca9-141051ae5f4d"
}

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>ea8660d4-be0c-462e-9ca9-141051ae5f4d</AgencyId>
  <MessageSubscriptionId>606f7d38-b97c-4077-9ade-a71c131fac06</MessageSubscriptionId>
  <UserId>2cc10baf-cdaa-4990-a00c-bf38a57adfad</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": "369ad5ab-8f46-405b-bba0-fe70a841a19a",
  "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>369ad5ab-8f46-405b-bba0-fe70a841a19a</DatabaseId>
</NowCertsApiResultWithDatabaseId>