Skip to main content
DELETE
Delete all custom field values for an entity

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

entityType
enum<string>
required

Entity type: candidate or job. The entity a custom field applies to.

Available options:
candidate,
job
entityId
integer
required

The ID of the candidate or job.

Query Parameters

parentEntityType
string

Restrict deletion to values with this parent entity type (e.g. work_experience).

parentEntityId
integer

Restrict deletion to values with this parent entity ID. For work experiences this is the work experience's unique ID, typically an epoch timestamp.

Response

Custom field values deleted. The source documentation does not include a response example for this endpoint; see the schema's inference note.

Envelope returned after deleting all custom field values for an entity. Response schema inferred from related endpoints; not yet verified against production behavior.

status
enum<string>
required

Always success for successful requests.

Available options:
success
message
string
required

Confirmation message.

Example:

"Custom field values deleted successfully"