Link External IDs

Map your external job IDs to existing jobs on Jobzyn. Use this when you have jobs already published on Jobzyn and want to connect them to your system so you can pull candidates via the API.


POST /api/integrations/job/link

Headers

Header	Required	Description
`x-api-key`	Yes	Your API key (requires `write` scope)
`Content-Type`	Yes	`application/json`

Request Body


{
  "links": [
    { "jobzynJobId": 2625, "externalJobId": "REQ-2024-001" },
    { "jobzynJobId": 2626, "externalJobId": "REQ-2024-002" },
    { "jobzynJobId": 9999, "externalJobId": "REQ-2024-003" }
  ]
}

Field	Type	Required	Description
`links`	`array`	Yes	Array of mappings
`links[].jobzynJobId`	`number`	Yes	The job ID in Jobzyn (shown in the backoffice URL)
`links[].externalJobId`	`string`	Yes	Your external job ID

Response

Success — `200`


{
  "results": [
    { "jobzynJobId": 2625, "externalJobId": "REQ-2024-001", "status": "linked" },
    { "jobzynJobId": 2626, "externalJobId": "REQ-2024-002", "status": "already_linked" },
    { "jobzynJobId": 9999, "externalJobId": "REQ-2024-003", "status": "not_found" }
  ],
  "error": null
}

Result Statuses

Status	Meaning
`linked`	External ID successfully set on the job
`already_linked`	Job already has an external ID — no change made
`not_found`	Job ID does not exist or does not belong to your company

How to Get Jobzyn Job IDs

The jobzynJobId is the internal Jobzyn job ID. You can find it in the backoffice by opening a job — the ID is in the URL. Your Jobzyn account manager can also provide a list of all your job IDs.

Once linked, you can use your externalJobId to update, unpublish, and pull candidates — just like jobs you created through the API.

Example


curl -X POST https://www.jobzyn.com/api/integrations/job/link \
  -H "Content-Type: application/json" \
  -H "x-api-key: jz_your_api_key_here" \
  -d '{
    "links": [
      { "jobzynJobId": 2625, "externalJobId": "REQ-2024-001" },
      { "jobzynJobId": 2626, "externalJobId": "REQ-2024-002" }
    ]
  }'