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": "5390ae50-a2ea-44e5-a3b9-7837a63f3926",
  "userId": "3242376a-7f88-474b-a5a5-0f319c1b5539",
  "agencyId": "05494868-913a-4116-aaa4-c44e69d69685"
}

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>05494868-913a-4116-aaa4-c44e69d69685</AgencyId>
  <MessageSubscriptionId>5390ae50-a2ea-44e5-a3b9-7837a63f3926</MessageSubscriptionId>
  <UserId>3242376a-7f88-474b-a5a5-0f319c1b5539</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": "fe5622d1-8db3-4827-b0df-e82fa86ee0e8",
  "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>fe5622d1-8db3-4827-b0df-e82fa86ee0e8</DatabaseId>
</NowCertsApiResultWithDatabaseId>