Skip to main content
POST
Create, change or delete a candidate tag

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
action
enum<string>
required

create: a new tag (any writer); update: rename or recolour (owners only); delete: remove the tag from every candidate and delete it (owners only, no undo).

Available options:
create,
update,
delete
merchant_id
string<uuid>

Optional company to work on. Admins and sub-merchant operators only; other callers always use their token's company.

id
string<uuid>

Tag id (profile_interview_tag.id); required for update and delete.

name
string

Tag name, 1 to 60 characters, unique in the company (case ignored); required for create.

Maximum string length: 60
color
enum<string>

Colour: default (the default for create), accent, success, warning or danger.

Available options:
default,
accent,
success,
warning,
danger
dry_run
boolean
default:false

With delete: changes nothing and answers which tag would be deleted and from how many candidates. The owner-only rule is checked by the real call only.

Response

Done (or, with dry_run, what would be done).

data
object
required