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

# Send a person to HeyReach

> Queues this person for HeyReach. Answers 409 when they are on Do not contact, have no real name or LinkedIn link, or HeyReach has nowhere to send them. Answers 403 on the Free plan. If they already went to that campaign `queued` is `false`.



## OpenAPI

````yaml /api/openapi.json post /people/{lead_id}/push/heyreach
openapi: 3.1.0
info:
  title: B2B Signals API
  version: '1.0'
  description: >-
    Add people, run campaigns and read results from your own tools. Every
    request needs your API key in the `X-API-Key` header.
servers:
  - url: https://api.b2bsignals.ai/api/v1
security:
  - apiKey: []
tags:
  - name: Add people
    description: >-
      Send people in from your own tools, one at a time or up to 100 per
      request.
  - name: People
    description: >-
      Read and change the people in your workspace. In API paths and fields, a
      person is a `lead`.
  - name: Notes and tasks
    description: Notes on a person, and follow-up tasks.
  - name: Lists
    description: >-
      Named groups of people you can add to a campaign. In API paths, a list is
      a `lead-list`.
  - name: Campaigns
    description: >-
      Read, start, pause and report on campaigns. In API paths and fields, a
      campaign is a `workflow`.
  - name: Campaign people
    description: >-
      One person's place in one campaign. In API paths and fields, that is a
      `workflow-run`.
  - name: Approvals
    description: Messages waiting for a yes or no before they go out.
  - name: Inbox
    description: Read conversations and keep them organized.
  - name: Do not contact
    description: People and companies that must never be contacted.
  - name: Senders
    description: >-
      The LinkedIn accounts that send for your workspace. In API paths, a sender
      is a `connected-account`.
  - name: Webhooks
    description: Send events to your own tools.
  - name: Integrations
    description: See which outside tools are connected, and send people to them.
  - name: Reports
    description: The numbers behind Reports, and exports.
  - name: Watchlists
    description: Read the companies and people you watch.
  - name: Search
    description: Search across people, campaigns, lists and watchlists.
paths:
  /people/{lead_id}/push/heyreach:
    post:
      tags:
        - Integrations
      summary: Send a person to HeyReach
      description: >-
        Queues this person for HeyReach. Answers 409 when they are on Do not
        contact, have no real name or LinkedIn link, or HeyReach has nowhere to
        send them. Answers 403 on the Free plan. If they already went to that
        campaign `queued` is `false`.
      operationId: post_people_lead_id_push_heyreach
      parameters:
        - name: lead_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushQueuedResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The request did not pass validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PushQueuedResponse:
      properties:
        available:
          type: boolean
        destination:
          $ref: '#/components/schemas/PushDestination'
        in_campaign:
          anyOf:
            - $ref: '#/components/schemas/PushInCampaign'
            - type: 'null'
        already_pushed:
          type: boolean
          default: false
        stops_local_run:
          type: boolean
          default: false
        blocked_reason:
          anyOf:
            - type: string
            - type: 'null'
        plan_read_only:
          type: boolean
          default: false
        queued:
          type: boolean
          default: false
      type: object
      required:
        - available
        - destination
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    PushDestination:
      properties:
        campaign_ref:
          anyOf:
            - type: string
            - type: 'null'
        campaign_label:
          anyOf:
            - type: string
            - type: 'null'
        decided_by:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    PushInCampaign:
      properties:
        workflow_id:
          type: string
          format: uuid
        name:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - workflow_id
    Error:
      type: object
      required:
        - detail
      properties:
        detail:
          description: A message, or an object with a `code` and a `message`.
          anyOf:
            - type: string
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  responses:
    Unauthorized:
      description: The key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The key cannot do this, or your plan does not include it. `detail` says
        which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your workspace's API key. It starts with `b2b_sk_`.

````

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