Skip to main content
PATCH
Update account

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

account_id
string<uuid>
required

Body

application/json
name
string

New account name. Omitted, the current name remains unchanged.

Required string length: 1 - 100
slug
string

New account slug. Omitted, the current slug remains unchanged; a duplicate returns 409.

Maximum string length: 63
Pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$

Response

Updated account

id
string<uuid>
required

Account UUID remains unchanged when account details are updated.

slug
string
required
name
string
required
kind
enum<string>
required
Available options:
personal,
team
created_at
string
required
updated_at
string
required
membership
object
required

The caller's own membership in this account, including their resolved role and capabilities.