SmartRecruiters ATS API Integration Vol.2

These are the list of integration use cases supported by Knit for SmartRecruiters ATS API as part of the ATS category

Update Candidate Status in Interview Timeslot

ID: put_update_candidate_status_in_interview_timeslot
Operation: write
Entities: timeslot, candidate status, interview
Summary: This API updates the candidate's status for a specific interview timeslot. It requires the interview ID and timeslot ID as path parameters. The request body must include the new status of the candidate, which can be 'accepted', 'declined', 'pending', or 'tentative'. The API returns a 204 status code if the update is successful. If the user is forbidden to change the status, a 403 error with a detailed message is returned. Other possible error responses include 404 for not found errors and 422 for input validation failures.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_candidate_tags
Operation: write
Entities: tag, candidate
Summary: The Update Candidate Tags API allows you to update the tags for a specific candidate by replacing all existing tags with a new array of tags provided in the request body. The request requires the candidate's identifier as a path parameter and a JSON body containing an array of tags. The response will return a 201 status code with the updated tags if successful, or a 403 status code if there is no permission to access the candidate.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_candidates_job_status
Operation: write
Entities: status, job, candidate
Summary: This API endpoint allows updating a candidate's status for a specific job. The request requires the candidate's ID and job ID as path parameters. The request body must include the 'status' field, which can be one of several predefined values such as 'LEAD', 'NEW', 'IN_REVIEW', etc. Optional fields include 'subStatus', 'startsOn', and 'reason'. The response will be a 204 status code for a successful update, or an error message with a 400, 401, 403, or 404 status code if there are issues such as missing reasons, permission denial, or candidate-job mismatch.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_candidates_source
Operation: write
Entities: source, job, candidate
Summary: This API endpoint is used to update a candidate's source for a specific job. It requires the candidate identifier and job identifier as path parameters. The request body must include the sourceTypeId and sourceId, with an optional sourceSubTypeId. The API returns a 204 status code on success. On failure, it returns error messages with codes such as INVALID_SOURCE_TYPE, SUBTYPE_REQUIRED, and INVALID_SOURCE for a 400 response, Candidate access denied for a 401 response, and Candidate is not assigned to given job for a 404 response.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_job_ad
Operation: write
Entities: job, job ad, location
Summary: This API endpoint allows you to update an existing job ad by sending a PUT request to the specified URL with the jobId and jobAdId as path parameters. The request must include headers for 'accept' and 'content-type' set to 'application/json'. The request body should contain the job ad details including the title, language, location, and job ad descriptions. The response will return the updated job ad details including the id, title, language, location, job ad descriptions, creation and update timestamps, posting status, and visibility. Note that changes will only be reflected on internal sources and job aggregators after publishing the job ad.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_job_and_jobad
Operation: write
Entities: job, job ad, location
Summary: This API endpoint allows you to update a job and its associated jobAd by providing a job ID in the path and the new state of the job in the request body. The request must include the job's title, function, industry, experience level, and location. The jobAd and all its properties must be provided, as any missing properties will be removed. The API returns the updated job with its jobAd. The response includes details such as the job's ID, title, reference number, creation and update timestamps, department, location, status, posting status, target hiring date, industry, function, type of employment, experience level, EEO category, template status, creator information, compensation details, jobAd sections, and available actions. The API handles various error responses, including department, industry, function, type of employment, job ad language, and EEO category not found errors, as well as input validation failures.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_job_note
Operation: write
Entities: job, note
Summary: This API endpoint allows updating the note of a specific job identified by the jobId. The request requires the jobId as a path parameter and the note content in the request body. The content must be a string with a maximum length of 20,000 characters. The response will return the updated note content if successful (HTTP 200) or an error message if access is forbidden (HTTP 401).
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_job_position
Operation: write
Entities: position, job
Summary: The Update Job Position API allows updating the details of a specific job position identified by jobId and positionId. The request requires path parameters jobId and positionId, and a JSON body with fields type, positionOpenDate, and targetStartDate. The response can be a 201 status with updated position details, a 403 status indicating permission issues, or a 404 status if the position is not found.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_job_status
Operation: write
Entities: status, job
Summary: The Update Job Status API allows users to update the status of a job identified by the jobId path parameter. The request requires a JSON body with a 'status' field, which can be one of the following values: CREATED, SOURCING, FILLED, INTERVIEW, OFFER, CANCELLED, or ON_HOLD. The API returns a 201 status code with the updated status if successful. If the job access is forbidden, a 403 status code is returned with an error message. If the job is not found, a 404 status code is returned with an error message.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_update_user_avatar
Operation: write
Entities: user, avatar, file
Summary: This API endpoint allows updating the avatar of a user identified by the user ID in the path parameter. The request must include a binary file in the body with the 'multipart/form-data' content type. The response will be a 204 status code if successful. Errors may include 400 for unmarshalling errors, 403 for permission denied, and 404 if the user is not found. The request headers must include 'accept' and 'content-type'.
Input Fields: Input Fields
Output Fields: Output Fields

ID: reject_an_application
Operation: write
Entities:
Summary: This API endpoint allows updating a candidate's status for a specific job. The request requires the candidate's ID and job ID as path parameters. The request body must include the 'status' field, which can be one of several predefined values such as 'LEAD', 'NEW', 'IN_REVIEW', etc. Optional fields include 'subStatus', 'startsOn', and 'reason'. The response will be a 204 status code for a successful update, or an error message with a 400, 401, 403, or 404 status code if there are issues such as missing reasons, permission denial, or candidate-job mismatch.
Input Fields: Input Fields
Output Fields: Output Fields