Jira Align - How to Add and Remove Team Member via API

Platform Notice: Cloud and Data Center - This article applies equally to both cloud and data center platforms.

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Summary

In Jira Align, It is possible to add or remove a Team Member from a specific team via the /api/2/Users/ID end-point

Environment

Jira Align - Rest API

Solution

Add a Team Member: (/rest/align/api/2/Users/ID)

PATCH /baseUrl/align/api/2/Users/661886

[ {

"op"

:

"add"

,

"path"

:

"/teams/0"

,

"value"

:{

"teamId"

: 6276,

"teamName"

:

"CM Dev Team"

,

"teamType"

: 1,

"roleId"

: 1,

"roleName"

:

"ScrumMaster"

} ]

Remove a Team member: (/rest/align/api/2/Users/ID)

PATCH /baseUrl/align/api/2/Users/661886

[ {

"op"

:

"remove"

,

"path"

:

"/teams/0"

,

"value"

:{

"teamId"

: 6276 } } ]

Related Links

Jira Align API roleId Value Details for Team Roles

Updated on April 14, 2025

Still need help?

The Atlassian Community is here for you.