API Reference

Update an application

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

Updates your own reference on an application. externalId is the only mutable attribute — send null to clear it. The stage moves through PUT /applications/{id}/stage, and rejection happens in the JOIN product.

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

externalId is the only mutable attribute of an application, and it is optional — a body that omits it changes nothing. The stage moves through PUT /applications/{id}/stage, and rejection happens in the JOIN product.

string | null
\S

Your own reference for this application. Sending null clears it. Limited to 50 characters; a longer value is refused with validation_error. When present, must contain at least one non-whitespace character.

Headers
string

Selects the dated API version the request runs against, named after its release day as YYYY-MM-DD, e.g. 2026-11-01. Omit to use the current default version (2026-11-01). A value that is not a supported version is rejected with 400 unsupported_api_version.

Responses

Updated 23 days 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 23 days ago

Did this page help you?