.png?fit=max&auto=format&n=lKy84_BssSCy2hcz&q=85&s=ac7c949427cc2893306f6036415f087e)
curl --request POST \
--url https://partner-api.taptalent.io/v1/partner/pipelines/stages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pipelineId": 123,
"name": "Technical Interview",
"type": "SCREEN",
"order": 3
}
'{
"status": "success",
"data": {
"id": 791,
"name": "Updated Stage Name",
"type": "ASSESSMENT",
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T11:00:00.000Z"
}
}Create or update a pipeline stage
Creates a new stage or updates an existing stage in a pipeline,
depending on the request body: when stageId is present the existing
stage is updated (200); when stageId is omitted a new stage is
created (201).
Ordering rules:
- Stages have a 1-based
orderdetermining their position in the pipeline. - When creating a stage without an
order, it is placed immediately before theHIREDstage. - When an
orderis supplied (on create or update), the other stages’ orders are adjusted automatically to maintain sequential ordering. - The
SOURCEDstage’s order is locked and cannot be changed.
System stages (SOURCED, APPLIED, HIRED) cannot have their type
changed — only their name can be updated (send stageId and name
only).
curl --request POST \
--url https://partner-api.taptalent.io/v1/partner/pipelines/stages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pipelineId": 123,
"name": "Technical Interview",
"type": "SCREEN",
"order": 3
}
'{
"status": "success",
"data": {
"id": 791,
"name": "Updated Stage Name",
"type": "ASSESSMENT",
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T11:00:00.000Z"
}
}Authorizations
Company-scoped API key. Production keys are prefixed sk_live_,
sandbox keys sk_test_, each followed by 22 base62 characters
(pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the
TapTalent dashboard under Account Settings → Developers → API Key
Management; a key is shown once at generation and old keys are
invalidated immediately on regeneration.
Body
Create-or-update request for a pipeline stage. When stageId is
present the existing stage is updated; when it is omitted a new stage
is created.
The unique identifier of the pipeline.
123
Stage name. The documentation's field table marks this field as
required, but per its field description it is required when
creating a stage (no stageId) and optional when updating an
existing stage.
"Technical Interview"
Stage type. The documentation's field table marks this field as
required, but per its field description it is required when
creating a stage (no stageId) and optional when updating an
existing stage. Only the five custom types listed here are valid in
requests; system stages (SOURCED, APPLIED, HIRED) cannot have
their type changed (omit type and send only stageId and name
to rename them). An unrecognized value is rejected with
INVALID_REQUEST ("Stage type is not valid").
ASSESSMENT, SCREEN, SHORTLISTED, OFFER, ONBOARDING Stage ID. If provided, updates the existing stage; if omitted, creates a new stage.
791
Desired 1-based order position. If not provided, new stages are
placed immediately before the HIRED stage. When updating, other
stages' orders are adjusted automatically to maintain sequential
ordering. The SOURCED stage's order is locked and cannot be
changed. The documented field table specifies no maximum, but the
documented validation error reads "Order must be between 1 and 5",
indicating an upper bound (tied to the pipeline's stage count) is
enforced in practice; no maximum is imposed here.
x >= 13
Response
Stage updated (request contained a stageId). The submitted
order is not echoed in the response body.
Success envelope for stage create (201) and stage update (200) — both
return the same body shape. The stage's order is not echoed.
success A stage within a hiring pipeline. System stages (SOURCED, APPLIED,
HIRED) are created automatically with every pipeline, cannot be
deleted, and cannot have their type changed — only their name is
editable; additionally the SOURCED stage's order is locked. Custom
stages can be created, updated, and deleted. Stages have a 1-based
order determining their position in the pipeline, but the order value
itself is not echoed in any documented response — stages are returned
in pipeline order.
Show child attributes
Show child attributes
Was this page helpful?