Update schedule assignees

Replaces the assignment rule for a schedule. The selected option replaces the current assignees entirely. Use 'users' to assign specific users, 'groups' to assign all members of a group, 'site_members' to assign all members of the target site(s), or 'site_members_in_group' to assign site members who are also in a group. The site_members and site_members_in_group options require the schedule to have targets (sites or assets) set.

Change who is assigned work for the schedule. The option selected replaces the current assignees entirely. Exactly one of users, groups, site_members, or site_members_in_group must be set.

The site_members and site_members_in_group options require the schedule to have targets (sites or assets) set.

Assignment options

OptionDescription
usersAssign specific users by ID. Accepts 1-1000 user IDs.
groupsAssign members of the specified group. Accepts 1 group ID.
site_membersAssign site members for the schedule targets. This option requires the schedule to have site or asset targets.
site_members_in_groupAssign site members for the schedule targets who are also in the specified group. Requires site or asset targets. Accepts exactly 1 group ID.

Requirements

Path Params
string
required

ID of the schedule to update.

Body Params

Assign specific users by ID. Replaces the current user assignees with the provided list.

users
object
required

UpdateUserAssignees modifies the list of specifically assigned users.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json