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": "b47c1642-5201-429f-a06f-cbe2fcf6ea54",
  "userId": "4a5cfda1-b905-4034-9b21-33265b92140d",
  "agencyId": "ede5329c-0b24-40ee-9caa-99ac3be37f12"
}

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>ede5329c-0b24-40ee-9caa-99ac3be37f12</AgencyId>
  <MessageSubscriptionId>b47c1642-5201-429f-a06f-cbe2fcf6ea54</MessageSubscriptionId>
  <UserId>4a5cfda1-b905-4034-9b21-33265b92140d</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": "8d6df185-ba18-4f32-89e1-3ca04a7f0e81",
  "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>8d6df185-ba18-4f32-89e1-3ca04a7f0e81</DatabaseId>
</NowCertsApiResultWithDatabaseId>