Partner APILocations

Update or close a location

Updates a location’s title, description, or address, or closes it to new applicants with status: closed. Omitted fields are unchanged; closing a location leaves existing candidates and their in-flight screenings untouched.

Changing the address re-geocodes the location. The previous coordinates are cleared first, so a stale fix can never outlive the address it came from.

Authentication

AuthorizationBearer
Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

refstringRequired

Your location identifier (external_ref).

Request

This endpoint expects an object.
titlestringOptional
descriptionstringOptional
employment_typestringOptional
addressobjectOptional
A real street address. Distance screening measures a candidate's commute against it, so the more complete it is, the better location fit works.
statusenumOptional

Set closed to stop accepting new applicants at this location.

Allowed values:

Response

The updated location.
location_idstringformat: "uuid"
CONFIRM's identifier for the location's job.
external_refstring

Your location identifier, echoed back. Pass it as location_ref when ingesting applicants.

titlestring
statusenum
organization_refstringOptional
The registry this location belongs to.
geocodedbooleanOptional

True when the address resolved to coordinates. False means distance screening is inactive for this location — check warnings.

addressstring or nullOptional

The stored single-line address.

createdbooleanOptional

False when the location already existed and this call was a no-op.

warningslist of stringsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error