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": "dc8cd218-936c-4d68-a76f-b322cfbb1026",
  "userId": "383863bb-fda3-44c4-88d2-119f7f64108b",
  "agencyId": "48643e5d-3a06-44cd-b6cf-c8a7dfc58c47"
}

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>48643e5d-3a06-44cd-b6cf-c8a7dfc58c47</AgencyId>
  <MessageSubscriptionId>dc8cd218-936c-4d68-a76f-b322cfbb1026</MessageSubscriptionId>
  <UserId>383863bb-fda3-44c4-88d2-119f7f64108b</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": "21b7197b-b953-4165-a022-9acb6570fa87",
  "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>21b7197b-b953-4165-a022-9acb6570fa87</DatabaseId>
</NowCertsApiResultWithDatabaseId>