---
title: "Create user property by key"
method: POST
path: "/wiki/rest/api/user/{userId}/property/{key}"
tags: ["User properties"]
---

# Create user property by key

`POST /wiki/rest/api/user/{userId}/property/{key}`

Creates a property for a user. For more information  about user properties, see [Confluence entity properties]
(https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
`Note`, these properties stored against a user are on a Confluence site level and not space/content level.

`Note:` the number of properties which could be created per app in a tenant for each user might be
restricted by fixed system limits.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission).

## Path parameters

- `userId` string, required
- `key` string, required

## Request body

- UserPropertyCreate
  - `value` object, required — The value of the user property.

## Response `201`

Returned if the user property is created.

## Other responses

- `400` — Returned if; - The key is too long. - The value is empty. - The value is too long. - Request has malformed syntax or userId is not a valid user id.
- `401` — Returned if the authentication credentials are incorrect or missing from the request.
- `403` — Returned if the user does not have the correct permissions.
- `404` — Returned if there is no user with the given user id.
- `409` — Returned if the key already exists for the user.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api/revisions/70088490f406/schema)