Engagements

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Body application/json

• name string required

  length: at most 255

• industry string | null

  length: at most 255

• headcount integer | null

  at least 1 at most 10000000

• country string | null

  length: exactly 2

• notes string | null

  length: at most 5000

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

company path

Identifier (ULID).

Body application/json

• name string

  length: at most 255

• industry string | null

  length: at most 255

• headcount integer | null

  at least 1 at most 10000000

• country string | null

  length: exactly 2

• notes string | null

  length: at most 5000

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

company path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Body application/json

• name string required

  length: at most 255

• client_company_id string required

  length: exactly 26

• method_id string required

  length: exactly 26

• method_version_id string | null

  length: exactly 26

• locales array<string>

  items: at least 1

• default_locale string | null

  length: at most 8

• objectives string | null

  length: at most 10000

• context string | null

  length: at most 20000

• known_tools array<string>

  items: at most 60

• vocabulary array<object>

  items: at most 100

• vocabulary[].term string required

  length: at most 120

• vocabulary[].meaning string | null

  length: at most 500

• deadline_at string | null

  format date-time

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

name path

Value from a fixed list (type, language, level…).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• name string

  length: at most 255

• client_company_id string

  length: exactly 26

• method_id string

  length: exactly 26

• method_version_id string

  length: exactly 26

• context string | null

  length: at most 20000

• objectives string | null

  length: at most 10000

• vocabulary array<object>

  items: at most 100

• vocabulary[].term string required

  length: at most 120

• vocabulary[].meaning string | null

  length: at most 500

• known_tools array<string>

  items: at most 60

• locales array<string>

  items: at least 1

• default_locale string

  length: at most 8

• sharing_mode object

  one of disabled anonymized by_role

• naming_allowed boolean
• deadline_at string | null

  format date-time

• retention_raw_days integer

  at least 1 at most 3650

• retention_deliverable_days integer

  at least 1 at most 3650

• video_mode object

  one of full keyframes

• tacit_validation_days integer | null

  at least 1 at most 60

• blur_enabled boolean
• blur_categories array<string>

  one of iban card nir email phone password custom mask

• blur_custom_patterns array<object>

  items: at most 20

• blur_custom_patterns[].label string required

  length: at most 120

• blur_custom_patterns[].regex string required

  length: at most 500

• posture_overrides array<object>
• welcome_screen_overrides array<object>
• reminder_schedule array<object>
• reminder_schedule.enabled boolean
• reminder_schedule.not_started_days array<integer>

  items: at most 6

• reminder_schedule.unvalidated_days array<integer>

  items: at most 6

• cse_informed_at string | null

  format date-time

• cse_consulted_at string | null

  format date-time

• budget_cap_session number | null

  at least 0 at most 100000

• budget_cap_total number | null

  at least 0 at most 10000000

• settings array<object>
• settings.require_email_code boolean

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• text string required

  length: at most 5000

• blur_categories array<string>
• blur_custom_patterns array<object>

  items: at most 20

• blur_custom_patterns[].label string required

  length: at most 120

• blur_custom_patterns[].regex string required

  length: at most 500

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• only_not_invited boolean
• participant_ids array<string>

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• send_invitations boolean

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• user_id string required

  length: exactly 26

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

user path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

Body application/json

• subject string required

  length: at most 255

• body_markdown string required

  length: at most 20000

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• display_name string required

  length: at most 255

• email string required

  length: at most 255 format email

• role_title string required

  length: at most 255

• population_id string required

  length: exactly 26

• locale string | null

  length: at most 8

• consultant_note string | null

  length: at most 5000

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body multipart/form-data

• file file required

  length: at most 1024

• dry_run boolean
• create_populations boolean

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Body application/json

• display_name string

  length: at most 255

• email string

  length: at most 255 format email

• role_title string

  length: at most 255

• population_id string

  length: exactly 26

• locale string | null

  length: at most 8

• consultant_note string | null

  length: at most 5000

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Body application/json

• locale string | null

  length: at most 8

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Body application/json

• purpose object

  one of interview follow_up recap_reminder

• expires_in_days integer | null

  at least 1 at most 365

• requires_email_code boolean | null
• chapter_id string | null

  length: exactly 26

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

token path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

participant path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

Body application/json

• chapters array<object>

  items: at most 30

• chapters[].title string required

  length: at most 255

• chapters[].topic_keys array<string>
• chapters[].estimated_minutes integer | null

  at least 1 at most 240

• chapters[].planned_session integer | null

  at least 1 at most 20

• chapters[].origin object

  one of consultant ai_proposal ai_live analysis

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

proposalId path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

Body application/json

• locale string | null

  length: at most 8

• target_minutes integer | null

  at least 10 at most 480

• notes string | null

  length: at most 2000

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• name string required

  length: at most 255

• description string | null

  length: at most 5000

• expected_demonstrations array<string>

  items: at most 20

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• ids array<string> required

  items: at least 1

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

population path

Identifier (ULID).

Body application/json

• name string

  length: at most 255

• description string | null

  length: at most 5000

• expected_demonstrations array<string>

  items: at most 20

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

population path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• email string required

  length: at most 255 format email

• name string | null

  length: at most 255

• locale string | null

  length: at most 8

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

user path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

engagement path

Identifier (ULID).

Body application/json

• population_id string | null

  length: exactly 26

• participant_id string | null

  length: exactly 26

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

Body application/json

• subject string required

  length: at most 255

• body_markdown string required

  length: at most 20000

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

kind path

Value from a fixed list (type, language, level…).

locale path

Value from a fixed list (type, language, level…).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.