Delete intents (single or multiple)

Delete intents (single or multiple)

delete

Delete one or more intents by their IDs. Only intents that have not been sent (notified_at is null) can be deleted. If any of the intents have been sent, the entire operation will fail and return a 422 error with the IDs of sent intents. You can pass a single intent ID in the array to delete just one intent.

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Body

application/json

intent_idsstring[]Required

Array of intent IDs to delete

Responses

200

All intents deleted successfully

application/json

successbooleanOptionalExample: true

deleted_countintegerOptional

Number of intents successfully deleted

400

Bad request - invalid parameters

application/json

401

Unauthorized

404

No valid intents found

application/json

422

Cannot delete intents that have already been sent

application/json

delete

/intents/bulk_destroy

HTTPcURLJavaScriptPython

DELETE /api/v1/external/intents/bulk_destroy HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "intent_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete single intentDelete multiple intents

{
  "success": true,
  "deleted_count": 1
}