Skip to main content
PATCH
Update the project's settings

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained for 30 days, after which the key may be reused. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Body

application/json
name
string | null
Required string length: 1 - 255
description
string | null

Null clears the description.

Maximum string length: 10000
primary_locale
string | null

The catalogue's source language, e.g. nl or en-US.

Required string length: 2 - 10
available_locales
string[] | null

Replaces the project's translation languages.

Maximum array length: 100
Required string length: 2 - 10
currency
string | null

ISO 4217 code, e.g. EUR. An empty string means unknown.

Maximum string length: 3

Response

OK

id
integer
required
name
string
required
status
string
required
primary_locale
string
required
available_locales
string[]
required
currency
string | null
required

ISO 4217 code of the catalogue; null when unknown.

product_count
integer
required
description
string | null
primary_industry
string | null
created_at
string<date-time> | null