Skip to main content

companies.delete

Delete a company and every application filed against it

Request
DELETE/api/v1/companies/{companyId}
Scope required
companies:write
Effect
Deletes something. Confirm with a person before calling it.
Acts on
Acts on the account’s own job search.
MCP tool
companies_delete
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Removes an employer together with its jobs and every application, interview and note that referred to them — the same cascade the web app performs, so a company with applications is deleted rather than refused. Call `companies.get` first and read `applicationCount` if you need to know what will go with it. This cannot be undone. Answers 204 with no body.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
companyIdpathRequiredstring
If-MatchheaderOptionalstring — The ETag of the version you read. The write is refused with 412 if the resource has changed since.

Response

Answers 204 with no body.

Examples

Delete an employer recorded by mistake

Delete an employer recorded by mistake — request
curl -s -X DELETE https://www.jobapplicationtracking.com/api/v1/companies/co_42 \
  -H "Authorization: Bearer $JAT_KEY"
Delete an employer recorded by mistake — response
null

Related operations