Grant Permission on a Team

POST

/api/v2/teams/{team_id}/permissions

Adds a user to a team by giving them a role on it: admin to let them manage the team and its
members, or member to make them a regular member. The user then shows in the team's user list
and among their teams in the organization's user list, and gets the access the team has on
the projects, agents, corpora and workflows shared with it.

Granting adds the role to any role the user already holds on the team; to change a role, use
PUT /api/v2/teams/{team_id}/permissions. Only users can be given a role on a team.

Requires manage on the team: being one of its admins, or an organization admin.

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201

application/json

The role was given.

Headers

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/teams//permissions' \
--header 'X-Authorization-Consistency-Token;' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "subject_type": "user",
    "subject_id": "456",
    "relation": "admin"
}'

Response Example

201 - User added as a member

{
    "success": true,
    "message": "Permission granted successfully",
    "data": {
        "team_id": 9,
        "subject_type": "user",
        "subject_id": "21",
        "subject_name": "Sam Ortiz",
        "relation": "member",
        "granted_at": "2026-10-28T14:05:12.481203+00:00",
        "granted_by": {
            "user_id": "7",
            "email": "[email protected]",
            "name": "Alex Kim"
        }
    }
}

List all Permissions on a Team

Update a Permission on a Team