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": "34e1b2a5-c851-40ca-8453-b4dd7cce6b69",
  "userId": "8a72502f-0ffc-4e7d-9f50-fcb29a81c567",
  "agencyId": "d6627cde-846d-4edc-8bc2-41e433daecf7"
}

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>d6627cde-846d-4edc-8bc2-41e433daecf7</AgencyId>
  <MessageSubscriptionId>34e1b2a5-c851-40ca-8453-b4dd7cce6b69</MessageSubscriptionId>
  <UserId>8a72502f-0ffc-4e7d-9f50-fcb29a81c567</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": "47fc6325-2643-485a-bec4-5e846dc5ecfa",
  "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>47fc6325-2643-485a-bec4-5e846dc5ecfa</DatabaseId>
</NowCertsApiResultWithDatabaseId>