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

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, calls, campaigns, contacts, phone numbers, billing, and configuration.

# Move phone number

> Move a caller ID from one campaign to another in a single operation. Allowed customer role: `agency_admin`.

Required API key scope: `phone_numbers:write`.



## OpenAPI

````yaml /openapi.yaml post /api/agent-builder/phone-numbers/{number}/campaigns/{campaignId}/move
openapi: 3.1.0
info:
  title: TFUAI Server API
  version: 1.0.0
  description: >-
    API reference for the TFUAI SaaS server.


    All published endpoints are mounted under `/api`. Responses use a standard
    envelope: `{ "success": true, ... }` on success and `{ "success": false,
    "error": "..." }` on failure.


    Product API modules are being launched module by module. This spec currently
    exposes only contracted public modules.


    Authenticate public API requests with an API key in the `Authorization`
    header: `Authorization: Bearer YOUR_API_KEY`.
servers:
  - url: https://api.teamfollowup.ai
    description: Production API origin. Public API paths are under /api.
  - url: https://devapi.teamfollowup.ai
    description: Development API origin. Public API paths are under /api.
security: []
tags:
  - name: Agents
    description: Manage voice agents, campaigns, workflows, and outcomes.
  - name: Analytics
    description: >-
      Minimal, non-billing performance summary: volume, conversion, and pickup
      metrics.
  - name: Calls
    description: Review calls, test runs, and execution history.
  - name: Campaign Workflows
    description: >-
      What runs after a call lands: for each outcome (booked, opted out, asked
      for a callback…), an ordered chain of actions — tag the contact, move a
      pipeline stage, send an SMS, book an appointment. Stored as a graph:
      `nodes` are the actions, `edges` say what follows what, and
      `dispositionEntries` maps each outcome to the node its chain starts at.


      **Pick the narrowest endpoint that does the job.**


      | To | Call | |

      | --- | --- | --- |

      | See what fires per outcome | `GET .../workflow/digest` | Reads as plain
      text, no graph walking |

      | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server
      derives node ids, edge ids, handles, layout |

      | Change a message, tag or setting | `PATCH .../workflow` | Merges;
      carries no graph, so it cannot damage one |

      | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain
      around it |

      | Author or replace the whole graph | `PUT .../workflow` | Replaces
      everything you send |


      `PUT` is the only one that can re-wire, position nodes, build an `if`,
      save an unconfigured draft, or copy a whole workflow — and the only one
      that can overwrite a change someone else made after you read it. Use it
      when you are genuinely authoring the graph, and send `expectedVersion`
      when you do. For everything else the narrower endpoints are both easier
      and safer.
  - name: Contacts
    description: Contact list, filters, contact call history, and do-not-call actions.
  - name: GHL
    description: CRM variables and contact helpers used by agent and campaign setup flows.
  - name: Phone Numbers
    description: >-
      Caller ID pool, number search, assignment, movement, and release
      endpoints.
  - name: Power Dialer
    description: >-
      Power Dialer queue, lead cadence, callback, parked lead, and campaign
      schedule endpoints.
  - name: Projects
    description: >-
      Project management endpoints: list, update, disconnect, configure project
      campaigns, and validate setup.
  - name: Skills and Tools
    description: Manage reusable agent behaviors and in-call tool descriptions.
  - name: Voices
    description: Voice catalogue endpoints for choosing the voice used by an agent.
paths:
  /api/agent-builder/phone-numbers/{number}/campaigns/{campaignId}/move:
    post:
      tags:
        - Phone Numbers
      summary: Move phone number
      description: >-
        Move a caller ID from one campaign to another in a single operation.
        Allowed customer role: `agency_admin`.


        Required API key scope: `phone_numbers:write`.
      operationId: post-agent-builder-phone-numbers-by-number-campaigns-by-campaignId-move
      parameters:
        - name: number
          in: path
          required: true
          schema:
            type: string
            pattern: ^\+\d{10,15}$
          description: >-
            E.164 phone number. URL-encode the leading `+` when placing it in
            the path.
          example: '+14155551234'
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
          description: Campaign id.
          example: campaign_speed_to_lead_123
      requestBody:
        required: true
        description: Destination campaign.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumbersMoveRequest'
            examples:
              default:
                value:
                  toCampaignId: campaign_speed_to_lead_456
      responses:
        '200':
          description: Phone number moved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersMoveResponse'
              examples:
                default:
                  value:
                    success: true
                    phoneNumber: '+14155551234'
                    fromCampaignId: campaign_speed_to_lead_123
                    toCampaignId: campaign_speed_to_lead_456
                    moved: true
        '400':
          description: Validation failed or the request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: VALIDATION
                    message: A campaignId is required.
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unauthorized
                    message: Authentication required.
        '403':
          description: Authenticated but not permitted to manage phone numbers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Forbidden
                    message: You do not have access to phone number endpoints.
        '404':
          description: Agent, campaign, or phone number not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: NotFound
                    message: Campaign "campaign_missing" not found or not accessible.
        '409':
          description: >-
            The requested phone number change conflicts with current campaign
            state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: CONFLICT
                    message: >-
                      This is the only number on an active campaign. Pause the
                      campaign or add another number before removing it.
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: TooManyRequests
                    message: Too many requests, please try again later.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumbersErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: InternalError
                    message: Unexpected server error.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request POST \
              --url https://api.teamfollowup.ai/api/agent-builder/phone-numbers/{number}/campaigns/{campaignId}/move \
              --header 'Authorization: Bearer YOUR_API_KEY' \
              --header 'Content-Type: application/json' \
              --data '{
              "toCampaignId": "campaign_speed_to_lead_456"
            }'
components:
  schemas:
    PhoneNumbersMoveRequest:
      type: object
      additionalProperties: false
      required:
        - toCampaignId
      properties:
        toCampaignId:
          type: string
          description: Destination campaign id.
          example: campaign_speed_to_lead_456
    PhoneNumbersMoveResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - phoneNumber
        - fromCampaignId
        - toCampaignId
        - moved
      properties:
        success:
          type: boolean
        phoneNumber:
          type: string
          pattern: ^\+\d{10,15}$
          example: '+14155551234'
        fromCampaignId:
          type: string
          example: campaign_speed_to_lead_123
        toCampaignId:
          type: string
          example: campaign_speed_to_lead_456
        moved:
          type: boolean
          example: true
    PhoneNumbersErrorResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - error
        - message
      properties:
        success:
          type: boolean
        error:
          type: string
          description: Machine-readable error code.
          example: CONFLICT
        message:
          type: string
          description: Human-readable explanation safe to show to an operator.
          example: >-
            This is the only number on an active campaign. Pause the campaign or
            add another number before removing it.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.'

````