Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.addTag

Adds a tag to a candidate.

Requires the candidatesWrite permission.

post/candidate.addTag

Request body

candidateIdstring uuid required

The unique id of the candidate to add the tag to

tagIdstring uuid required

The unique id of the tag to add to the candidate

Example request

{
  "candidateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "tagId": "38430ede-5bd2-41fc-b474-87591cb98cbc"
}

Response

Responses from the candidate.addTag endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z",
    "name": "Adam Hart",
    "primaryEmailAddress": {
      "value": "adam.hart@example.com",
      "type": "Personal",
      "isPrimary": true
    },
    "emailAddresses": [
      {
        "value": "adam.hart@example.com",
        "type": "Personal",
        "isPrimary": true
      }
    ],
    "primaryPhoneNumber": null,
    "phoneNumbers": [],
    "socialLinks": [],
    "tags": [],
    "applicationIds": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "resumeFileHandle": null,
    "fileHandles": [],
    "profileUrl": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "source": null,
    "creditedToUser": null,
    "timezone": null,
    "fraudStatus": null
  }
}