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": "1de61fc9-97f9-410d-8eca-515ef62ff842",
  "userId": "7c8492c4-ebeb-44e3-b171-ffcd65027003",
  "agencyId": "a367d696-dffd-4eb3-ac2b-1569b2890b80"
}

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>a367d696-dffd-4eb3-ac2b-1569b2890b80</AgencyId>
  <MessageSubscriptionId>1de61fc9-97f9-410d-8eca-515ef62ff842</MessageSubscriptionId>
  <UserId>7c8492c4-ebeb-44e3-b171-ffcd65027003</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": "d28cc2da-7d25-410b-a616-7a2c0169f675",
  "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>d28cc2da-7d25-410b-a616-7a2c0169f675</DatabaseId>
</NowCertsApiResultWithDatabaseId>