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": "5c17342e-148e-4ea7-8354-9a4c4eaf1111",
  "userId": "da6f1c4a-cabb-422b-aa85-fef242c42194",
  "agencyId": "f70fcfe1-e5d7-43c4-a9a6-84054b89adab"
}

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>f70fcfe1-e5d7-43c4-a9a6-84054b89adab</AgencyId>
  <MessageSubscriptionId>5c17342e-148e-4ea7-8354-9a4c4eaf1111</MessageSubscriptionId>
  <UserId>da6f1c4a-cabb-422b-aa85-fef242c42194</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": "9acb532f-0de8-4527-8f44-d14c8c03b4a1",
  "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>9acb532f-0de8-4527-8f44-d14c8c03b4a1</DatabaseId>
</NowCertsApiResultWithDatabaseId>