Skip to main content
PUT
Update a custom field

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Path Parameters

customFieldId
integer
required

The unique identifier of the custom field to update. The published documentation types this parameter as a string, but this specification models the underlying integer identifier used by the API.

Body

application/json

Request body for updating a custom field definition. All fields are optional, but at least one must be provided. fieldType and entityType are immutable and cannot be updated after creation.

fieldLabel
string

Updated display name.

parentSection
string

Updated parent section. Allowed values depend on the field's entityType.

For candidate: Personal Details, Social Contacts, Experience, Education, Skills, Miscellaneous.

For job: Job Overview, Job Description, Job Pipeline Stages, Location, Revenue Details, Client Company Details, Salary Details, Candidate Requirements, Candidate Form Requirements, Screening Questions.

options
string[]

Updated options (for select and multi-select fields). Must be non-empty.

Minimum array length: 1
description
string

Updated description.

Response

Custom field updated.

Envelope returned after updating a custom field definition.

status
enum<string>
required

Always success for successful requests.

Available options:
success
message
string
required

Confirmation message.

Example:

"Custom field updated successfully"

data
object
required

A custom field definition (field template) for candidates or jobs.