Skip to content

Create a job

POST
/api/nova/jobs

Creates a new job from the request body. Supported fields include title, description, shortDescription, internalDescription, openPositions, skills, boolean flags (remoteWorking, hot, visaSponsored, relocation, flexiHours), closingDate, startDate, rating, companyId, contactId, master-data IDs (statusId, employmentTypeId, sourceId) and customFields for user-defined fields. The account's job usage limit is checked first and a 429 is returned if it has been reached. On success the response contains the new job's ID with the message Created. Returns 401 for an invalid API key and 500 with an error message on failure.

Authorizations

privateApiKey
Type
API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type
string
Required

Request Body

application/json
JSON
{
  
"closingDate": "string",
  
"companyId": "string",
  
"contactId": "string",
  
"customFields": [
  
  
{
  
  
  
"boolValue": "string",
  
  
  
"dateValue": "string",
  
  
  
"fieldId": "string",
  
  
  
"fieldLabel": "string",
  
  
  
"listValue": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"value": "string"
  
  
}
  
],
  
"description": "string",
  
"employmentTypeId": "string",
  
"experienceLevelId": "string",
  
"flexiHours": true,
  
"hot": true,
  
"id": "string",
  
"internalDescription": "string",
  
"maxPay": 0,
  
"minPay": 0,
  
"openPositions": 0,
  
"ownerId": "string",
  
"payCurrency": "string",
  
"payTenure": "string",
  
"rating": 0,
  
"relocation": true,
  
"remoteWorking": true,
  
"shortDescription": "string",
  
"skills": [
  
  
"string"
  
],
  
"sourceId": "string",
  
"startDate": "string",
  
"statusId": "string",
  
"tags": [
  
  
{
  
  
  
"group": "string",
  
  
  
"value": "string"
  
  
}
  
],
  
"title": "string",
  
"visaSponsored": true
}

Responses

OK

application/json
JSON
{
  
"data": "string",
  
"error": "string",
  
"message": "string",
  
"requestId": "string",
  
"success": true
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Recruitly — Recruitment CRM for Agencies