Define a Custom Field and Set Its Value

Define a Custom Field and Set Its Value

Create a custom field definition and write a value to a record with it.

1. Define the custom field against its object type. Nothing can be written to a custom field until this definition exists, so this precedes any attempt to set a value.
2. List the organization's custom fields to confirm the new definition is registered and visible, excluding archived fields.
3. Write the value onto the target record. Custom field values do not go through candidate.update or job.update — customField.setValue is the only path, and objectType here must match the type the field was defined for.
4. Read the field definition back to confirm its final shape, including any selectable values that were registered with it.

What you'll need to have ready

• fieldType: The type of the field (e.g. String, Number, Date, Boolean, ValueSelect, MultiValueSelect).
• objectType: The object the field attaches to (Application, Candidate, Job, or Opening).
• title: The title of the custom field.
• description: A description of what the field holds.
• selectableValues: The allowed values, required when fieldType is ValueSelect or MultiValueSelect.
• objectId: The id of the record to set the field value on.
• fieldValue: The value to store, typed to match fieldType (string, number, boolean, or array depending on the field).

For your developer

Arazzo workflow ashby-hq:custom-field-setup, 4 operations: customFieldCreate → customFieldList → customFieldSetValue → customFieldInfo. Specs on APIs.io.