API documentation | API docs for agents | OpenAPI 3.1

{locationId}

ark.delete_location

Archives a visible location using the same soft-delete behavior as the ARK UI.

Availability: Expanded preview
Scopes: locations:write
ARK permissions: canDeleteLocation
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

locationIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

None.

Example request

Shell

curl -X DELETE 'https://arktms.com/api/v1/locations/<locationId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Archived location

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.idstringrequired

format: uuid

data.deletedbooleanrequired

one of: true

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found