Skip to main content
PUT
Update organization

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json
metadata
Metadata · object | null

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

name
string | null

Updated organization name.

Maximum string length: 255
country
string<iso3166-alpha2> | null

ISO 3166-1 alpha-2 country code (US, CA, GB). Case-insensitive on input and normalized to upper case; unassigned codes are rejected with a 422.

Required string length: 2
Pattern: ^[A-Za-z]{2}$
is_brand
boolean | null

Whether this organization is a product brand with authority over product content.

Response

OK

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Organization name.

country
string
required

ISO 3166-1 alpha-2 country code.

is_brand
boolean
required

Whether this organization is a brand owner.

metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.