Replace candidate tags

PUT

/api/nova/candidates/{candidateId}/tags

Replaces the candidate's entire tag set with the tags supplied in the request; existing tags not present in the request are removed. The tags field is required and sending an empty list clears all tags. Each tag has a value and an optional group; entries with a blank value are skipped. Responds with 400 when tags is missing, 404 when the candidate does not exist, and returns the candidate ID on success.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

candidateId*

candidateId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"tags": [

  

  

{

  

  

  

"group": "string",

  

  

  

"value": "string"

  

  

}

  

]

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/candidates/{candidateId}/tags

Playground

Authorization

privateApiKey

Variables

Key

Value

candidateId*

apiKey*

Body

Samples