Create succession pool
POST/hr/succession-pools
Creates a succession pool for a given position and populates it with candidate employee IDs and optional readiness scores. Use this to formalise talent pipelines for key roles.
Request
Request body
Content type application/json (required).
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name of the succession pool (e.g. "CTO Pipeline"). Max length: 180 |
position_id | integer, nullable | No | ID of the hr_positions record this pool targets. May be null for cross-functional pools. |
candidate_ids | array of integer | No | Array of hr_employees IDs included as candidates. |
readiness_scores_json | string | No | JSON object mapping employee IDs (as string keys) to readiness labels such as "ready_now", "ready_1yr", or "ready_2yr". |
status | string | No | Active pools are included in planning dashboards. One of: |
Example
{
"name": "CTO Pipeline",
"position_id": 5,
"candidate_ids": [
8,
14,
22
],
"readiness_scores_json": "{\"8\":\"ready_now\",\"14\":\"ready_1yr\",\"22\":\"ready_2yr\"}",
"status": "active"
}Responses
302 Redirect to the HR planning index after creation
422 Validation error — candidate_ids must reference valid hr_employees
Example request
curl -X POST "https://{tenant}.faciotech.net/api/v1/hr/succession-pools" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name": "CTO Pipeline", "position_id": 5, "candidate_ids": [8, 14, 22], "readiness_scores_json": "{\"8\":\"ready_now\",\"14\":\"ready_1yr\",\"22\":\"ready_2yr\"}", "status": "active"}'