Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent
Jobs

Update a Talent Pipeline Stage

Updates a talent to a pipeline stage for a job.

put/v1/pipeline/talent-stage/{pipelineId}

Path parameters

pipelineIdstring required

The identifier for the pipeline.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

idinteger

The identifier for the pipeline.

talentIdinteger required

The identifier for the talent.

jobIdinteger required

The identifier for the job.

jobActivityIdinteger

The identifier for the job activity.

jobActivityNamestring

The name of the job activity/talent pipeline stage.

stagedDatestring date-time required

The date the talent was added to a pipeline stage. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

jobActivityDatestring date-time required

The date of the job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

declinedStageDatestring date-time

The date the talent declined the job. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

pipelineStagestring required

The pipeline stage.

creditTointeger

The identifier for the talent's representative or recruiter user record.

messagestring

The response message returned to the API caller.

Example request

{
  "id": 15741,
  "talentId": 189482,
  "jobId": 175529,
  "jobActivityId": 7382,
  "jobActivityName": "Pipelined",
  "pipelineStage": "General",
  "creditTo": 24398,
  "message": "Please note that this applicant was previously pipelined, but then declined."
}

Response

The talent pipeline stage.

idinteger

The identifier for the pipeline.

talentIdinteger required

The identifier for the talent.

jobIdinteger required

The identifier for the job.

jobActivityIdinteger

The identifier for the job activity.

jobActivityNamestring

The name of the job activity/talent pipeline stage.

stagedDatestring date-time required

The date the talent was added to a pipeline stage. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

jobActivityDatestring date-time required

The date of the job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

declinedStageDatestring date-time

The date the talent declined the job. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

pipelineStagestring required

The pipeline stage.

creditTointeger

The identifier for the talent's representative or recruiter user record.

messagestring

The response message returned to the API caller.

Example response

{
  "id": 15741,
  "talentId": 189482,
  "jobId": 175529,
  "jobActivityId": 7382,
  "jobActivityName": "Pipelined",
  "pipelineStage": "General",
  "creditTo": 24398,
  "message": "Please note that this applicant was previously pipelined, but then declined."
}