1.0.0
  • latest
  • 1.0.0
  1. Company Candidates
1.0.0
  • latest
  • 1.0.0
  • Getting Started
    • Generate an API key
  • Recruiting
    • Widget Integration
      • Integration Guide via Widget
      • Embed the Widget Code in WordPress
      • Steps to Implement in a React.js Website
    • Integration via code
      • Integration via code
      • Jobs Listing
  • Company Candidates
    • Company Candidate Sync API
      POST
  1. Company Candidates

Company Candidate Sync API

POST
https://api.cooperhire.io/v1/company/candidate

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cooperhire.io/v1/company/candidate' \
--header 'api-key: <api-key>' \
--form 'candidate[first_name]="John"' \
--form 'candidate[email]="john@example.com"' \
--form 'candidate[last_name]="Doe"' \
--form 'candidate[linkedin_url]="https://linkedin.com/profile"' \
--form 'candidate[utm_source]="indeed"' \
--form 'candidate[phone_no]="9876543210"' \
--form 'candidate[job_id]=""' \
--form 'candidate[job_unique_id]=""' \
--form 'candidate[resume]=@""' \
--form 'candidate[documents][]=@""'

Responses

🟢200OK
application/json
Body

Example
{
    "candidate": {
        "id": "9a93c89a-f57d-4558-83e5-bf99a793e451",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "stage": "new",
        "resume": {
            "url": "https://storage.googleapis.com/ats-development/uploads/candidate_profile/resume/ab4cbd39-01d8-4b71-baa8-495719e9f45d/7b168770-b0d5-4022-9145-ed5178e31630_Closing_Soon.pdf"
        },
        "documents": [
            {
                "url": "https://storage.googleapis.com/ats-development/uploads/application/documents/337c4c17-5148-449a-927b-7bb8753ccdc9/7c57162f-4132-4d58-b460-9c2832bea524_download.png"
            }
        ],
        "linkedin_url": "https://linkedin.com/profile",
        "phone_no": "9876543210",
        "utm_source": "indeed",
        "job_id": 2123,
        "created_at": "2025-08-27T08:37:13.931Z",
        "average_rating": 0,
        "recruiter": {
            "id": 5,
            "first_name": "Test",
            "last_name": "Recruiter",
            "logo": {
                "url": null
            }
        },
        "job": {
            "id": 2123,
            "title": "ROR Job",
            "country": "Deutschland",
            "city": "Berlin",
            "deleted": false
        }
    }
}
Modified at 2025-11-26 08:41:09
Previous
Company Candidates
Built with