---
title: "Create a New User Custom Attribute"
method: POST
path: "/api/v2/user-custom-attributes"
tags: ["User Custom Attributes"]
---

# Create a New User Custom Attribute

`POST /api/v2/user-custom-attributes`

This endpoint creates a collection of custom attributes for a user within the organization. You must register a custom attribute using the POST endpoint for custom attributes in order to assign values to users associated with the attribute. For more information, see [User Custom Attributes](https://developer.degreed.com/reference/user-custom-attributes). <h3>Required Scope</h3>`custom_attribute:write`

## Request body

- V2UsercustomattributesBody
  - `data` Apiv2usercustomattributesData
    - `type` string, nullable
    - `attributes` Apiv2usercustomattributesDataAttributes
      - `user-id` string, required — The unique ID of the user.
      - `custom-attributes` InlineResponse2002DataAttributesCustomattributes — Enter the name of the custom attribute in the `newKey` field and specify the corresponding value in the `New Value` field as a string, date, number, or boolean value. For example, `Geography: NAmerica`, `StartDate: 01-02-2018`, `IsTemp: false`, `Code: 6`, etc.

## Response `201`

Success

- UserCustomAttributeDetail
  - `data` UserCustomAttributeDetailData
    - `type` string, nullable
    - `id` string, nullable
    - `attributes` UserCustomAttributeDataAttributes
      - `custom-attributes` UserCustomAttributeDataAttributes1
        - `custom-string-attribute` string, nullable — The name of this property would be any custom attribute name and the value would be a corresponding string.
        - `custom-date-attribute` string, date-time, nullable — The name of this property would be any custom attribute name and the value would be a corresponding date.
        - `custom-integer-attribute` integer, nullable — The name of this property would be any custom attribute name and the value would be a corresponding integer.
        - `custom-boolean-attribute` boolean, nullable — The name of this property would be any custom attribute name and the value would be a corresponding boolean.
    - `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)
