Delete a location

delete

https://api.join.com/v3/locations/{id}

Deletes a location. Two rules apply: the company default cannot be deleted (location_is_default) — set another location as default first — and a location used by active jobs cannot be deleted (location_referenced_by_active_jobs).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

204The location is deleted

400The Join-Version header names a version this API does not serve.

401Authentication failed. Either the Authorization: Bearer header is missing (authentication_required), or the presented token is malformed, unknown, revoked, or belongs to a company that no longer has API access (token_invalid).

404No location with this id exists within the caller’s company. Ids belonging to other companies or to deleted locations are reported the same way, so the response never reveals which ids exist elsewhere.

422The location is the company default or is referenced by active jobs, or the path id failed schema validation.

429The token exceeded its sustained (600/60s) or burst (100/10s) request quota. Retry after the number of seconds in Retry-After.

500An unexpected error occurred on JOIN’s side. The request may be retried.