Skip to main content
PATCH
Update an organization

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

organizationId
string
required
Minimum string length: 1

Body

application/json
name
string
Required string length: 1 - 200
slug
string
logo
string<uri> | null
metadata
object | null

Response

The updated organization.

id
string
required

Unique organization ID.

name
string
required

Display name.

slug
string
required

Unique URL-safe identifier (lowercase letters, digits, and hyphens).

logo
string | null
required

Logo URL, or null when unset.

metadata
object | null
required

Arbitrary key–value metadata attached to the organization. null when unset.

createdAt
string<date-time>
required

When the organization was created.