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": "fbf6f74c-c529-4768-91cc-98f7fcee9202",
  "userId": "3e539318-4b9e-48a3-a82e-2bf74bf70279",
  "agencyId": "79bfaa3b-3e1c-473d-9c8c-e106c59f79fb"
}

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>79bfaa3b-3e1c-473d-9c8c-e106c59f79fb</AgencyId>
  <MessageSubscriptionId>fbf6f74c-c529-4768-91cc-98f7fcee9202</MessageSubscriptionId>
  <UserId>3e539318-4b9e-48a3-a82e-2bf74bf70279</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": "98a5b45a-57bf-4f35-b444-eb38b82c1274",
  "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>98a5b45a-57bf-4f35-b444-eb38b82c1274</DatabaseId>
</NowCertsApiResultWithDatabaseId>