/candidates/{id}

from merge import Merge
from merge.resources.ats import PatchedCandidateRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.ats.candidates.partial_update(
    id="id",
    model=PatchedCandidateRequest(),
    remote_user_id="remote_user_id",
)

{
  "model": {
    "id": "521b18c2-4d01-4297-b451-19858d07c133",
    "remote_id": "21198",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "first_name": "Gil",
    "last_name": "Feig",
    "company": "Columbia Dining App.",
    "title": "Software Engineer",
    "remote_created_at": "2021-10-15T00:00:00Z",
    "remote_updated_at": "2021-10-16T00:00:00Z",
    "last_interaction_at": "2021-10-17T00:00:00Z",
    "is_private": true,
    "can_email": true,
    "locations": [
      "San Francisco",
      "New York",
      "Miami"
    ],
    "phone_numbers": [
      {
        "value": "+1234567890",
        "phone_number_type": "MOBILE"
      }
    ],
    "email_addresses": [
      {
        "value": "hello@merge.dev",
        "email_address_type": "PERSONAL"
      }
    ],
    "urls": [
      {
        "value": "http://alturl.com/p749b",
        "url_type": "BLOG"
      }
    ],
    "tags": [
      "High-Priority"
    ],
    "applications": [
      "29eb9867-ce2a-403f-b8ce-f2844b89f078",
      "b4d08e5c-de00-4d64-a29f-66addac9af99",
      "4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"
    ],
    "attachments": [
      "bea08964-32b4-4a20-8bb4-2612ba09de1d"
    ],
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/candidates"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Updates a Candidate object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

# The Candidate Object ### Description The `Candidate` object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.

remote_user_idstringRequired

Response

modelobject

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

is_privateboolean or nullOptional

Whether or not the candidate is private.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

remote_datalist of objects or nullOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

is_privateboolean or nullOptional

Whether or not the candidate is private.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

remote_datalist of objects or nullOptionalRead-only

/candidates/{id}

Authentication

Path parameters

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example

Field support by integration