jobPosting.setCustomFieldValue

Beta

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

Updates one custom field on a job posting. Returns the affected entry, including value: null when the field is empty.

The effective actor must have permission to edit the job that owns the posting. Requires Job Posting custom fields to be enabled; private and API-only field permissions apply.

Supports String, LongText, Boolean, Number, Date, ValueSelect, MultiValueSelect and Url fields. Use null to clear an optional field; required fields cannot be cleared. Boolean false and Number 0 are values, not absences. Multi-select inputs replace the selected values.

Omitted fields and unrelated posting properties remain unchanged. Discover definitions with customField.list.

Requires the jobsWrite 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 Job Posting custom field ID.

null
required

Canonical field value: text, boolean, finite number, configured option values, or ISO date or timestamp. 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 job posting 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