---
title: "Update a Specific User Badge"
method: PATCH
path: "/api/v2/user-badges/{id}"
tags: ["Badges"]
---

# Update a Specific User Badge

`PATCH /api/v2/user-badges/{id}`

This endpoint updates the supplied fields for a specific badge. <h3>Required Scope</h3>`user_badges:write`

## Path parameters

- `id` string, required

## Request body

- BadgesIdBody
  - `data` Apiv2badgesidData
    - `type` string, nullable
    - `id` string — The unique id of the badge.
    - `attributes` Apiv2badgesidDataAttributes
      - `title` string — The title of the badge.
      - `url` string — The url of the user badge.
      - `image-url` string — The URL of the badge image to be displayed.
      - `provider` string — The badge issuer.
      - `state` string — The state of the badge. Can only be `pending` or `accepted`.
      - `issued-at` string, date-time — When the badge was issued.
      - `expires-at` string, date-time — When the badge expires.
      - `created-at` string, date-time — When the badge was created.
      - `source` string — Who created the badge.
      - `external-id` string — The external identifier provided by badge issuer.

## Response `201`

Success

- InlineResponse2014
  - `data` InlineResponse2014Data
    - `type` string, nullable
    - `id` string, nullable
    - `attributes` InlineResponse2014DataAttributes
      - `user-identifier-type` string — Can be any of `UserId`, `Email`, `EmployeeId`, `AliasUid`, or `AliasEmail`.
      - `user-id` string — The unique ID of the user the badge was issued to.
      - `title` string — The title of the badge.
      - `url` string — The URL of the user badge.
      - `image-url` string — The URL of the badge image to be displayed.
      - `provider` string
      - `state` string — The state of the badge. Can only be `pending` or `accepted`.
      - `issued-at` string, date-time — When the badge was issued.
      - `expires-at` string, date-time
      - `source` string — The organization that created the badge.
      - `external-id` string — The external identifier provided by badge issuer.
      - `links` SelfLink
        - `self` string
      - `relationships` UserRelationshipsInner[]
        - `user` UserRelationshipsInnerUser
          - `data` UserRelationshipData
            - `id` string, nullable
            - `type` string, nullable

---

[API](https://skmtc.net/degreed/apis/degreed-api-web.md) · [All operations](https://skmtc.net/degreed/apis/degreed-api-web/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/degreed/degreed-api-web/revisions/4a22b709515c/schema)