Skip to main content
PATCH
update_domain

Authorizations

X-API-Key
string
header
required

Path Parameters

domain_id
string<uuid>
required

Domain version identifier.

Body

application/json

Any subset of the create request.

Editing a draft mutates it. Editing a published domain creates version n+1 as a new draft and leaves version n untouched — there is no way to change the vocabulary under a live corpus, because a workspace that could not explain its own folder structure is worse than one with an old vocabulary.

display_name
string | null
Required string length: 1 - 200
taxonomy
Taxonomy · object | null

The classification vocabulary.

Response

Successful Response

domain
Domain · object
required

A domain with its effective taxonomy already resolved.

A caller reading a domain wants the taxonomy that will actually be applied, not a delta they have to merge themselves.

validation
DomainValidation · object
required

Returned on every domain write, so a caller never has to guess whether a publish will succeed.