Clear a custom field's value for an entity

DELETE

https://app.brightmove.com/ATS/api/v1/udf/:entityTypeId/:guid/fields/:fieldGk

Clears this field’s value for the entity — there is no separate value resource to delete, so this is the only way to unset a field. The field definition itself (and its options, for SELECT fields) is not affected and remains available for other entities/values. Clearing a field that has no value set is a no-op.

Authentication

AuthorizationBearer

BrightMove OAuth2 client_credentials - use the client_id/client_secret from User > API Keys (or an admin-managed client).

Path parameters

entityTypeIdintegerRequired

Numeric entity type id (e.g. 5 = Requirement/Job)

guidstringRequired

GUID of the entity to clear the value on

fieldGklongRequired

Numeric id of the field definition, from GET …/definitions

Response

Value cleared

Errors

404

Not Found Error