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": "23c41c7a-337a-4561-b19b-57a3eead31b9",
  "userId": "4c4119af-408f-40ff-a9f5-e339515d3ea2",
  "agencyId": "41f5890f-b306-46c0-b182-631765b48905"
}

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>41f5890f-b306-46c0-b182-631765b48905</AgencyId>
  <MessageSubscriptionId>23c41c7a-337a-4561-b19b-57a3eead31b9</MessageSubscriptionId>
  <UserId>4c4119af-408f-40ff-a9f5-e339515d3ea2</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": "3253b8da-5b47-486d-8184-4d56a873a2b1",
  "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>3253b8da-5b47-486d-8184-4d56a873a2b1</DatabaseId>
</NowCertsApiResultWithDatabaseId>