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": "0f575110-a033-4d7a-b13c-3cd87c3ba527",
  "userId": "e540508f-8266-4866-a9ba-2221f07fdb13",
  "agencyId": "be25fffe-7924-4725-8111-af099de61284"
}

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>be25fffe-7924-4725-8111-af099de61284</AgencyId>
  <MessageSubscriptionId>0f575110-a033-4d7a-b13c-3cd87c3ba527</MessageSubscriptionId>
  <UserId>e540508f-8266-4866-a9ba-2221f07fdb13</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": "71737b05-857e-4db1-a524-646eaa4f2037",
  "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>71737b05-857e-4db1-a524-646eaa4f2037</DatabaseId>
</NowCertsApiResultWithDatabaseId>