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": "f2f64e90-0c4d-42cd-bc43-97bc9df81953",
  "userId": "4dadcca4-f226-4cb5-98e7-21ed16d69a9f",
  "agencyId": "bffed541-409e-499a-9544-07a46b315982"
}

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>bffed541-409e-499a-9544-07a46b315982</AgencyId>
  <MessageSubscriptionId>f2f64e90-0c4d-42cd-bc43-97bc9df81953</MessageSubscriptionId>
  <UserId>4dadcca4-f226-4cb5-98e7-21ed16d69a9f</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": "5b839f49-9e48-47eb-9d39-08d715b84865",
  "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>5b839f49-9e48-47eb-9d39-08d715b84865</DatabaseId>
</NowCertsApiResultWithDatabaseId>