User properties
Set user property
Sets the value of a user's property. Use this resource to store custom data against a user.
Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
- Administer Jira global permission, to set a property on any user.
- Access to Jira, to set a property on the calling user's record.
put/rest/api/3/user/properties/{propertyKey}
Path parameters
propertyKeystring required
The key of the user's property. The maximum length is 255 characters.
Query parameters
accountIdstring
Example:5b10ac8d82e05b22cc7d4ef5
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
userKeystring
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
usernamestring
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Request body
{"stackTrail":"paths:/rest/api/3/user/properties/{propertyKey}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}
Response
Returned if the user property is updated.
{"stackTrail":"paths:/rest/api/3/user/properties/{propertyKey}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}