v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Contexts

Create or update context kind

Create or update a context kind by key. Only the included fields will be updated.

put/api/v2/projects/{projectKey}/context-kinds/{key}

projectKeystring string required

The project key

keystring string required

The context kind key

namestring required

The context kind name

descriptionstring

The context kind description

hideInTargetingboolean

Alias for archived.

archivedboolean

Whether the context kind is archived. Archived context kinds are unavailable for targeting.

versioninteger

The context kind version. If not specified when the context kind is created, defaults to 1.

{
  "name": "organization",
  "description": "An example context kind for organizations",
  "version": 1
}

Context kind upsert response

statusstring

The status of the create or update operation

_linksobject

The location and content type of related resources

{
  "status": "success"
}