Jobs

Change a job this partner created

Changes the members the body names and leaves the others as they are; null clears a member that may be empty. A job this partner did not create, or whose company is no longer the one it is bound to, is the 404 of a row that does not exist. Moving a job onto active stamps a new posted_at, which announces it to the pilots’ alerts; an edit of a live job does not. Making a closed job active reopens it, with 30 more days unless expires_at says otherwise. The token must carry jobs.write, otherwise 403 scope_missing; a partner that lost its binding is 403 partner_not_bound.

PATCH

partner

jobs

{job_id}

Change a job this partner created

curl --request PATCH \
  --url https://{devApiHost}/v1/partner/jobs/{job_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "min_total_hours": 2500,
  "description": null
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({min_total_hours: 2500, description: null})
};

fetch('https://{devApiHost}/v1/partner/jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/jobs/{job_id}"

payload = {
    "min_total_hours": 2500,
    "description": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "company": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "logo_url": "<string>"
  },
  "position_type": "captain",
  "employment_type": "full_time",
  "operation_type": "part_121",
  "base_location": "<string>",
  "base_airport_code": "<string>",
  "min_total_hours": 123,
  "min_pic_hours": 123,
  "min_multi_engine_hours": 123,
  "min_turbine_hours": 123,
  "min_jet_hours": 123,
  "required_licenses": [
    "<string>"
  ],
  "required_type_ratings": [
    "<string>"
  ],
  "salary_min": 123,
  "salary_max": 123,
  "salary_type": "annual",
  "salary_currency": "<string>",
  "posted_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Operation not permitted.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "partner_not_bound"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Path Parameters

job_id

string<uuid>

required

Body

application/json

Maximum 65536 bytes. At least one member. Unknown or repeated members are rejected, and client_ref is a create's.

The members a partner may set. Each is optional here; a create requires its own.

title

string

Surrounding whitespace is trimmed.

Minimum string length: 1

description

string | null

position_type

enum<string>

Available options:

captain,

first_officer,

check_airman,

instructor,

management,

other,

program

employment_type

enum<string>

Available options:

full_time,

part_time,

contract,

temporary,

seasonal

operation_type

enum<string>

Available options:

part_121,

part_135,

part_91,

part_91k,

military,

government,

other

base_location

string | null

base_airport_code

string | null

work_mode

enum<string> | null

Available options:

onsite,

hybrid,

remote,

null

min_total_hours

integer | null

Required range: x >= 0

min_pic_hours

integer | null

Required range: x >= 0

min_multi_engine_hours

integer | null

Required range: x >= 0

min_turbine_hours

integer | null

Required range: x >= 0

min_jet_hours

integer | null

Required range: x >= 0

required_licenses

string[]

License codes, such as ATP or CPL.

Minimum string length: 1

required_type_ratings

string[]

FAA type rating designators, such as CE-680.

Minimum string length: 1

salary_min

number | null

salary_max

number | null

At least salary_min.

salary_type

enum<string> | null

Available options:

annual,

hourly,

per_diem,

daily_rate,

monthly,

fixed,

null

salary_currency

string

Pattern: ^[A-Z]{3}$

application_url

string | null

An absolute http or https URL.

application_email

string | null

application_instructions

string | null

expires_at

string<date-time>

RFC 3339. 30 days from the create unless it says otherwise.

status

enum<string>

default:active

Available options:

draft,

active

Response

The job as it now stands.

A job. Nothing of who posted it, how it was reviewed or who applied travels with it.

string<uuid>

required

title

string

required

company

object

required

Who the job is for. A job a member shared may name no company of the catalog; id and logo_url are then null.

Show child attributes

position_type

enum<string>

required

Available options:

captain,

first_officer,

check_airman,

instructor,

management,

other,

program

employment_type

enum<string>

required

Available options:

full_time,

part_time,

contract,

temporary,

seasonal

operation_type

enum<string>

required

Available options:

part_121,

part_135,

part_91,

part_91k,

military,

government,

other

base_location

string | null

required

base_airport_code

string | null

required

min_total_hours

integer | null

required

min_pic_hours

integer | null

required

min_multi_engine_hours

integer | null

required

min_turbine_hours

integer | null

required

min_jet_hours

integer | null

required

required_licenses

string[]

required

required_type_ratings

string[]

required

salary_min

number | null

required

salary_max

number | null

required

salary_type

enum<string> | null

required

Available options:

annual,

hourly,

per_diem,

daily_rate,

monthly,

fixed,

null

salary_currency

string

required

Pattern: ^[A-Z]{3}$

posted_at

string<date-time> | null

required

expires_at

string<date-time> | null

required

url

string

required

The job's public page on MyPilotIndex.

⌘I

Change a job this partner created

curl --request PATCH \
  --url https://{devApiHost}/v1/partner/jobs/{job_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "min_total_hours": 2500,
  "description": null
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({min_total_hours: 2500, description: null})
};

fetch('https://{devApiHost}/v1/partner/jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/jobs/{job_id}"

payload = {
    "min_total_hours": 2500,
    "description": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "company": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "logo_url": "<string>"
  },
  "position_type": "captain",
  "employment_type": "full_time",
  "operation_type": "part_121",
  "base_location": "<string>",
  "base_airport_code": "<string>",
  "min_total_hours": 123,
  "min_pic_hours": 123,
  "min_multi_engine_hours": 123,
  "min_turbine_hours": 123,
  "min_jet_hours": 123,
  "required_licenses": [
    "<string>"
  ],
  "required_type_ratings": [
    "<string>"
  ],
  "salary_min": 123,
  "salary_max": 123,
  "salary_type": "annual",
  "salary_currency": "<string>",
  "posted_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Operation not permitted.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "partner_not_bound"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Overview

Grants

Jobs

Publishing

Insights

Certificates

Webhooks

Change a job this partner created

Authorizations

Path Parameters

Body

Response