---
title: "Add badge to user"
method: POST
path: "/api/v5/badges/add-user-badge"
tags: ["Badges"]
---

# Add badge to user

`POST /api/v5/badges/add-user-badge`

## Request

- Base URL: `https://api.pavlok.com`
- URL: `https://api.pavlok.com/api/v5/badges/add-user-badge`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pavlok/apis/pavlok-api-v5/docs/api/v5/badges/add-user-badge/post.ts> (a function with typed inputs; its response is checked against the schema)

Add badge to user

## Request body

- BodyBadgesAddUserBadgeApiV5BadgesAddUserBadgePost
  - `badge` UserBadgeRestrictedInCreate, required: User Badge schema in create
    - `badgeKey` 'week_using_app', required: Enum containing all badges that can be added through the app directly

## Response `201`

Successful Response

- BadgeInResponse: Badge response model
  - `badge` Badge, required: Badge model
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `deletedAt` string, date-time
    - `id` integer
    - `title` string, required
    - `key` string, required
    - `description` string
    - `image` string
    - `imageId` integer
    - `voltsAction` VoltsAction: VoltsAction Model
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `deletedAt` string, date-time
      - `id` integer
      - `key` string, required
      - `description` string
      - `volts` integer
    - `achievedAt` string, date-time

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/pavlok/apis/pavlok-api-v5.md) - [All operations](https://skmtc.dev/pavlok/apis/pavlok-api-v5/llms.txt) - [OpenAPI document](https://skmtc.dev/pavlok/apis/pavlok-api-v5/revisions/3d192098b1ac?raw)