Create a candidate
POST/ats/{connection_id}/candidate
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
first_namestring
last_namestring
titlestring
Candidate’s current job title
company_namestring
Name of company where candidate currently works
image_urlstring
tagsstring array
external_identifierstring
link_urlsstring array
URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)
company_idstring
(reference to AtsCompany)
sourcesstring array
date_of_birthdate-time
user_idstring
Employee ID that owns the relationship for this candidate (reference to HrisEmployee)
user_idsstring array
references hris employees
web_urlstring
skillsstring array
job_idsstring array
summarystring
Personal / professional bio
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
first_name | string | No | |
last_name | string | No | |
emails | AtsEmail[] | No | |
emails[].name | string | No | |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
title | string | No | Candidate’s current job title |
telephones | AtsTelephone[] | No | |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
company_name | string | No | Name of company where candidate currently works |
image_url | string | No | |
tags | string[] | No | |
address | object | No | |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
external_identifier | string | No | |
link_urls | string[] | No | URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.) |
origin | enum | No | Values: AGENCY, APPLIED, INTERNAL, REFERRED, SOURCED, UNIVERSITY |
company_id | string | No | (reference to AtsCompany) |
sources | string[] | No | |
date_of_birth | string (date-time) | No | |
user_id | string | No | Employee ID that owns the relationship for this candidate (reference to HrisEmployee) |
user_ids | string[] | No | references hris employees |
web_url | string | No | |
experiences | AtsCandidateExperience[] | No | |
experiences[].company_name | string | No | |
experiences[].title | string | No | |
experiences[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
experiences[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
education | AtsCandidateEducation[] | No | |
education[].institution | string | No | |
education[].level | string | No | |
education[].degree | string | No | |
education[].field_of_study | string | No | |
education[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
education[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
skills | string[] | No | |
job_ids | string[] | No | |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | Actual textual value of the slug |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
summary | string | No | Personal / professional bio |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/ats/5de520f96e439b002043d8dc/candidate',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know