Change the contact and salary details of a job you have posted.
Who can use it: Enhanced and Platinum subscribers, for jobs posted with their API key. A group's key can also edit jobs posted by its settings. Editing a job does not use a job credit.
Only the fields below can be changed. To change anything else, such as the title or description, close the job and post a new one.
Edit a job
PUT /index.cfm/jobs/{job_id}
Base URL https://api.carehome.co.uk. Authentication, errors and support are covered in the Jobs API overview.
Send the fields as a JSON object with the header Content-Type: application/json. Send only the fields you want to change; you must send at least one. Empty values are ignored, so you can't use this endpoint to clear a field.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | integer | Yes | In the path. ID of the job, as returned when you posted it. |
api_key | string | Yes | Your API key. Partners send the API key of the customer the job is for. |
job_contact_name | string | No | Contact name for the job, up to 255 characters. |
job_contact_email | string | No | Email address applications are sent to, up to 255 characters. |
job_contact_url | string | No | Web address of this job's application page, up to 1,000 characters. |
job_admin_email | string | No | Email address we remind before the job expires, up to 300 characters. |
job_processed_by | string | No | Name of the person making the change, up to 100 characters. For our records. |
job_pay_type_id | integer | No | 1 per annum, 2 per hour, 5 non-specific. |
job_salary_from | string | No | Lowest pay, for example "24000". Up to 7 digits and 2 decimal places. |
job_salary_to | string | No | Highest pay, in the same format. |
job_salary | string | No | Salary details as text, up to 60 characters. |
partner_key | string | No | Partners can send their partner key; it is not needed to edit a job. |
When you change the pay, send job_pay_type_id, job_salary_from and job_salary_to together, following the salary rules for posting a job: annual pay from at least 1000, hourly pay below 1000, and job_salary_from no higher than job_salary_to.
Example request
curl -X PUT "https://api.carehome.co.uk/index.cfm/jobs/96000000001" \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"job_contact_name": "Example Name",
"job_contact_email": "example@example.com",
"job_pay_type_id": 2,
"job_salary_from": "13.00",
"job_salary_to": "14.00"
}'
Example response
200 OK. data is the updated job, in the same format as Get a job.
{
"data": {
"job_id": 96000000001,
"job_title": "Care Assistant (example)",
"job_contact_name": "Example Name",
"job_contact_email": "example@example.com",
"job_pay_type_id": 2,
"job_salary_from": 13,
"job_salary_to": 14,
"...": "other job fields"
},
"error": []
}
Errors
| Status | When | error |
|---|---|---|
| 400 | No field to change was sent. | No data passed to update job contact details |
| 400 | An email address is not valid. | job_contact_email is not a valid email address or job_admin_email is not a valid email address |
| 400 | The pay details break the salary rules. | A message explaining the rule, as for Job Post. |
| 400 | job_id is not a number. | A numeric value is required for job_id. |
| 404 | The job does not exist, or you can't edit it. | Job (96000000001) does not exist, or you do not have permission to edit it. |