Skip to main content
POST
/
actions
/
{actionId}
/
cancel
curl
curl --request POST \
  --url 'https://api.amps.ai/actions/act_abc123/cancel' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{ "success": true, "data": { "id": "act_2026050709a1b2c3", "deviceId": "device_abc123", "deviceType": "battery", "command": "charge", "parameters": { "target": { "value": 100, "unit": "percent" } }, "state": "cancelled", "result": null, "errorCode": null, "errorMessage": null, "createdAt": "2026-05-07T08:00:00.000Z", "updatedAt": "2026-05-07T11:32:00.000Z", "acknowledgedAt": null, "completedAt": "2026-05-07T11:32:00.000Z", "start": "2026-06-01T02:00:00.000Z", "end": null, "links": { "self": "/actions/act_2026050709a1b2c3" } }, "meta": { "requestId": "req_8a2Bf3kP", "environment": "sandbox", "timestamp": "2026-06-02T12:00:00.000Z", "latencyMs": 12 } }

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
actionId
string
required

The unique identifier for the action to cancel.

Example:

"act_abc123"

Response

Action cancelled successfully.

​
success
boolean
required

Always true for success responses.

​
data
Action Response · object
required

Persistent state of a device action across its lifecycle. Mirrors the dispatch: command is the canonical verb, parameters the constraints, deviceType the device family (which discriminates the shape). Lifecycle states, timestamps, the result envelope, and links are universal.

​
meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.