Update Candidates
/unified/ats/candidates/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
Breezy company ID; the connected account company is used when omitted.
1 supported
Position containing the candidate.
1 supported1 required
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The candidate's attachments
1 supported
The attachment's unique identifier
The attachment's application
1 property
Unique identifier of the application
The attachment's type
The attachment's candidate
1 property
Unique identifier of the candidate
The date and time of the attachment's creation
The attachment's file_name
The attachment's file_url
The attachment's job
1 property
Unique identifier of the job
The date and time of the attachment's last update
Mapped to the inverse of Teamtailor unsubscribed.
1 supported
Candidate email addresses; Teamtailor requires a unique email for this mapping.
3 supported
The candidate's email
The candidate's email type
Candidate first name.
2 supported
Candidate last name.
2 supported
The candidate's locations
3 supported
The user's full name
3 supported
The candidate's phone numbers
3 supported
The candidate's phone number
The extension of the phone number
The candidate's phone number type
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.
Supplying tags replaces the provider's complete tag array.
3 supported
The tag's unique identifier
The tag's name
The candidate's title
2 supported
The candidate's urls
3 supported
The candidate's URL
The candidate's URL type
Response Body
The candidate's unique identifier
3 supported
The candidate's applications
2 supported
The date and time of the application's creation
The application's attachments
9 properties
The attachment's unique identifier
The attachment's application
1 property
Unique identifier of the application
The attachment's type
The attachment's candidate
1 property
Unique identifier of the candidate
The date and time of the attachment's creation
The attachment's file_name
The attachment's file_url
The attachment's job
1 property
Unique identifier of the job
The date and time of the attachment's last update
The application's candidate
1 property
Unique identifier of the candidate
The date and time of the application's creation
The application's credited_to
4 properties
3 properties
Email of the user
Whether the email is primary
Type of the email
First name of the user
Unique identifier of the user
Last name of the user
The application's current_stage
5 properties
The date and time of the application's current_stage's creation
The application's current_stage's unique identifier
The application's current_stage's job
1 property
Unique identifier of the job
The application's current_stage's name
The date and time of the application's current_stage's last update
The application's unique identifier
The application's job
1 property
Unique identifier of the job
The application's reject_reason
The date and time of the application's rejection
The application's source
2 properties
The application's source's unique identifier
The application's source's name
The date and time of the application's last update
The candidate's attachments
1 supported
The attachment's unique identifier
The attachment's application
1 property
Unique identifier of the application
The attachment's type
The attachment's candidate
1 property
Unique identifier of the candidate
The date and time of the attachment's creation
The attachment's file_name
The attachment's file_url
The attachment's job
1 property
Unique identifier of the job
The date and time of the attachment's last update
Whether the candidate can email
1 supported
The candidate's company
The date and time of the phone number's creation
3 supported
The candidate's emails
3 supported
The candidate's email
The candidate's email type
The candidate's first_name
2 supported
Whether the candidate is_private
1 supported
The candidate's last_interaction date
The candidate's last_name
2 supported
The candidate's locations
3 supported
The user's full name
3 supported
The candidate's phone numbers
3 supported
The extension of the phone number
The candidate's phone number
The candidate's phone number type
Raw data returned from the remote API call.
The candidate's tags
3 supported
The tag's unique identifier
The tag's name
The candidate's title
2 supported
The date and time of the phone number's last update
3 supported
The candidate's urls
3 supported
The candidate's URL type
The candidate's URL
truto unified ats candidates '<resource_id>' \
-m update \
-a '<integrated_account_id>' \
-b '{
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": true,
"attachments": [],
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.update(
'ats',
'candidates',
'<resource_id>',
{
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": true,
"attachments": [],
"remote_data": {}
},
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
result = await truto_api.unified_api.update(
"ats",
"candidates",
"<resource_id>",
{
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": True,
"attachments": [],
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X PATCH 'https://api.truto.one/unified/ats/candidates/{id}?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": true,
"attachments": [],
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": true,
"attachments": [],
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/ats/candidates/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/ats/candidates/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"name": "your_name",
"title": "your_title",
"locations": [],
"phones": [],
"emails": [],
"tags": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"urls": [],
"can_email": True,
"attachments": [],
"remote_data": {}
}
response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())