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": "d7def74c-fdeb-4a8b-85d2-3fe6da720aed",
  "userId": "37ca0101-6fc1-4e1b-aa2d-d5dd745457fe",
  "agencyId": "fdb5daa7-1d43-4b83-b0c0-4826e9ad7d77"
}

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>fdb5daa7-1d43-4b83-b0c0-4826e9ad7d77</AgencyId>
  <MessageSubscriptionId>d7def74c-fdeb-4a8b-85d2-3fe6da720aed</MessageSubscriptionId>
  <UserId>37ca0101-6fc1-4e1b-aa2d-d5dd745457fe</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": "5a6cd438-cb21-493c-8536-7d09f9193b98",
  "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>5a6cd438-cb21-493c-8536-7d09f9193b98</DatabaseId>
</NowCertsApiResultWithDatabaseId>