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": "5847c0be-d3eb-4ce6-a160-3dcdaabc8aaa",
  "userId": "2a2e4fc5-8d29-41eb-852a-926c77a4edfd",
  "agencyId": "d9ac11ec-8591-4f2d-afdf-13fa83c74849"
}

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>d9ac11ec-8591-4f2d-afdf-13fa83c74849</AgencyId>
  <MessageSubscriptionId>5847c0be-d3eb-4ce6-a160-3dcdaabc8aaa</MessageSubscriptionId>
  <UserId>2a2e4fc5-8d29-41eb-852a-926c77a4edfd</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": "fd390baf-bcfb-47df-a500-183261cb24c8",
  "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>fd390baf-bcfb-47df-a500-183261cb24c8</DatabaseId>
</NowCertsApiResultWithDatabaseId>