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": "d8f3e3d7-cb84-43ba-b2f9-15cabbe7ea09",
  "userId": "707857dd-52e0-4573-96e1-4ffa1df416f7",
  "agencyId": "fecf0881-034d-4f5e-999b-099f15900a30"
}

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>fecf0881-034d-4f5e-999b-099f15900a30</AgencyId>
  <MessageSubscriptionId>d8f3e3d7-cb84-43ba-b2f9-15cabbe7ea09</MessageSubscriptionId>
  <UserId>707857dd-52e0-4573-96e1-4ffa1df416f7</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": "e06a0461-bd94-4529-86dc-6953cb487ed4",
  "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>e06a0461-bd94-4529-86dc-6953cb487ed4</DatabaseId>
</NowCertsApiResultWithDatabaseId>