Skip to main content
Update Talent Stage
POST
POST
https://api.atzcrm.com/v1/candidate/:candidateSlug/talent-stage/:jobSlug

Update the talent stage of a candidate for a specific job.

Request Example​

{
    "talent_stage_id": 2,
    "comment": "Candidate passed initial screening",
    "stage_date": "2024-06-15",
    "updated_by": 1
}

Request​

Path Parameters

  • candidateSlugstring

    The unique slug of the candidate (required). Example: candidate_2f0ea5cd69a6cd6c7163

  • jobSlugstring

    The unique slug of the job (required). Example: job_a1b2c3d4e5f6a7b8c9d0

Body

  • talent_stage_idinteger

    ID of the talent stage to assign (required). Example: 2. To fetch all available talent stages, use the Get Talent Stages endpoint.

  • commentstring

    Optional note about the stage update.

  • stage_datestring

    Format: YYYY-MM-DD. Example: 2024-06-15

  • updated_byinteger

    ID of the user performing the update.

Headers

  • Authorization: Bearer your_access_token
  • Content-Type: application/json

Response​

200

Body

  • idnumber

    Example: 1024

  • candidateobject

    Example:
    "slug": "candidate_2f0ea5cd69a6cd6c7163"

  • jobobject

    Example:
    "slug": "job_a1b2c3d4e5f6a7b8c9d0"

  • statusobject

    Example:
    "id": 2,
    "name": "Assigned"

  • stage_datestring (ISO 8601)

    Example: 2024-06-15T00:00:00.000Z

  • visibilityinteger

    1 = Visible, 0 = Hidden. Example: 1

  • updated_atstring (ISO 8601)

    Example: 2024-06-15T10:00:00Z

  • updated_byobject

    Example:
    "id": 1,
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "role": "Admin",
    "phone": "+11234567890"

400

Body

  • Unprocessable Entity
401

Body

  • Unauthorized

Response Example​

{
    "id": 1024,
    "candidate": {
        "slug": "candidate_a1b2c3d4e5f6a7b8c9d0"
    },
    "job": {
        "slug": "job_a1b2c3d4e5f6a7b8c9d0"
    },
    "status": {
        "id": 2,
        "name": "Assigned"
    },
    "stage_date": "2024-06-15T00:00:00.000Z",
    "visibility": 1,
    "updated_at": "2024-06-15T10:00:00.000Z",
    "updated_by": {
        "id": 1,
        "email": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "role": "Admin",
        "phone": "+11234567890"
    }
}