v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB

User properties

Create user property by 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 required: Permission to access the Confluence site ('Can use' global permission).

post/wiki/rest/api/user/{userId}/property/{key}

Path parameters

userIdstring required

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192

keystring required

The key of the user property.

Request body

valueobject required

The value of the user property.

Response

Returned if the user property is created.