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

# Add campaign recipients

> Adds up to 1,000 recipients to a campaign that has not been launched. A number already on the campaign is skipped. Invalid entries are reported, not added. A campaign that has been launched answers `409`. Send `projectId` in the body when using a team API key.

Requires `campaigns:manage`. Project tokens only access resources in their own project.



## OpenAPI

````yaml api-reference/features/engage-at-scale.json POST /platform/campaigns/{campaignId}/recipients
openapi: 3.0.3
info:
  title: Engage at scale API methods
  version: 1.0.0
  description: >-
    Task-focused engage at scale methods across supported Polymorfa connection
    types.
servers: []
security: []
paths:
  /platform/campaigns/{campaignId}/recipients:
    post:
      tags:
        - Campaigns
      summary: Add campaign recipients
      description: >-
        Adds up to 1,000 recipients to a campaign that has not been launched. A
        number already on the campaign is skipped. Invalid entries are reported,
        not added. A campaign that has been launched answers `409`. Send
        `projectId` in the body when using a team API key.


        Requires `campaigns:manage`. Project tokens only access resources in
        their own project.
      operationId: managementAddCampaignRecipients
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
          description: Identifier for the campaign.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                projectId:
                  type: string
                  format: uuid
                  description: |-
                    Identifier of the Polymorfa project that owns this resource.

                    <!-- polymorfa-input-table -->
                    **Value constraints**
                    | Constraint | Accepted input |
                    | --- | --- |
                    | Format | `uuid` |
                recipients:
                  type: array
                  minItems: 1
                  maxItems: 1000
                  description: |-
                    At most 1,000 recipients per request.

                    <!-- polymorfa-input-table -->
                    **Value constraints**
                    | Constraint | Accepted input |
                    | --- | --- |
                    | Array size | `1` through `1000` items |
                  items:
                    $ref: '#/components/schemas/management__RecipientInput'
              required:
                - recipients
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    allOf:
                      - $ref: >-
                          #/components/schemas/management__CampaignRecipientAppendResult
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
        '409':
          $ref: '#/components/responses/management__Conflict'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
components:
  schemas:
    management__RecipientInput:
      type: object
      additionalProperties: false
      properties:
        phone:
          type: string
          minLength: 1
          maxLength: 64
          description: >-
            Number in international format, for example `+14155550100`. Spaces,
            dots, hyphens and parentheses are ignored; a leading `00` is read as
            `+`; digits without `+` are read as including the country code.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | String length | `1` through `64` characters |
        variables:
          type: object
          maxProperties: 50
          additionalProperties:
            oneOf:
              - type: string
                maxLength: 1024
              - type: number
              - type: boolean
          description: >-
            Template variables. Names use letters, digits, `_`, `.` or `-` (at
            most 64 characters). Values are stored as strings.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Object size | At most `50` properties |
      required:
        - phone
    management__CampaignRecipientAppendResult:
      type: object
      additionalProperties: false
      properties:
        campaignId:
          type: string
          format: uuid
          description: |-
            Identifier for the campaign.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        added:
          type: integer
          minimum: 0
          description: >-
            Specifies added for this management campaign recipient append
            result.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        recipientCount:
          type: integer
          minimum: 0
          description: |-
            Number of recipients.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        duplicateCount:
          type: integer
          minimum: 0
          description: >-
            Valid entries skipped because the number was repeated or is already
            on the campaign.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        invalidCount:
          type: integer
          minimum: 0
          description: |-
            Number of invalids.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        invalidRows:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/management__InvalidRecipientRow'
          description: >-
            Invalid rows associated with this management campaign recipient
            append result.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Array size | At most `20` items |
      required:
        - campaignId
        - added
        - recipientCount
        - duplicateCount
        - invalidCount
        - invalidRows
    management__InvalidRecipientRow:
      type: object
      additionalProperties: false
      properties:
        row:
          type: integer
          minimum: 1
          description: >-
            1-based entry position for inline input; spreadsheet row number for
            a file, where the header is row 1.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `1` or greater |
        reason:
          type: string
          enum:
            - missing_phone
            - invalid_phone
            - invalid_variables
            - invalid_entry
          description: |-
            Reason for the reported state or outcome.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `missing_phone` | Missing phone. |
            | `invalid_phone` | Invalid phone. |
            | `invalid_variables` | Invalid variables. |
            | `invalid_entry` | Invalid entry. |
      required:
        - row
        - reason
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
            request_id:
              type: string
              description: >-
                Matches the X-Request-Id response header. Include it when you
                contact support.
            request_log_url:
              type: string
              format: uri
              description: >-
                Console page that shows this request. Returned only to
                organization and project credentials whose request was logged.


                <!-- polymorfa-input-table -->

                **Value constraints**

                | Constraint | Accepted input |

                | --- | --- |

                | Format | `uri` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated team or
        project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Conflict:
      description: The request conflicts with the resource's current state.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Send your team API key or project token as `Authorization: Bearer
        <token>`. The credential must have the required permissions. Project
        tokens can access only their own project.

````