API Reference

Update an application’s external reference

patch
https://api.join.com/v3/applications/

Updates the external reference your system stores on an application. Send externalId with your reference, or null to clear it.

To move the application through the hiring process, use Move an application to a stage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the application

Body Params

Updates your external reference for an application. Omit externalId to leave it unchanged, or send null to clear it. Use Move an application to a stage to change its stage.

string | null
\S

Your system’s reference for this application. Use a string of 1–50 characters containing at least one non-whitespace character, or null to clear it.

Headers
string

Selects a dated API revision in YYYY-MM-DD format, such as 2026-11-01. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?