Job Close

Close a job so it is no longer shown on carehome.co.uk.

Who can use it: Enhanced and Platinum subscribers, for jobs posted with their API key.

Closing can't be undone through the API. A closed job no longer appears in your job list, but its applications are still available from the Job Application API. Use this endpoint to take a job down before it expires.

Close a job

POST /index.cfm/jobs/{job_id}/actions/close

Base URL https://api.carehome.co.uk. Authentication, errors and support are covered in the Jobs API overview.

Parameters

Parameter	Type	Required	Description
`job_id`	integer	Yes	In the path. ID of the job.
`api_key`	string	Yes	The API key the job was posted with, in the JSON body or the query string.
`partner_key`	string	No	Partners can send their partner key; it is not needed to close a job.

Example request

curl -X POST "https://api.carehome.co.uk/index.cfm/jobs/96000000001/actions/close" \
  -H "Content-Type: application/json" \
  -d '{ "api_key": "YOUR_API_KEY" }'

Example response

200 OK:

{
  "data": {},
  "error": []
}

Errors

Status	When	error
400	`job_id` is not a number.	`A numeric value is required for job_id.`
404	The job does not exist, is already closed, or was posted with a different API key.	`No record found for the job_id passed.`
404	The action in the URL is not `close`.	`'example' is not a valid action.`
405	A method other than POST was used.	Check the status code.