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": "ffa35d10-3874-4259-87d0-ca6ba3b03c14",
  "userId": "d0a6df5c-790e-4a4d-8618-3ebdce3fdbd7",
  "agencyId": "55dc2a04-2f79-4812-b2fa-4e8867d8e343"
}

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>55dc2a04-2f79-4812-b2fa-4e8867d8e343</AgencyId>
  <MessageSubscriptionId>ffa35d10-3874-4259-87d0-ca6ba3b03c14</MessageSubscriptionId>
  <UserId>d0a6df5c-790e-4a4d-8618-3ebdce3fdbd7</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": "93edfe06-253f-4197-83d0-8f47e20d4f6e",
  "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>93edfe06-253f-4197-83d0-8f47e20d4f6e</DatabaseId>
</NowCertsApiResultWithDatabaseId>