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": "6745f4f1-b0e3-458f-a6ab-84f0b6c8c136",
  "userId": "202ec639-8819-4210-a476-46ffe23979fa",
  "agencyId": "f55e7661-e394-4a5a-a6b5-a213ca1ab16a"
}

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>f55e7661-e394-4a5a-a6b5-a213ca1ab16a</AgencyId>
  <MessageSubscriptionId>6745f4f1-b0e3-458f-a6ab-84f0b6c8c136</MessageSubscriptionId>
  <UserId>202ec639-8819-4210-a476-46ffe23979fa</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": "add65784-5ee8-4ecb-8168-015d29efc00b",
  "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>add65784-5ee8-4ecb-8168-015d29efc00b</DatabaseId>
</NowCertsApiResultWithDatabaseId>