Set User Attribute Group Value

Version 4.0.24.20 (latest)

Set the value of a user attribute for a group.

For information about how user attribute values are calculated, see Set User Attribute Group Values.

Request

PATCH /groups/{group_id}/attribute_values/{user_attribute_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
group_id
string
Id of group
user_attribute_id
string
Id of user attribute
body
HTTP Body
Expand HTTP Body definition...
body
New value for group.
Expand UserAttributeGroupValue definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id of this group-attribute relation
group_id
string
Id of group
user_attribute_id
string
Id of user attribute
value_is_hidden
boolean
If true, the "value" field will be null, because the attribute settings block access to this value
rank
integer
Precedence for resolving value for user
value
string
Value of user attribute for group

Response

200: Group value object.

Datatype
Description
can
object
Operations the current user is able to perform on this object
id
string
Unique Id of this group-attribute relation
group_id
string
Id of group
user_attribute_id
string
Id of user attribute
value_is_hidden
boolean
If true, the "value" field will be null, because the attribute settings block access to this value
rank
integer
Precedence for resolving value for user
value
string
Value of user attribute for group

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