API Reference

customField.setReferenceIdentifier

post
https://api.ashbyhq.com/customField.setReferenceIdentifier

Beta

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

Assign, change, or remove a custom field's reference ID. Read the current ID with customField.info and pass it as expectedReferenceIdentifier (null if unset). Pass referenceIdentifier: null to remove the ID. A removed ID can be reused.
If another field holds the ID, errorInfo.meta.conflictingCustomFieldId identifies it when this API key can access that field. Management must be enabled for the organization.

Requires the hiringProcessMetadataWrite 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)$

The UUID of the custom field definition to update.

required
length between 1 and 128
^[a-z][a-z0-9_]{0,127}(?![\s\S])

Beta. This feature is in beta and may not be available for all organizations. The new reference ID. Pass null to clear the current reference ID.

Beta. This feature is in beta and may not be available for all organizations. The reference ID assigned to the custom field, for example cost_center. Use the value exactly as saved.

required

The exact current reference ID returned by customField.info or customField.list. Pass null for initial assignment. A mismatch rejects the update to prevent overwriting a concurrent change.

Response

Updated about 1 hour ago

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

Updated about 1 hour ago