> ## 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.

# Preview a move from HeyReach

> What moving this campaign would do. Nothing is written, here or in HeyReach. The move itself needs a signed-in person, in the app.



## OpenAPI

````yaml /api/openapi.json post /integrations/heyreach/campaigns/{campaign_id}/move-preview
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:
  /integrations/heyreach/campaigns/{campaign_id}/move-preview:
    post:
      tags:
        - Integrations
      summary: Preview a move from HeyReach
      description: >-
        What moving this campaign would do. Nothing is written, here or in
        HeyReach. The move itself needs a signed-in person, in the app.
      operationId: post_integrations_heyreach_campaigns_campaign_id_move_preview
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/MoveRequest'
                - type: 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MovePreviewResponse'
        '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:
    MoveRequest:
      properties:
        sender_map:
          additionalProperties:
            type: string
            format: uuid
          type: object
        confirm_unplaced:
          type: boolean
          default: false
        approval_mode:
          type: string
          enum:
            - step
            - sequence
          default: step
        name:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
      additionalProperties: false
      type: object
    MovePreviewResponse:
      properties:
        campaign_id:
          type: string
        campaign_name:
          type: string
        campaign_status:
          type: string
        people_total:
          type: integer
        people_continue:
          type: integer
        already_replied:
          type: integer
        finished:
          type: integer
        do_not_contact:
          type: integer
        left_out_no_person:
          type: integer
        unknown_position:
          type: integer
          default: 0
        already_in_other_campaign:
          type: integer
          default: 0
        failed:
          type: integer
          default: 0
        senders:
          items:
            $ref: '#/components/schemas/MoveSender'
          type: array
        steps:
          items:
            $ref: '#/components/schemas/MoveStep'
          type: array
        unsupported_steps:
          items:
            $ref: '#/components/schemas/MoveUnsupportedStep'
          type: array
        custom_variables:
          items:
            type: string
          type: array
        warnings:
          items:
            type: string
          type: array
        blockers:
          items:
            type: string
          type: array
        can_move:
          type: boolean
          default: false
        already_moved_workflow_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        unfinished_move_workflow_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
      type: object
      required:
        - campaign_id
        - campaign_name
        - campaign_status
        - people_total
        - people_continue
        - already_replied
        - finished
        - do_not_contact
        - left_out_no_person
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    MoveSender:
      properties:
        heyreach_sender_id:
          anyOf:
            - type: string
            - type: 'null'
        heyreach_name:
          type: string
        people:
          type: integer
          default: 0
        matched_account_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        match_by:
          type: string
          enum:
            - profile_url
            - name
            - override
            - none
          default: none
      type: object
      required:
        - heyreach_name
    MoveStep:
      properties:
        type:
          type: string
        text:
          anyOf:
            - type: string
            - type: 'null'
        delay:
          type: string
        variants:
          type: integer
          default: 0
      type: object
      required:
        - type
        - delay
    MoveUnsupportedStep:
      properties:
        type:
          type: string
        reason:
          type: string
        delay:
          type: string
      type: object
      required:
        - type
        - reason
        - delay
    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.