DELETE api/sms/unsubscribe-from-inbound-message
Request Information
URI Parameters
None.
Body Parameters
UnsubscribeForInboundMessageRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageSubscriptionId | globally unique identifier |
None. |
|
| UserId | globally unique identifier |
None. |
|
| AgencyId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"messageSubscriptionId": "4476dbfe-c8fd-4cea-9768-10875adb1033",
"userId": "62cbcd10-23bb-4fc9-80d0-22579b364ded",
"agencyId": "e2286a0d-5654-4156-9612-752d52e4be81"
}
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>e2286a0d-5654-4156-9612-752d52e4be81</AgencyId> <MessageSubscriptionId>4476dbfe-c8fd-4cea-9768-10875adb1033</MessageSubscriptionId> <UserId>62cbcd10-23bb-4fc9-80d0-22579b364ded</UserId> </UnsubscribeForInboundMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultWithDatabaseId| Name | Description | Type | Additional information |
|---|---|---|---|
| DatabaseId | globally unique identifier |
None. |
|
| Status | ApiStatus |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"databaseId": "fe7d0de5-b8e2-471e-969c-5c6f925fcb53",
"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>fe7d0de5-b8e2-471e-969c-5c6f925fcb53</DatabaseId> </NowCertsApiResultWithDatabaseId>