Create an application
POST/ats/{connection_id}/application
Creates a AtsApplication. Provide the unified AtsApplication fields in the request body; they are mapped to the provider's API. Returns the created AtsApplication.
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
candidate_idstring
The ID of the candidate who is applying (an AtsCandidate ID)
job_idstring
The ID of the job being applied to (an AtsJob ID)
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
applied_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
hired_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_reasonstring
sourcestring
original_statusstring
The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event.
user_idstring
HR user/employee ID (reference to HrisEmployee)
original_substatusstring
The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)
summarystring
Application personal summary (e.g. Pinpoint Personal Summary)
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
candidate_id | string | No | The ID of the candidate who is applying (an AtsCandidate ID) |
job_id | string | No | The ID of the job being applied to (an AtsJob ID) |
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) |
applied_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
hired_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
rejected_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
rejected_reason | string | No | |
source | string | No | |
status | enum | No | Values: NEW, REVIEWING, SCREENING, SUBMITTED, FIRST_INTERVIEW, SECOND_INTERVIEW, THIRD_INTERVIEW, BACKGROUND_CHECK, OFFERED, ACCEPTED, HIRED, REJECTED, DECLINED, WITHDRAWN |
original_status | string | No | The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event. |
answers | AtsApplicationAnswer[] | No | |
answers[].question_id | string | Yes | |
answers[].question | string | No | |
answers[].answers | string[] | Yes | |
offers | AtsOffer[] | No | |
offers[].id | string | No | |
offers[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].creator_user_id | string | No | user id of the recruiter who created the offer (reference to HrisEmployee) |
offers[].employee_user_id | string | No | newly hired employee id (reference to HrisEmployee) |
offers[].sent_at | string (date-time) | No | date the offer was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].accepted_at | string (date-time) | No | date the offer was accepted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].rejected_at | string (date-time) | No | date the offer was rejected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].start_at | string (date-time) | No | date the employee starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].compensation | AtsCompensation[] | No | compensation details for the offer |
offers[].compensation[].type | enum | No | Values: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER |
offers[].compensation[].min | number | No | |
offers[].compensation[].max | number | No | |
offers[].compensation[].currency | string | No | |
offers[].compensation[].frequency | enum | No | Values: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK |
offers[].status | enum | No | Values: CREATED, SENT, ACCEPTED, REJECTED |
user_id | string | No | HR user/employee ID (reference to HrisEmployee) |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
original_substatus | string | No | The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage) |
summary | string | No | Application personal summary (e.g. Pinpoint Personal Summary) |
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/application',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?