Create Folder

Create Folder

POST

Create a folder for candidates, contacts, deals, jobs, or organizations.

Request

POST /v1/folder

Body Parameters

Parameter	Type	Required	Description
entity	string	Yes	The record type this folder is for. Allowed values: candidate, contact, deal, job, organization.
name	string	Yes	Folder name. Maximum 100 characters.
description	string	No	Folder description. Maximum 500 characters.
shared	boolean	No	Set to true to make the folder shared. Default: false.

Request Example

{
  "entity": "candidate",
  "name": "Engineering Candidates",
  "description": "Shortlisted engineering candidates",
  "shared": true
}

Response

200

{
  "id": 42,
  "entity": "candidate",
  "name": "Engineering Candidates",
  "description": "Shortlisted engineering candidates",
  "shared": true,
  "created_by": {
    "id": 1
  },
  "updated_by": {
    "id": 1
  },
  "created_at": "2026-07-24T10:15:00.000Z",
  "updated_at": "2026-07-24T10:15:00.000Z"
}

400

[
  {
    "field_name": "entity",
    "error_message": "entity must be one of: candidate, contact, deal, job, organization"
  }
]