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

# Replace an agent's round-robin transfer list

> Replaces the whole list: array order is rotation order, at most 50 numbers, and rows left out are removed. Send a row's `id` to keep an existing number. Available only while round-robin transfer is enabled for your workspace; otherwise `404 not_found`. See [Round-robin transfer](/guides/call-transfer-round-robin).

**Required scope:** `agents.edit`


## OpenAPI

````yaml /api-reference/openapi.json put /agents/{id}/transfer-targets
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers and results
    in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /agents/{id}/transfer-targets:
    put:
      summary: Replace an agent's round-robin transfer list
      description: >-
        Replaces the whole list: array order is rotation order, at most 50
        numbers, and rows left out are removed. Send a row's `id` to keep an
        existing number. Available only while round-robin transfer is enabled
        for your workspace; otherwise `404 not_found`. See [Round-robin
        transfer](/guides/call-transfer-round-robin).
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targets:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        nullable: true
                        description: >-
                          An existing target of this agent to keep (its identity
                          is kept on past calls). Omit or null for a new number.
                      label:
                        type: string
                        maxLength: 200
                        description: >-
                          Name of the person or desk, 1-80 characters after
                          trimming.
                      phoneNumber:
                        type: string
                        maxLength: 64
                        description: E.164. The + is optional for a 10-digit Indian number.
                      active:
                        type: boolean
                        description: >-
                          Default true. An inactive number is skipped by the
                          rotation.
                    required:
                      - label
                      - phoneNumber
                  maxItems: 500
              required:
                - targets
      responses:
        '200':
          description: OK — the stored list
          content:
            application/json:
              schema:
                type: object
                properties:
                  targets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        phoneNumber:
                          type: string
                          description: E.164, e.g. +919876543210
                        active:
                          type: boolean
                        position:
                          type: integer
                          description: 0-based rotation order
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - label
                        - phoneNumber
                        - active
                        - position
                        - createdAt
                        - updatedAt
                  warnings:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                required:
                  - targets
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_transfer_targets`: The transfer list breaks a rule;
            `issues` lists each problem with its row `index`, `field` and `code`
            (`too_many_targets`, `label_required`, `label_too_long`,
            `invalid_phone_number`, `duplicate_phone_number`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_transfer_targets
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                          nullable: true
                          description: >-
                            Row index in the submitted array; null for the whole
                            list.
                        field:
                          type: string
                          enum:
                            - targets
                            - label
                            - phoneNumber
                        code:
                          type: string
                          enum:
                            - too_many_targets
                            - label_required
                            - label_too_long
                            - invalid_phone_number
                            - duplicate_phone_number
                        message:
                          type: string
                      required:
                        - index
                        - field
                        - code
                        - message
                required:
                  - error
                  - issues
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '409':
          description: >-
            - `agent_archived`: The agent is archived. `409` when updating it;
            `400` when assigning it to an inbound number.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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