ParticipantUpdate

Contents

This object captures a change in a participant’s status. It can be passed in via mutation to allow changing the set of participants on a work item.

This object can be used to assign a role to a user, in which case the role attribute will be set to the desired role. Or, it can be used to remove a user’s participation, in which case role should be null.

This object can be used to assign a role to a user, in which case the username attribute should be formatted like an email address (this formatting matches the username field of the User object). New users can be invited this way. Or, it can be used to assign an open resource, in which case the username field should not be an email address.

Fields

role (String)
The api name of the role being assigned. This field should be null if a user’s participation is being removed.

username (String!)
The username of the user to assign. See above for format considerations for this field.

Updated on September 9, 2025

Related Articles