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

# Take candidates off ParaAI market

> Stop ParaAI matching for up to 100 candidates; they stay in network, boost removed. To resume use POST /talent-network/candidates/re-enable. Ref by candidateUserId (from GET /talent-network/candidates or POST /talent-network/candidates/lookup) or email/linkedinUrl; candidateUserId wins, then linkedinUrl. Identity ref acts on every membership row your agency holds for that person. Always 200; branch on per-item ok. Needs Talent Network management entitlement, else whole request 403. Retries safe, no Idempotency-Key.

Required scopes: `talent_network:write`.



## OpenAPI

````yaml /api/openapi.json post /talent-network/candidates/off-market
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /talent-network/candidates/off-market:
    post:
      summary: Take candidates off ParaAI market
      description: >-
        Stop ParaAI matching for up to 100 candidates; they stay in network,
        boost removed. To resume use POST /talent-network/candidates/re-enable.
        Ref by candidateUserId (from GET /talent-network/candidates or POST
        /talent-network/candidates/lookup) or email/linkedinUrl; candidateUserId
        wins, then linkedinUrl. Identity ref acts on every membership row your
        agency holds for that person. Always 200; branch on per-item ok. Needs
        Talent Network management entitlement, else whole request 403. Retries
        safe, no Idempotency-Key.


        Required scopes: `talent_network:write`.
      operationId: setTalentNetworkCandidatesOffMarket
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                candidates:
                  type: array
                  items:
                    type: object
                    properties:
                      candidateUserId:
                        type: string
                        nullable: true
                        minLength: 1
                        description: >-
                          `candidateUserId` from Talent Network list or lookup
                          row.
                      email:
                        type: string
                        nullable: true
                        description: Exact candidate email, e.g. `jane@example.com`.
                      linkedinUrl:
                        type: string
                        nullable: true
                        description: >-
                          Candidate LinkedIn profile URL, e.g.
                          `https://www.linkedin.com/in/janedoe`.
                  minItems: 1
                  maxItems: 100
                  description: >-
                    1 to 100 candidates, each named by at least one of
                    candidateUserId, email, linkedinUrl; more rejected with 400.
              required:
                - candidates
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                          minimum: 0
                        candidateUserIds:
                          type: array
                          items:
                            type: string
                        ok:
                          type: boolean
                        status:
                          type: string
                          enum:
                            - off_market
                            - already_off_market
                            - pre_excluded
                            - not_found
                          description: >-
                            `off_market`: was on market, now off.
                            `already_off_market`: nothing changed; includes
                            locked candidates. `pre_excluded`: never in network,
                            now excluded from future ParaAI; only fresh submit
                            restores, not re-enable. `not_found`: no candidate
                            of approved agency member matches; same as
                            nonexistent. New values may be added; treat unknown
                            as informational.
                        message:
                          type: string
                      required:
                        - index
                        - ok
                        - status
                required:
                  - results
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.