Update a Position

Update properties of an existing position . Returns the Position.

Request

PATCH https://api.comeet.co/position/{uid}

Request path parameters:

NameTypeOptionalDescription
uidstringRequiredPosition UID
📘

Include in the payload object only the properties that need to be updated.

Request body parameters:

Name

Type

Optional

Description

name

string

position name

is_discreet

boolean

true means that the position is only visible to teammates on the position's hiring team.

department

string

If the provided value doesn't exist it will be added as a new option

experience_level

string

If the provided value doesn't exist it will be added as a new option

employment_type

string

If the provided value doesn't exist it will be added as a new option

is_talent_pool

string

true means that this position is a talent pool

location

object

location.uid

string

Location UID

salary_range

object

Position salary range. Permission to write positions salary range is required.

salary_range.min

int

salary_range.max

int

salary_range.currency_code

string

Currency using 3 letter code (ISO 4217)

salary_range.period

One of the following:
hourly
weekly
monthly
annually

categories

array

Custom categories

categories[].name

string

required for provided categories

Must match an existing field's name

categories[].value

string

required for provided categories

For dropdown fields - a value that doesn't already exist will be added as a dropdown option

details

array

Free-form text details.

details[].name

string

required for provided details

Must match an existing field's name

details[].value

required for provided details

HTML

users

object

users.lead_recruiter

object

users.lead_recruiter.email

string

Email address of an existing user. Must have a company recruiter role

users.hiring_manager

object

users.hiring_manager.email

string

Email address of an existing user

users.lead_recruiting_coordinator

object

users.lead_recruiting_coordinator.email

string

Email address of an existing user

questionnaire_uids

array

questionnaires UIDs

{
    "name": "Position updated name"
}

Response

{  
  "name":"Position updated name",
  "status": "open",
  "is_discreet": false,
  "department":"Sales",
  "employment_type":"Full-time",
  "experience_level":"Intermediate",
  "is_talent_pool": false,          
  "location_uid": "D00.000",
   "salary_range": {
   	"min": 200000,
   	"max": 40000,
   	"currency_code": "USD",
   	"period": "Monthly"
  },
  "questionnaire_uids": ['00.001','00.002','00.003'],
  "categories":[  
    {  
      "name":"Territory",
      "value":"USA"
    },
    {
      "name": "workplace_type",
      "value": "Remote"
    }
    //...
  ],
  "details":[  
    {  
      "name":"Description",
      "value":"We are looking for ..."
    },
    {  
      "name":"Requirements",
      "value":"Candidates should have ..."
    }
    //...
  ],
  "users": {
    "hiring_manager": {
      "email": "[email protected]"
    },
    "lead_recruiter": {
      "email": "[email protected]"
    }
  },
  "openings": [
    {
      "name": "Opening 1",
      "time_expected_hire": "2023-09-17T13:10:59Z",
      "reason": "New",
      "status": "Open",
      "time_opened": "2023-07-19T13:10:59Z"
    },
    {
      "name": "Opening 2",
      "time_approved": "2023-07-01",
      "time_expected_hire": "2023-09-17T13:10:59Z",
      "reason": "New",
      "status": "Open",
      "time_opened": "2023-07-19T13:10:59Z"
    }
  ]
}
{  
  "status": 404,
  "error":"candidate_not_found",
  "message":"Candidate not found"
}