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

# Batch assign/unassign rewards

> ⚠️ **BETA endpoint**

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Assigns and/or unassigns rewards to/from a program in a single batch.




## OpenAPI

````yaml /openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/rewards/batch
openapi: 3.1.0
info:
  title: Voucherify Loyalty v2 API
  version: 2.0.0
  description: >-
    Complete API documentation for Voucherify Loyalty v2 system. Requires
    LOYALTY_V2 feature flag.
servers:
  - url: https://api.voucherify.io
    description: Production
security:
  - bearerAuth: []
    X-App-Id: []
    X-App-Token: []
tags:
  - name: Card Definitions
    description: >-
      CRUD operations, lifecycle management, and activity history for card
      definitions. Card definitions describe the configuration for loyalty
      cards, including code generation, points expiration, earning/spending
      limits, pending points, refunds, and balance settings.
  - name: Programs
    description: >-
      Loyalty program CRUD, lifecycle management, program-scoped resource
      assignments (card definitions, earning rules, rewards, tier structures),
      member management (create, list, get, activate, deactivate, delete), card
      operations (points adjustment, pending points, expiring points,
      transactions), reward purchases, and activity history.
  - name: Earning Rules
    description: >-
      Manage earning rules that define how customers earn points or receive
      incentives based on triggers (events, segments, custom events). Includes
      CRUD, lifecycle, and activity history.
  - name: Tier Structures
    description: >-
      CRUD operations, lifecycle management, and activity history for tier
      structures. Includes nested tier definitions (create, list, update,
      delete) within tier structures. Tier structures define the tiering model
      for loyalty programs — how members qualify for and move between tiers.
  - name: Incentives
    description: >-
      Manage incentive definitions (fixed points, proportional points, material,
      digital). Includes CRUD, lifecycle transitions, and activity history.
  - name: Rewards
    description: >-
      CRUD, lifecycle operations, and activity history for reward definitions.
      Rewards can be material (product/SKU) or digital (discount coupons, gift
      vouchers).
  - name: Examine
    description: Examines the earning of loyalty points for a loyalty program member.
paths:
  /v2/loyalties/programs/{programId}/rewards/batch:
    post:
      tags:
        - Programs
        - Programs
      summary: Batch assign/unassign rewards
      description: >
        ⚠️ **BETA endpoint**


        This is a work-in-progress documentation of a BETA endpoint. The
        parameters, fields, request and response bodies, and other data may
        subject to change. If you want to share feedback or improvements,
        contact Voucherify support or your Technical Account Manager.


        Assigns and/or unassigns rewards to/from a program in a single batch.
      operationId: batchProcessRewards
      parameters:
        - name: programId
          in: path
          required: true
          description: Unique program identifier
          schema:
            type: string
            pattern: ^lprg_[a-f0-9]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RewardsBatchRequest'
      responses:
        '200':
          description: Batch processing result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RewardsBatchResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    RewardsBatchRequest:
      type: object
      properties:
        assign:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RewardAssignRef'
          maxItems: 10
          description: Rewards to assign
        unassign:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RewardUnassignRef'
          maxItems: 10
          description: Rewards to unassign
      additionalProperties: false
    RewardsBatchResponse:
      type: object
      properties:
        assigned:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ProgramRewardDTO'
          description: Successfully assigned rewards (null if no assign operations)
        unassigned:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ProgramRewardDTO'
          description: Successfully unassigned rewards (null if no unassign operations)
    RewardAssignRef:
      type: object
      required:
        - id
        - costs
        - stock
      properties:
        id:
          type: string
          pattern: ^lrew_[a-f0-9]+$
          description: Reward id to assign
        costs:
          type: array
          items:
            $ref: '#/components/schemas/RewardAssignmentCostsRequest'
          minItems: 1
          maxItems: 10
          description: Cost definitions for this reward assignment
        stock:
          type: integer
          minimum: 0
          maximum: 2147483647
          description: Available stock for the reward
      additionalProperties: false
    RewardUnassignRef:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^lrew_[a-f0-9]+$
          description: Reward id to unassign
      additionalProperties: false
    ProgramRewardDTO:
      type: object
      description: Reward assignment DTO (VLProgramRewardDTO)
      properties:
        reward_id:
          type: string
          pattern: ^lrew_[a-f0-9]+$
          description: Reward identifier
        costs:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RewardAssignmentCostsDTO'
          description: Cost definitions for this reward assignment
        stock:
          type: integer
          description: Available stock
        redeemed:
          type: integer
          description: Number of times redeemed
        created_at:
          type: string
          format: date-time
          description: Assignment creation timestamp
        object:
          type: string
          const: program_reward
    ErrorResponse:
      type: object
      description: Standard error response.
      properties:
        code:
          type: integer
          description: HTTP status code.
        key:
          type: string
          description: Machine-readable error key.
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional error details.
        request_id:
          type:
            - string
            - 'null'
          description: Request identifier for tracing.
        resource_id:
          type: string
          description: Related resource identifier (when applicable).
        resource_type:
          type: string
          description: Related resource type (when applicable).
      required:
        - code
        - key
        - message
    RewardAssignmentCostsRequest:
      type: object
      required:
        - spending
      properties:
        rules:
          $ref: '#/components/schemas/RewardAssignmentCostsRulesRequest'
        spending:
          type: array
          items:
            $ref: '#/components/schemas/RewardAssignmentCostsSpendingRequest'
          minItems: 1
          maxItems: 1
          description: Spending definitions (currently limited to 1)
      additionalProperties: false
    RewardAssignmentCostsDTO:
      type: object
      properties:
        rules:
          description: >-
            Rule group (present only when rules are defined and have
            definitions)
        spending:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RewardAssignmentSpendingDTO'
    RewardAssignmentCostsRulesRequest:
      type: object
      required:
        - logic
      properties:
        logic:
          type: string
          description: Logical formula combining rule definitions (e.g. "1 AND 2")
      additionalProperties: true
      description: >
        Rule group object. Keys are numeric identifiers (e.g. "1", "2") pointing

        to RewardRulesDefinition objects. The `logic` key defines how rules
        combine.
    RewardAssignmentCostsSpendingRequest:
      type: object
      required:
        - points
        - card_definition_id
      properties:
        points:
          type: integer
          minimum: 1
          maximum: 2147483647
          description: Number of points required
        card_definition_id:
          type: string
          pattern: ^lcdef_[a-f0-9]+$
          description: Card definition to deduct points from
      additionalProperties: false
    RewardAssignmentSpendingDTO:
      type: object
      properties:
        points:
          type: integer
          description: Number of points required
        card_definition_id:
          type: string
          description: Card definition to deduct points from
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    X-App-Id:
      type: apiKey
      name: X-App-Id
      in: header
    X-App-Token:
      type: apiKey
      name: X-App-Token
      in: header

````