Update Job

curl --request PATCH \
  --url https://api.kardow.com/jobs/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "active"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "company_name": "<string>",
    "status": "<string>",
    "location": "<string>",
    "is_remote": true
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

PATCH

jobs

{id}

curl --request PATCH \
  --url https://api.kardow.com/jobs/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "active"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "company_name": "<string>",
    "status": "<string>",
    "location": "<string>",
    "is_remote": true
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>",
    "url": "<string>"
  }
}

Update one or more fields on an existing job. Commonly used to approve pending jobs or change status.

Path Parameters

string

required

The job UUID.

Request Body

At least one field is required.

string

New status: active, draft, pending, or expired.

string

Updated job title.

string

Updated job description.

string

Updated location text. Changing it re-files the job under the matching place.

string

An existing location id from Locations. Takes precedence over location text.

string

Two-letter country code used when resolving location text, e.g. ca.

string

Updated apply destination: URL, email address, or phone number.

string

Updated apply method. The same pairing rule as Post a Job applies: a method of email, website, phone or form-external needs a destination, checked against the job’s current how_to_apply when you do not send a new one. Mismatches return 422 invalid_apply_destination.

boolean

Updated remote setting.

Examples

Approve a pending job

cURL

curl --request PATCH \
  --url "https://api.kardow.com/jobs/550e8400-e29b-41d4-a716-446655440000" \
  --header "x-api-key: your-api-key-here" \
  --header "Content-Type: application/json" \
  --data '{"status": "active"}'

Attach the right location

Resolve the place first, then send its id:

cURL

curl --request PATCH \
  --url "https://api.kardow.com/jobs/550e8400-e29b-41d4-a716-446655440000" \
  --header "x-api-key: your-api-key-here" \
  --header "Content-Type: application/json" \
  --data '{"location": "Gatineau, QC", "location_id": "7f8a1c2d-0b34-4c8e-9a71-2f5d6e8b0a13"}'

Fix a broken apply button

cURL

curl --request PATCH \
  --url "https://api.kardow.com/jobs/550e8400-e29b-41d4-a716-446655440000" \
  --header "x-api-key: your-api-key-here" \
  --header "Content-Type: application/json" \
  --data '{"how_to_apply": "jobs@acme.com", "how_to_apply_method": "email"}'

Response

object

Show properties

string

Job ID

string

Job title

string

Company name

string

Updated status

string

ISO 8601 timestamp

Authorizations

x-api-key

string

header

required

API key for authentication. Get yours from Settings > API Keys in the Kardow dashboard.

Path Parameters

string<uuid>

required

Job UUID.

Body

application/json

status

enum<string>

Available options:

active,

draft,

pending,

expired

title

string

Required string length: 1 - 255

description

string

Minimum string length: 1

location

string

Location shown on the job. Resolved to a real place and linked, so the job appears on the right location page and filter. Street addresses are filed under their city; exact coordinates stay on the job.

is_remote

boolean

location_id

string<uuid>

Existing location id from POST /locations. Takes precedence over location text and skips resolution.

location_country

string

Two-letter country code used when resolving location text, e.g. "ca". Ignored when location_id is given.

Required string length: 2

how_to_apply

string

Required unless how_to_apply_method is "form". Where candidates apply: an external URL, an email address, or a phone number. A method of email/website/phone/form-external with no destination is rejected with 422 invalid_apply_destination.

how_to_apply_method

enum<string>

What the apply button does: form-external, website, email, phone, or form. Must match the how_to_apply value. Only "form" takes no destination. Omit to auto-detect from how_to_apply.

Available options:

form,

form-external,

email,

website,

phone

Response

Job updated

data

object

required

Show child attributes

Getting Started

Analytics

Jobs

Applications

Content

Members

Users

Webhooks

Secrets

CMS

Path Parameters

Request Body

Examples

Approve a pending job

Attach the right location

Fix a broken apply button

Response

Authorizations

Path Parameters

Body

Response

​Path Parameters

​Request Body

​Examples

​Approve a pending job

​Attach the right location

​Fix a broken apply button

​Response

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Examples

Approve a pending job

Attach the right location

Fix a broken apply button

Response