---
title: "Add a candidate record."
method: POST
path: "/api/external/candidate/add"
tags: ["Candidate APIs"]
---

# Add a candidate record.

`POST /api/external/candidate/add`

<br/><b>Please find the format of custom field input below.</b><br/><li> Single select:<br/>{<br/> "id": single_select_cf_id,<br/> "value": "string"<br/>}<br/></li><br/><br/><li> Multi select :<br/>{<br/> "id": multi_select_cf_id,<br/> "value": ["string1", "string2"]<br/>}<br/></li><br/><br/><li> Short/Long text:<br/>{<br/> "id": short_text_cf_id,<br/> "value": "text"<br/>}</li><br/><br/><li> Money:<br/>{<br/>  "id": money custom field id,<br/>  "value": {"number": Integer(The amount), "currency": "string(Currency code eg. USD, GBP)"}<br/>}<br/><br/><li> Money Range:<br/>{<br/>  "id": money reange custom field id,<br/>  "value": {"number1": Integer(Starting Amount), "number2": "Ending Amount", "currency": "string(Currency code eg. USD, GBP)"}<br/>}<br/><br/><li> Number/Date:<br/>{<br/> "id": cf_id,<br/> "value": number/date to store<br/>}<br/></li><br/><br/><li> Yes No:<br/>{<br/> "id": yes_no_cf_id,<br/> "value": 0 for No and 1 for Yes<br/>}</li><br/><br/><li> Profile :<br/>{<br/> "id": profile_cf_id,<br/> "value": [{"id": profile_id, "type": entity_type(Candidate, Contact, Company)}]<br/>}</li><br/><br/><li> Parent-Child :<br/>{<br/> "id": parent-child-cf-id,<br/> "value": [{"name": "parent_name", "children": ["child1", "child2"]}]<br/>}</li><br/><br/><li> Users:<br/>{<br/> "id": users_cf_id,<br/> "value": [integer_user_id_1, integer_user_id_1]<br/>}</li><br/>

## Headers

- `RF-Api-Key` string, required
- `content-type` string

## Request body

- object
  - `added_time` string
  - `angellist_profile` string
  - `custom_fields` object[]
    - `id` integer
    - `value` string
  - `education` object[]
    - `degree` string
    - `school` string
    - `specialization` string
  - `email` object[]
    - `email` string
    - `is_primary` integer
  - `experience` object[]
    - `designation` string
    - `organization` string
  - `facebook_profile` string
  - `github_profile` string
  - `lead_owner_id` integer
  - `linkedin_profile` string
  - `location` object
    - `city` string
    - `country` string
    - `postal_code` string
    - `state` string
  - `name` string
  - `organization` string
  - `phone_number` object[]
    - `phone_number` string
    - `type` integer
  - `skills` string[]
  - `source` string
  - `tags` string[]
  - `title` string
  - `twitter_profile` string
  - `websites` string[]

## Response `200`

Auto generated using Swagger Inspector

- object
  - `RESULT` string
  - `data` object
    - `id` integer

## Changes

- **2026-08-13** `febc104d89ff` — 1 breaking
  - the `header` request parameter `RF-Api-Key` became required

[Change history](https://skmtc.dev/recruiterflow/apis/recruiterflow-api-documentation/changes/api/external/candidate/add/post.md)

---

[API](https://skmtc.dev/recruiterflow/apis/recruiterflow-api-documentation.md) · [All operations](https://skmtc.dev/recruiterflow/apis/recruiterflow-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/recruiterflow/recruiterflow-api-documentation/revisions/febc104d89ff/schema)