Skip to content

Update Team Members Request Payload

The request payload for updating a team's membership. admin_ids is the complete set of teammates who should be on the team once the request completes, not a list of changes to apply. Any teammate currently on the team but absent from admin_ids is removed.

Membership is the only part of a team this endpoint writes, and the request is read from the body: a parameter sent in the query string is rejected rather than applied. The other fields of the representation are accepted as long as they are unchanged, so a team that has members can be read and sent back whole. Trying to change one of them returns a 400 rather than being ignored, as does any field a team does not have. admin_ids cannot be empty, so the endpoint will not empty a team, and a team with no members cannot be sent back as it reads.

On a team that balances assignment across its members, admin_priority_level sets which teammates take work first. It is optional, and names only the teammates whose level the request is setting: a teammate it leaves out keeps the level they already have, and one joining the team without a level named becomes a primary member. A level named for a teammate the request removes is ignored, so a team read from the API can still be sent back whole with only admin_ids changed. An id belonging to neither the team nor admin_ids is a mistake and returns a 400, as does naming the same id at both levels. Only a team that balances assignment can have secondary members, so naming one on any other team returns a 400.

admin_idsArray of integers, [ 1 .. 1000 ] itemsrequired

The ids of every teammate who should be a member of the team. Must contain at least one id, and no more than 1000.

Example:
[ 493881, 493882 ]
admin_priority_levelobject or null(Admin Priority Level)

Admin priority levels for the team

{ "admin_ids": [ 493881, 493882 ], "admin_priority_level": { "primary_admin_ids": [ … ], "secondary_admin_ids": [ … ] } }