Cancelling Orders
To stop the process of data retrieval for user from your Human API Application, send a POST request with your client token to the actions endpoint.
Cancelling order will also stop notifications, and remove any subscriber for that order.
Request Parameters
Only one of either of the unique identifiers (clientUserId or humanId) is required. If both are supplied the request will be rejected.
| Parameter | Description |
|---|---|
| clientUserId | The clientUserId value sent while submitting the order. |
| humanId | The humanId value received after |
| action | Set the value to "abort" |
Example of the request
POST /api/v1/users/actions HTTP/1.1
Host: admin.humanapi.co
Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer your-client-token
{
"clientUserId":"your-policy-number",
"action":"abort"
}
Response Codes
| 202 | We have received your request to cancel the order. |
| 400 | If post parameters are missing or are incorrect |
| 404 | The resource id (humanId/clientUserId) is not found, or was disabled. |
| 409 | Conflict -- the order is in a state where it can’t be cancelled. (Currently, a completed or cancelled state blocks this) |
| 429 | Too many requests |
Example of response - 202 ACCEPTED
Response
A successful request returns a status code 202, does not include a response body.
Updated about 1 year ago