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

# Move a Lead Ads Page

> Moves a Page link to another WhatsApp number of the workspace. Body: `{ "whatsappNumberId": "<id>" }` and nothing else. Only **new** leads follow; leads already captured keep the number they arrived on.

When the new number sends a different kind of message (official template vs. unofficial free text) or sits on another WABA, every auto-send of the link's forms is switched **off** and the response says `autoSendDisabled: true` — review the forms with `PUT /v1/lead-pages/{pageLinkId}/forms/{formId}` before turning it back on.

Both the current number and the target must be inside the credential's scope (`403 NUMBER_NOT_IN_GRANT`). OAuth/MCP tokens need `integrations:manage` (workspace ADMIN or OWNER) on every verb, reads included. Scope: a number-scoped key, or an account-wide credential with `x-whatsapp-number-id`, acts only on that number's links; an account-wide credential without the header sees the whole workspace.



## OpenAPI

````yaml openapi.json PATCH /v1/lead-pages/{pageLinkId}
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/lead-pages/{pageLinkId}:
    patch:
      tags:
        - Ads
      summary: Move a Lead Ads Page to another number
      description: >-
        Moves a Page link to another WhatsApp number of the workspace. Body: `{
        "whatsappNumberId": "<id>" }` and nothing else. Only **new** leads
        follow; leads already captured keep the number they arrived on.


        When the new number sends a different kind of message (official template
        vs. unofficial free text) or sits on another WABA, every auto-send of
        the link's forms is switched **off** and the response says
        `autoSendDisabled: true` — review the forms with `PUT
        /v1/lead-pages/{pageLinkId}/forms/{formId}` before turning it back on.


        Both the current number and the target must be inside the credential's
        scope (`403 NUMBER_NOT_IN_GRANT`). OAuth/MCP tokens need
        `integrations:manage` (workspace ADMIN or OWNER) on every verb, reads
        included. Scope: a number-scoped key, or an account-wide credential with
        `x-whatsapp-number-id`, acts only on that number's links; an
        account-wide credential without the header sees the whole workspace.
      operationId: patch_lead-page
      parameters:
        - name: pageLinkId
          in: path
          required: true
          description: >-
            The link id (`linked[].pageLinkId` from `GET /v1/lead-pages`), not
            the Facebook Page id.
          schema:
            type: string
          example: cmgpl0001ab12cd34ef56
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Narrows an account-wide credential to one number (its id or instance
            id from `GET /v1/numbers`). Without it, an account-wide credential
            sees the whole workspace; a number-scoped key always sees only its
            own number.
          schema:
            type: string
          example: num_01HZX...
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                whatsappNumberId:
                  type: string
                  description: Number that receives the Page's new leads.
                  example: num_01HZY...
              required:
                - whatsappNumberId
              additionalProperties: false
      responses:
        '200':
          description: Page link moved
          content:
            application/json:
              example:
                link:
                  pageLinkId: cmgpl0001ab12cd34ef56
                  pageId: '102345678901234'
                  pageName: MM Design
                  whatsappNumberId: num_01HZY...
                  subscribedAt: '2026-10-06T10:15:00.000Z'
                  subscriptionError: null
                  linkedAt: '2026-10-06T10:14:58.000Z'
                  leadsCount: 42
                autoSendDisabled: true
        '400':
          description: >-
            `INVALID_BODY`, `UNKNOWN_FIELDS` (with `unknownFields`),
            `VALIDATION_FAILED`, or `NUMBER_REQUIRED` (a per-number OAuth grant
            without `x-whatsapp-number-id`) or `NUMBER_NOT_FOUND` (a
            number-scoped key whose number was deleted)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Unknown field(s): token. This endpoint accepts only:
                  whatsappNumberId. | Campo(s) desconhecido(s): token. Este
                  endpoint aceita apenas: whatsappNumberId.
                code: UNKNOWN_FIELDS
                unknownFields:
                  - token
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: >-
            The number is outside the credential's scope
            (`NUMBER_NOT_IN_GRANT`), or an OAuth token whose workspace role
            lacks `integrations:manage` (`PERMISSION_DENIED`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  This credential is not granted access to that WhatsApp number
                  | Esta credencial não tem acesso a esse número de WhatsApp
                code: NUMBER_NOT_IN_GRANT
        '404':
          description: >-
            Page link not found (`NOT_FOUND`), or the target number is not this
            workspace's (`NUMBER_NOT_FOUND`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Page link not found | Vínculo de página não encontrado
                code: NOT_FOUND
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Internal server error | Erro interno do servidor
                code: INTERNAL_ERROR
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````

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