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": "10e8088e-7347-4d01-8627-6edb0886a278",
  "userId": "1a7c16d9-712c-49e3-b9bb-dac1657c8ca9",
  "agencyId": "fd16899e-66d3-4ed0-98ac-4fcc05f2dbb6"
}

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>fd16899e-66d3-4ed0-98ac-4fcc05f2dbb6</AgencyId>
  <MessageSubscriptionId>10e8088e-7347-4d01-8627-6edb0886a278</MessageSubscriptionId>
  <UserId>1a7c16d9-712c-49e3-b9bb-dac1657c8ca9</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": "be14e0ea-9e34-4c9c-a35e-67c7f5c7d85a",
  "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>be14e0ea-9e34-4c9c-a35e-67c7f5c7d85a</DatabaseId>
</NowCertsApiResultWithDatabaseId>