> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hireloam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update prospect pipeline stage

> Update a shortlisted prospect's pipeline stage.



## OpenAPI

````yaml /docs/openapi.yaml patch /sourcing/prospects/{prospectId}/pipeline-stage
openapi: 3.1.0
info:
  title: Loam API
  description: >
    The Loam API allows you to programmatically manage your applicant tracking
    system.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```

    Authorization: Bearer lk_your_api_key_here

    ```


    You can create API keys in your [Settings > API
    Keys](https://hireloam.com/settings/api-keys) page.


    ## Rate Limits


    API requests are rate limited to 1000 requests per hour per API key.

    Rate limit headers are included in all responses:


    - `X-RateLimit-Limit`: Maximum requests per hour

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the limit resets
  version: 1.0.0
  contact:
    name: Loam Support
    email: support@hireloam.com
servers:
  - url: https://hireloam.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Jobs
    description: Manage job postings
  - name: Applications
    description: Manage applications and candidates
  - name: Notes
    description: Add notes to applications
  - name: Feedback
    description: Add interview feedback
  - name: Candidates
    description: Manage candidate profiles
  - name: Search
    description: Search candidates
  - name: Sourcing
    description: Sourcing searches, prospects, and shortlists
paths:
  /sourcing/prospects/{prospectId}/pipeline-stage:
    patch:
      tags:
        - Sourcing
      summary: Update prospect pipeline stage
      description: Update a shortlisted prospect's pipeline stage.
      operationId: updateProspectPipelineStage
      parameters:
        - name: prospectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - pipeline_stage
              properties:
                pipeline_stage:
                  type: string
                  enum:
                    - not_contacted
                    - contacted
                    - interested
                    - not_interested
            example:
              pipeline_stage: contacted
      responses:
        '200':
          description: Pipeline stage updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  prospect:
                    $ref: '#/components/schemas/Prospect'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Prospect:
      type: object
      properties:
        id:
          type: string
          format: uuid
        full_name:
          type: string
        current_title:
          type: string
          nullable: true
        current_company:
          type: string
          nullable: true
        linkedin_url:
          type: string
          format: uri
          nullable: true
        email:
          type: string
          format: email
          nullable: true
        location:
          type: string
          nullable: true
        years_experience:
          type: integer
          nullable: true
        summary:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - discovered
            - shortlisted
            - converted
        pipeline_stage:
          type: string
          enum:
            - not_contacted
            - contacted
            - interested
            - not_interested
          nullable: true
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - rate_limit_exceeded
                - internal_error
            message:
              type: string
            details:
              type: object
  responses:
    BadRequest:
      description: Bad request - invalid or missing parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: job_id is required
    Unauthorized:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Invalid or missing API key
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: 'Missing required scope: write'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Application not found
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: internal_error
              message: An internal error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from Settings > API Keys

````