PUT /wiki/rest/api/user/{userId}/property/{key}
Updates a property for the given user. Note, you cannot update the key of a user property, only the value.
For more information about user properties, see
Confluence entity properties.
Note, these properties stored against a user are on a Confluence site level and not space/content level.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 |
key |
String | Yes |
The key of the user property. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
value |
Object | Yes |
The value of the user property. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.