Update an application

PUT/ats/{connection_id}/application/{id}

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
idstring required
ID of the Application

Payload

idstring
candidate_idstring
job_idstring
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
status enum
Valid values:
"NEW"
"REVIEWING"
"SCREENING"
"SUBMITTED"
"FIRST_INTERVIEW"
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.
answers array
offers array
user_idstring
HR user/employee ID (reference to HrisEmployee)
metadata array
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 fieldTypeRequiredDescription
idstringNo
candidate_idstringNo
job_idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
applied_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
hired_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_reasonstringNo
sourcestringNo
statusenumNoValues: NEW, REVIEWING, SCREENING, SUBMITTED, FIRST_INTERVIEW, SECOND_INTERVIEW, THIRD_INTERVIEW, BACKGROUND_CHECK, OFFERED, ACCEPTED, HIRED, REJECTED, DECLINED, WITHDRAWN
original_statusstringNoThe integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event.
answersAtsApplicationAnswer[]No
answers[].question_idstringYes
answers[].questionstringNo
answers[].answersstring[]Yes
offersAtsOffer[]No
offers[].idstringNo
offers[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].creator_user_idstringNouser id of the recruiter who created the offer (reference to HrisEmployee)
offers[].employee_user_idstringNonewly hired employee id (reference to HrisEmployee)
offers[].sent_atstring (date-time)Nodate the offer was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].accepted_atstring (date-time)Nodate the offer was accepted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].rejected_atstring (date-time)Nodate the offer was rejected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].start_atstring (date-time)Nodate the employee starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].compensationAtsCompensation[]Nocompensation details for the offer
offers[].compensation[].typeenumNoValues: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER
offers[].compensation[].minnumberNo
offers[].compensation[].maxnumberNo
offers[].compensation[].currencystringNo
offers[].compensation[].frequencyenumNoValues: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK
offers[].statusenumNoValues: CREATED, SENT, ACCEPTED, REJECTED
user_idstringNoHR user/employee ID (reference to HrisEmployee)
metadataAtsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNoActual textual value of the slug
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
original_substatusstringNoThe provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)
summarystringNoApplication 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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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: 'PUT',
  url: 'https://api.unified.to/ats/5de520f96e439b002043d8dc/application/5de520f96e439b002043d8d8',
  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?