Edit Candidate

Update a single candidate by its ID.

External Documentation

To learn more, visit the Greenhouse documentation.

Basic Parameters

Parameter	Description
Candidate ID	The candidate ID of the candidate to edit. Can be obtained using the List Candidates action.
Company	The candidate's company.
Coordinator Email	The email of the new coordinator. Either the ID or email must be present.
Coordinator ID	The ID of the new coordinator. Either the ID or email must be present.
First Name	The candidate's first name.
Last Name	The candidate's last name.
On Behalf Of	ID of the user issuing this request. Required for auditing purposes.
Recruiter Email	The email of the new recruiter. Either the ID or email must be present.
Recruiter ID	The ID of the new recruiter. Either the ID or email must be present.
Title	The candidate's title.

Advanced Parameters

Parameter	Description
Addresses	A json array of addresses.For example:[ { "value": "123 Fake St.","type": "home" }]
Custom Fields	The custom fields of the user. For more information regarding this parameter, refer to Greenhouse's Documentation under `Custom Field Parameters'.
Email Addresses	A json array of email addresses.For example:[ { "value": "john.locke+work@example.com","type": "work" }]
Is Private	Whether the candidate is private or not.
Phone Numbers	A json array of phone numbers.For example:[ { "value": "222-555-4608", "type": "home"} ]
Social Media Addresses	A json array of social media addresses.For example:[ { "value": "linkedin.example.com/john.locke" }]
Tags	A json array of tags as strings.For example:[ "Walkabout", "Orientation"]
Website Addresses	A json array of website addresses.For example:[ { "value": "johnlocke.example.com","type": "personal" }]

Example Output

{
    "first_name": "New",
    "last_name": "Name",
    "company": "The Tustin Box Company",
    "title": "Customer Success Representative",
    "is_private": true,
    "phone_numbers": [
        {
            "value": "555-1212",
            "type": "mobile"
        }
    ],
    "addresses": [
        {
            "value": "123 Fake St.",
            "type": "home"
        }
    ],
    "email_addresses": [
        {
            "value": "john.locke+work@example.com",
            "type": "work"
        },
        {
            "value": "john.locke@example.com",
            "type": "personal"
        }
    ],
    "website_addresses": [
        {
            "value": "johnlocke.example.com",
            "type": "personal"
        }
    ],
    "social_media_addresses": [
        {
            "value": "linkedin.example.com/john.locke"
        },
        {
            "value": "@johnlocke"
        }
    ],
    "recruiter": {
        "user_id": 4354
    },
    "coordinator": {
        "email": "coordinator@example.com"
    },
    "tags": [
        "Walkabout",
        "Orientation"
    ],
    "custom_fields": [
        {
            "id": 1234,
            "value": "Some new value"
        },
        {
            "name_key": "single_select_field_name",
            "value": 12345
        },
        {
            "id": 5678,
            "delete_value": "true"
        }
    ]
}

Workflow Library Example

Edit Candidate with Greenhouse and Send Results Via Email

Preview this Workflow on desktop