Update project settings

Changes any of the project's settings (JSON merge-patch): send only the sections and fields that change; lists are replaced as a whole. Imports and exports that start, or are queued without their own settings, use the new values; existing keys and texts aren't rewritten. Integration settings apply from the next sync. All changes are applied together or not at all. Requires project-level settings management permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^pr_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde

Body Params

Request body to change a project's settings (JSON merge-patch): send only the sections and fields that change, also inside the sections of format. Lists are replaced as a whole; null removes a format section.

export
object

Export defaults.

import
object

Import defaults.

format

File-format options. Null removes them, which only documents and integration projects allow.

keys
object

Key normalisation.

placeholders
object

Placeholder recognition.

integrations
object

Integration settings; only for a project that has an integration.

Headers
string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json