Skip to main content
PATCH
Update an assessment

Authorizations

Authorization
string
header
required

Your API key, live (sk_live_…) or test (sk_test_…). Create one in Settings → API keys. Send it as Authorization: Bearer <key> — never in a query string.

Path Parameters

id
string<uuid>
required

The assessment id.

Body

application/json
name
string

1–200 chars.

status
enum<string>

closed stops new invitations; archived also hides it from listings.

Available options:
active,
closed,
archived

Response

Success.

Every successful response. meta carries the request id and any pagination.

data
object
required

The resource, or an array of them.

meta
object
required