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": "4ce3ec63-2a06-4e65-9e21-4d5afcc1a2cb",
  "userId": "5d031aac-a671-4bfd-8e5b-b4cd23058ec0",
  "agencyId": "7884d564-847e-4003-817b-f4fd0a5d55e0"
}

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>7884d564-847e-4003-817b-f4fd0a5d55e0</AgencyId>
  <MessageSubscriptionId>4ce3ec63-2a06-4e65-9e21-4d5afcc1a2cb</MessageSubscriptionId>
  <UserId>5d031aac-a671-4bfd-8e5b-b4cd23058ec0</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": "14e3811d-74a5-4a06-a7f8-374c165a4513",
  "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>14e3811d-74a5-4a06-a7f8-374c165a4513</DatabaseId>
</NowCertsApiResultWithDatabaseId>