Set User Attribute User Value

Version 4.0.24.6 (latest)

Store a custom value for a user attribute in a user's account settings.

Per-user user attribute values take precedence over group or default values.

Request

PATCH /users/{user_id}/attribute_values/{user_attribute_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
user_id
string
Id of user
user_attribute_id
string
Id of user attribute
body
HTTP Body
Expand HTTP Body definition...
body
New attribute value for user.
Expand UserAttributeWithValue definition...
can
object
Operations the current user is able to perform on this object
name
string
Name of user attribute
label
string
Human-friendly label for user attribute
rank
integer
Precedence for setting value on user (lowest wins)
value
string
Value of attribute for user
user_id
string
Id of User
user_can_edit
boolean
Can the user set this value
value_is_hidden
boolean
If true, the "value" field will be null, because the attribute settings block access to this value
user_attribute_id
string
Id of User Attribute
source
string
How user got this value for this attribute
hidden_value_domain_whitelist
string
If this user attribute is hidden, allowed list of destinations to which it may be sent.

Response

200: User attribute value.

Datatype
Description
can
object
Operations the current user is able to perform on this object
name
string
Name of user attribute
label
string
Human-friendly label for user attribute
rank
integer
Precedence for setting value on user (lowest wins)
value
string
Value of attribute for user
user_id
string
Id of User
user_can_edit
boolean
Can the user set this value
value_is_hidden
boolean
If true, the "value" field will be null, because the attribute settings block access to this value
user_attribute_id
string
Id of User Attribute
source
string
How user got this value for this attribute
hidden_value_domain_whitelist
string
If this user attribute is hidden, allowed list of destinations to which it may be sent.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

403: Permission Denied

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link