Skip to main content
PATCH
Update a worker

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The Worker id. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
displayName
string

The name the agent answers to.

roleTitle
string | null

The role it presents as. null clears it.

description
string | null

What it is for. null clears it.

Response

Success.

data
object
required