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

> Add recipients manually.

# Add recipients manually (user IDs)



## OpenAPI

````yaml post /campaigns/{id}/recipients
openapi: 3.0.0
info:
  title: Campaigns Service API
  description: Campaigns Service REST API
  version: '1.0'
  contact: {}
servers:
  - url: https://{appId}.api-{region}.cometchat.io/v3/campaigns
    variables:
      appId:
        default: appId
        description: (Required) App ID
      region:
        enum:
          - us
          - eu
          - in
        default: us
        description: Select Region
security:
  - apikey: []
tags:
  - name: Notification Feed
    description: Operations on the per-user in-app notification feed.
  - name: Channels
    description: Manage channel instances and per-type availability.
  - name: Templates
    description: Manage templates and their versions.
  - name: Template Categories
    description: Manage template categories for feed filtering.
  - name: Campaigns
    description: Create, schedule, and manage notification campaigns.
  - name: Notifications
    description: Send notifications directly via API.
  - name: Push Notifications
    description: Manage push notification delivery and engagement.
  - name: Analytics
    description: Delivery and engagement analytics.
paths:
  /campaigns/{id}/recipients:
    post:
      tags:
        - Campaigns
      summary: Add recipients manually (user IDs)
      operationId: CampaignsController_addRecipients
      parameters:
        - name: appid
          in: header
          description: Tenant application ID
          required: true
          schema:
            type: string
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRecipientsDto'
      responses:
        '201':
          description: Recipients added
        '400':
          description: Campaign not in draft status
components:
  schemas:
    AddRecipientsDto:
      type: object
      properties:
        userIds:
          description: Array of user IDs to add as recipients
          minItems: 1
          maxItems: 10000
          type: array
          items:
            type: string
        userVariables:
          type: object
          description: >-
            Per-user variables, keyed by userId. Persisted on each
            `CampaignRecipient.variables` row at insert time. Renderer
            substitutes these into template content per recipient. Example: `{
            "user_42": { "name": "Ajay" }, "user_43": { "name": "Sam" } }`.
          example:
            user_42:
              name: Ajay
      required:
        - userIds
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: apikey
      description: Your CometChat REST API Key.

````