# Update Candidates

> Source: https://truto.one/docs/api-reference/unified-ats-api/candidates/update/

`PATCH /unified/ats/candidates/{id}`

Resource: **Candidates** · API: **Unified ATS API**

## Supported integrations

Breezy, Teamtailor, Workable

## Path parameters

- **`id`** _(string, required)_
  The ID of the resource.

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns 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. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_enforce_write_schema`** _(boolean)_
  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.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`organization_id`** _(string)_
  Breezy company ID; the connected account company is used when omitted.
- **`job_id`** _(string)_
  Position containing the candidate.

## Request body

- **`name`** _(string)_
  The user's full name
- **`title`** _(string)_
  The candidate's title
- **`locations`** _(array<string>)_
  The candidate's locations
- **`phones`** _(array<object>)_
  The candidate's phone numbers
  - **`number`** _(string, required)_
    The candidate's phone number
  - **`extension`** _(string)_
    The extension of the phone number
  - **`type`** _(string)_
    The candidate's phone number type
- **`emails`** _(array<object>)_
  Candidate email addresses; Teamtailor requires a unique email for this mapping.
  - **`email`** _(string, required)_
    The candidate's email
  - **`type`** _(string)_
    The candidate's email type
- **`tags`** _(array<object>)_
  Supplying tags replaces the provider's complete tag array.
  - **`id`** _(string)_
    The tag's unique identifier
  - **`name`** _(string)_
    The tag's name
- **`first_name`** _(string)_
  Candidate first name.
- **`last_name`** _(string)_
  Candidate last name.
- **`urls`** _(array<object>)_
  The candidate's urls
  - **`url`** _(string, required)_
    The candidate's URL
  - **`type`** _(string)_
    The candidate's URL type
- **`can_email`** _(boolean)_
  Mapped to the inverse of Teamtailor unsubscribed.
- **`attachments`** _(array<object>)_
  The candidate's attachments
  - **`id`** _(string, required)_
    The attachment's unique identifier
  - **`file_name`** _(string)_
    The attachment's file_name
  - **`file_url`** _(string)_
    The attachment's file_url
  - **`candidate`** _(object)_
    The attachment's candidate
    - **`id`** _(string)_
      Unique identifier of the candidate
  - **`application`** _(object)_
    The attachment's application
    - **`id`** _(string)_
      Unique identifier of the application
  - **`job`** _(object)_
    The attachment's job
    - **`id`** _(string)_
      Unique identifier of the job
  - **`attachment_type`** _(string)_
    The attachment's type
  - **`created_at`** _(string)_
    The date and time of the attachment's creation
  - **`updated_at`** _(string)_
    The date and time of the attachment's last update
- **`remote_data`** _(object)_
  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.

## Response body

- **`id`** _(string, required)_
  The candidate's unique identifier
- **`first_name`** _(string)_
  The candidate's first_name
- **`last_name`** _(string)_
  The candidate's last_name
- **`name`** _(string)_
  The user's full name
- **`company`** _(string)_
  The candidate's company
- **`title`** _(string)_
  The candidate's title
- **`last_interaction_at`** _(string)_
  The candidate's last_interaction date
- **`is_private`** _(string)_
  Whether the candidate is_private
- **`can_email`** _(boolean)_
  Whether the candidate can email
- **`locations`** _(array<string>)_
  The candidate's locations
- **`phones`** _(array<object>)_
  The candidate's phone numbers
  - **`number`** _(string)_
    The candidate's phone number
  - **`extension`** _(string)_
    The extension of the phone number
  - **`type`** _(string)_
    The candidate's phone number type
- **`emails`** _(array<object>)_
  The candidate's emails
  - **`email`** _(string)_
    The candidate's email
  - **`type`** _(string)_
    The candidate's email type
- **`urls`** _(array<object>)_
  The candidate's urls
  - **`url`** _(string)_
    The candidate's URL
  - **`type`** _(string)_
    The candidate's URL type
- **`tags`** _(array<object>)_
  The candidate's tags
  - **`id`** _(string)_
    The tag's unique identifier
  - **`name`** _(string)_
    The tag's name
- **`applications`** _(array<object>)_
  The candidate's applications
  - **`id`** _(string)_
    The application's unique identifier
  - **`candidate`** _(object)_
    The application's candidate
    - **`id`** _(string)_
      Unique identifier of the candidate
  - **`job`** _(object)_
    The application's job
    - **`id`** _(string)_
      Unique identifier of the job
  - **`applied_at`** _(string)_
    The date and time of the application's creation
  - **`rejected_at`** _(string)_
    The date and time of the application's rejection
  - **`source`** _(object)_
    The application's source
    - **`id`** _(string)_
      The application's source's unique identifier
    - **`name`** _(string)_
      The application's source's name
  - **`credited_to`** _(object)_
    The application's credited_to
    - **`id`** _(string)_
      Unique identifier of the user
    - **`first_name`** _(string)_
      First name of the user
    - **`last_name`** _(string)_
      Last name of the user
    - **`emails`** _(array<object>)_
      - **`email`** _(string)_
        Email of the user
      - **`type`** _(string)_
        Type of the email
      - **`is_primary`** _(boolean)_
        Whether the email is primary
  - **`current_stage`** _(object)_
    The application's current_stage
    - **`id`** _(string)_
      The application's current_stage's unique identifier
    - **`name`** _(string)_
      The application's current_stage's name
    - **`job`** _(object)_
      The application's current_stage's job
      - **`id`** _(string)_
        Unique identifier of the job
    - **`created_at`** _(string)_
      The date and time of the application's current_stage's creation
    - **`updated_at`** _(string)_
      The date and time of the application's current_stage's last update
  - **`reject_reason`** _(string)_
    The application's reject_reason
  - **`attachments`** _(array<object>)_
    The application's attachments
    - **`id`** _(string, required)_
      The attachment's unique identifier
    - **`file_name`** _(string)_
      The attachment's file_name
    - **`file_url`** _(string)_
      The attachment's file_url
    - **`candidate`** _(object)_
      The attachment's candidate
      - **`id`** _(string)_
        Unique identifier of the candidate
    - **`application`** _(object)_
      The attachment's application
      - **`id`** _(string)_
        Unique identifier of the application
    - **`job`** _(object)_
      The attachment's job
      - **`id`** _(string)_
        Unique identifier of the job
    - **`attachment_type`** _(string)_
      The attachment's type
    - **`created_at`** _(string)_
      The date and time of the attachment's creation
    - **`updated_at`** _(string)_
      The date and time of the attachment's last update
  - **`created_at`** _(string)_
    The date and time of the application's creation
  - **`updated_at`** _(string)_
    The date and time of the application's last update
- **`attachments`** _(array<object>)_
  The candidate's attachments
  - **`id`** _(string, required)_
    The attachment's unique identifier
  - **`file_name`** _(string)_
    The attachment's file_name
  - **`file_url`** _(string)_
    The attachment's file_url
  - **`candidate`** _(object)_
    The attachment's candidate
    - **`id`** _(string)_
      Unique identifier of the candidate
  - **`application`** _(object)_
    The attachment's application
    - **`id`** _(string)_
      Unique identifier of the application
  - **`job`** _(object)_
    The attachment's job
    - **`id`** _(string)_
      Unique identifier of the job
  - **`attachment_type`** _(string)_
    The attachment's type
  - **`created_at`** _(string)_
    The date and time of the attachment's creation
  - **`updated_at`** _(string)_
    The date and time of the attachment's last update
- **`created_at`** _(string)_
  The date and time of the phone number's creation
- **`updated_at`** _(string)_
  The date and time of the phone number's last update
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Code examples

### Truto CLI

```bash
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 json
```

### Truto TS SDK

```typescript
import 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);
```

### Truto Python SDK

```python
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

```bash
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": {}
}'
```

### JavaScript

```javascript
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);
```

### Python

```python
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())
```