Skip to main content
POST
/
api
/
statuses
curl --request POST \
  --url https://api.harmonyforstaffing.com/api/statuses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "In Review",
    "type": "CANDIDATE",
    "description": "Candidate is being reviewed by the hiring team",
    "isDefault": false,
    "isActive": true,
  }'
{
  "id": 123,
  "name": "In Review",
  "type": "CANDIDATE",
  "description": "Candidate is being reviewed by the hiring team",
  "isDefault": false,
  "isActive": true,
  "dateAdded": 1679253000
}
Create a new status for candidates, jobs, or job submissions.

Body Parameters

name
string
required
Name of the status
type
string
required
Type of entity this status applies to
description
string
Description of what this status means
isDefault
boolean
Whether this is the default status for new entities
isActive
boolean
Whether this status is active

Response

id
integer
The ID of the created status
dateAdded
integer
Unix timestamp when the status was added
curl --request POST \
  --url https://api.harmonyforstaffing.com/api/statuses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "In Review",
    "type": "CANDIDATE",
    "description": "Candidate is being reviewed by the hiring team",
    "isDefault": false,
    "isActive": true,
  }'
{
  "id": 123,
  "name": "In Review",
  "type": "CANDIDATE",
  "description": "Candidate is being reviewed by the hiring team",
  "isDefault": false,
  "isActive": true,
  "dateAdded": 1679253000
}