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

# Create streak freezes for multiple users

> Create streak freezes for multiple users.



## OpenAPI

````yaml https://admin.trophy.so/v1/openapi post /streaks/freezes
openapi: 3.1.0
info:
  title: Trophy
  version: 1.19.0
servers:
  - x-fern-server-name: Admin API
    url: https://admin.trophy.so/v1
    description: Admin API
security: []
paths:
  /streaks/freezes:
    servers:
      - url: https://admin.trophy.so/v1
        description: Admin API
    parameters:
      - $ref: '#/components/parameters/TenantId'
    post:
      tags:
        - Admin
      summary: Create streak freezes for multiple users
      description: Create streak freezes for multiple users.
      operationId: admin_streaks_freezes_create
      requestBody:
        description: Array of freezes to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStreakFreezesRequest'
            examples:
              Create freezes for multiple users:
                value:
                  freezes:
                    - userId: user-123
                    - userId: user-456
                    - userId: user-123
      responses:
        '200':
          description: Successful operation (no freezes created)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateStreakFreezesResponse'
              examples:
                Success with warnings:
                  value:
                    issues:
                      - userId: user-789
                        severity: warning
                        message: Would exceed maximum freeze limit
                Mixed success and errors:
                  value:
                    issues:
                      - userId: non-existent-user
                        severity: error
                        message: User does not exist
                      - userId: user-456
                        severity: warning
                        message: Would exceed maximum freeze limit
        '201':
          description: Created (at least one freeze created)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateStreakFreezesResponse'
              examples:
                Success with no issues:
                  value:
                    issues: []
                Mixed success and warnings:
                  value:
                    issues:
                      - userId: user-456
                        severity: warning
                        message: Would exceed maximum freeze limit
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminErrorBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminErrorBody'
        '422':
          description: Unprocessible Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminErrorBody'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: javascript
          source: |
            import { TrophyApiClient } from '@trophyso/node';

            const trophy = new TrophyApiClient({
              apiKey: 'YOUR_API_KEY'
            });

            const response = await trophy.admin.streaks.freezes.create({
              freezes: [
                { userId: 'user-123' },
                { userId: 'user-456' },
              ]
            });
        - lang: python
          source: |
            from trophy import TrophyApi

            client = TrophyApi(api_key='YOUR_API_KEY')

            response = client.admin.streaks.freezes.create({
              "freezes": [
                {"userId": "user-123"},
                {"userId": "user-456"}
              ]
            })
        - lang: go
          source: >
            import (
              "context"

              api "github.com/trophyso/trophy-go"
              trophyclient "github.com/trophyso/trophy-go/client"
              "github.com/trophyso/trophy-go/option"
            )


            client := trophyclient.NewClient(
              option.WithApiKey("YOUR_API_KEY"),
            )


            response, err := client.Admin.Streaks.Freezes.Create(context.TODO(),
            nil)
components:
  parameters:
    TenantId:
      name: Tenant-ID
      in: header
      description: >-
        The tenant identifier for multi-tenant organisations. Required when the
        organisation has multi-tenancy enabled. Pass your own internal customer
        ID for the tenant. Ignored for single-tenant organisations.
      required: false
      schema:
        type: string
      example: customer_12345
  schemas:
    CreateStreakFreezesRequest:
      title: CreateStreakFreezesRequest
      type: object
      description: Request body for creating streak freezes.
      properties:
        freezes:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
                description: The ID of the user to create a freeze for.
                example: user-123
            required:
              - userId
          description: Array of freezes to create. Maximum 100 freezes per request.
          maxItems: 100
          minItems: 1
      required:
        - freezes
    CreateStreakFreezesResponse:
      title: CreateStreakFreezesResponse
      type: object
      description: >-
        Response containing any issues encountered while creating streak
        freezes.
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/AdminIssue'
          description: Array of issues encountered during freeze creation.
      required:
        - issues
    AdminErrorBody:
      title: AdminErrorBody
      type: object
      properties:
        error:
          type: string
      required:
        - error
    AdminIssue:
      title: AdminIssue
      type: object
      description: An issue encountered while processing an item in an admin API request.
      properties:
        id:
          type: string
          description: The ID of the resource the issue relates to, when applicable.
          example: 550e8400-e29b-41d4-a716-446655440000
        userId:
          type: string
          description: The ID of the user the issue relates to, when applicable.
          example: user-123
        boostId:
          type: string
          description: The ID of the points boost the issue relates to, when applicable.
          example: 550e8400-e29b-41d4-a716-446655440000
        index:
          type: integer
          description: >-
            The zero-based index of the item the issue relates to, when no
            resource ID exists yet.
          example: 0
        severity:
          type: string
          enum:
            - error
            - warning
          description: The severity level of the issue.
          example: warning
        message:
          type: string
          description: A human-readable description of the issue.
          example: Would exceed maximum freeze limit
      required:
        - severity
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````