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

# Invite a candidate to apply

> FIRST CONTACT only: invites a talent-database / search candidate to apply to one of your jobs, with your custom message. Tip: include an interview booking link so interested candidates can pick a slot. One invite per (job, candidate) pair — if already invited or already in the job pipeline, returns 409 already_exists_in_job_pipeline; use POST /messages with threadId for follow-ups instead. Replies land in your Cutshort inbox.

Requires scope `messages:write` (production keys). Metered on the workspace messages quota (check GET /usage). Rate limits: 10 inviteToApply + 120 global requests per 60s per API key.



## OpenAPI

````yaml /openapi/public-api-v1.json post /invite-to-apply
openapi: 3.1.0
info:
  title: Cutshort Public API v1
  version: 1.0.0
  description: >-
    Programmatic access to Cutshort's tech talent database. All endpoints
    require `Authorization: Bearer cs_live_<key>`.


    **Core flow:** search candidates → get candidate details (auto-unlock) →
    post a job → invite to apply (first contact) → list applications → send
    message (in-thread follow-up).
servers:
  - url: https://cutshort.io/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: Talent database search
  - name: Candidates
    description: Candidate detail with auto-unlock (contact info + resume)
  - name: Jobs
    description: Job posting and listing
  - name: Outreach
    description: >-
      Candidate outreach: first-contact invite to apply, and in-thread follow-up
      messages
  - name: Usage
    description: Cycle usage meters and quotas
  - name: Stages
    description: Job pipeline stages and counts
  - name: Applications
    description: List applications and move them between pipeline stages
paths:
  /invite-to-apply:
    post:
      tags:
        - Outreach
      summary: Invite a candidate to apply
      description: >-
        FIRST CONTACT only: invites a talent-database / search candidate to
        apply to one of your jobs, with your custom message. Tip: include an
        interview booking link so interested candidates can pick a slot. One
        invite per (job, candidate) pair — if already invited or already in the
        job pipeline, returns 409 already_exists_in_job_pipeline; use POST
        /messages with threadId for follow-ups instead. Replies land in your
        Cutshort inbox.


        Requires scope `messages:write` (production keys). Metered on the
        workspace messages quota (check GET /usage). Rate limits: 10
        inviteToApply + 120 global requests per 60s per API key.
      operationId: inviteToApply
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - talentCardId
                - jobId
                - message
              properties:
                talentCardId:
                  type: string
                  description: Candidate to invite (from search results)
                jobId:
                  type: string
                  description: Your job the candidate is invited to apply for
                message:
                  type: string
                  maxLength: 3000
                  description: >-
                    Outreach message; may include links (e.g. an interview
                    booking link)
      responses:
        '200':
          description: Invite sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  talentCardId:
                    type: string
                  jobId:
                    type: string
                  threadId:
                    type: string
                    nullable: true
                    description: Conversation thread created for this invite
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            Candidate already invited or already in this job pipeline
            (error_code already_exists_in_job_pipeline)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          description: Upstream invite failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Insufficient scope (e.g. eval key calling a production-only endpoint)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    TooManyRequests:
      description: >-
        Rate limit (error_code `rate_limit_exceeded`, `Retry-After` header) or
        cycle quota exhausted (`api_unlock_limit_reached`,
        `api_search_limit_reached`, `api_message_limit_reached`,
        `search_throttled`). Check GET /usage for used/limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      properties:
        error_code:
          type: string
        error_description:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace-scoped API key. Prefix: `cs_live_`. Eval keys (self-serve from
        Cutshort → Settings → Integrations → API Key) can search and get
        candidate details within small quotas; production keys add job posting
        and candidate messaging with higher limits.

````