Update group or user homepage preferences

Makes a homepage the preferred homepage for the specified groups or specific users. Provide either group_id or user_id query parameters — they are mutually exclusive, and supplying both returns a 400 error.

When group_id is used, the groups must be assigned to the homepage. If no groups are specified, the homepage will become the preferred homepage for all groups assigned to the homepage.

When user_id is used, the homepage is pinned directly to each specified user regardless of group assignment. Valid users have their preference set; any invalid or non-existent user IDs are reported in the failures list. If none of the supplied users could be updated, a 400 error is returned.

If the homepage is disabled, the request returns a 200 response with a warning and no preferences are set. See Group-Based Homepages for help assigning groups to homepages, enabling homepages, and working with multiple homepages.

Path Params
integer
required

The ID of the homepage to update. To find a homepage's ID, log into Alation and go to Admin Settings > Customize Homepage and edit the desired homepage. The homepage's ID can be found at the end of the URL path.

Query Params
group_id
array of integers

The IDs of the groups whose preferred homepage you want to update. Mutually exclusive with user_id.

group_id
user_id
array of integers

The IDs of the specific users whose preferred homepage you want to update. May be supplied multiple times. Mutually exclusive with group_id.

user_id
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json