Update organization

Updates profile fields on an organization. Requires owner or admin role in the organization.

PATCH /organizations/{id}

Update organization

cURL

curl --request PATCH \
  --url https://api.akua.dev/v1/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "name": "<string>",
  "slug": "<string>"
}
'

200

{}

Authorizations

Authorization · string · header · required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

if-match · string · required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256

Example:

"42"

Path Parameters

id · string · required

Organization ID. Prefixed form org_<id> is canonical.

Required string length: 1 - 54

Example:

"org_j572abc123def456"

Body

application/json

name · string

Required string length: 2 - 50

Pattern: ^[\p{L}\p{N}](?:[\p{L}\p{N}\s\-'&.]*[\p{L}\p{N}])?$/u

slug · string

Required string length: 3 - 39

Pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

Response

200

application/json

Organization updated

ok · enum<boolean> · required

Available options: true