project.setCustomFieldValue

Beta

This endpoint is in beta and may not be available for all organizations.

Updates one custom field on a project, including archived projects. Returns the affected entry, including value: null when already empty.
The effective actor must have permission to edit the project. Requires Project custom fields availability; private and API-only field permissions apply. Delegated humans may preserve API-only values but cannot change or clear them.
Supports the same value types as project.create.customFields. Use null to clear an optional field; required fields cannot be cleared. Boolean false and Number zero satisfy requiredness. Multi-select inputs replace the selected values. Submit configured option values; configured archived options remain valid.
Omitted fields and unrelated project properties remain unchanged. Missing historical required fields do not block edits. New User references must identify active, nonservice users in the organization visible to the effective actor; unchanged historical references must still belong to the organization and remain visible.
Concurrent writes to the same field use the last completed update. Retrying a request can overwrite a newer value, so avoid concurrent updates to the same project.
Definition discovery retains hiringProcessMetadata:read and User discovery retains organization:read.

Requires the projectsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

An active Project custom field ID.

null
required

Canonical field value. Null clears an optional field, including when already empty.

uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The project to edit.

Response

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