Skip to main content
PUT
/
api
/
statuses
/
{id}
curl --request PUT \
  --url https://api.harmonyforstaffing.com/api/statuses/123 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "In Review",
    "type": "CANDIDATE",
    "description": "Updated description: Candidate is being reviewed",
    "isDefault": false,
    "isActive": true
  }'

{
  "id": 123,
  "name": "In Review",
  "type": "CANDIDATE",
  "description": "Updated description: Candidate is being reviewed",
  "isDefault": false,
  "isActive": true,
  "dateAdded": 1679253000
}
Update the details of an existing status.

​
Path Parameters

​
id
integer
required
ID of the status to update

​
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 updated status
​
dateAdded
integer
Unix timestamp when the status was added
curl --request PUT \
  --url https://api.harmonyforstaffing.com/api/statuses/123 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "In Review",
    "type": "CANDIDATE",
    "description": "Updated description: Candidate is being reviewed",
    "isDefault": false,
    "isActive": true
  }'

{
  "id": 123,
  "name": "In Review",
  "type": "CANDIDATE",
  "description": "Updated description: Candidate is being reviewed",
  "isDefault": false,
  "isActive": true,
  "dateAdded": 1679253000
}