Grant multiple permissions on a team

POST

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

Grants multiple permissions to a team in a single operation.
This endpoint is useful when you need to add multiple users to a team at once, such as when setting up a new team or onboarding a group.

Path Parameters:

team_id (int): The ID of the team

Request Body:

grants (array, required): List of permissions to grant, each containing:

subject_type (str): "user"

subject_id (str): ID of the user

relation (str): Role to grant ("admin" or "member")

Operation Behavior:

The operation is partially atomic: each grant is attempted independently

If some grants fail, successful ones are still applied

Check the response results array to see which operations succeeded and which failed

Authorization:

Requires manage permission on the team

All users must belong to the same organization as the team

Returns:

A response containing the batch operation results

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Batch operation completed

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/teams//permissions/batch' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "grants": [
        {
            "subject_type": "user",
            "subject_id": "456",
            "relation": "admin"
        },
        {
            "subject_type": "user",
            "subject_id": "789",
            "relation": "member"
        },
        {
            "subject_type": "user",
            "subject_id": "321",
            "relation": "member"
        }
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "team_id": 0,
        "granted": [
            {
                "subject_type": "string",
                "subject_id": "string",
                "subject_name": "string",
                "relation": "string"
            }
        ],
        "failed": [
            {
                "subject_type": "string",
                "subject_id": "string",
                "subject_name": "string",
                "error": "string"
            }
        ],
        "granted_at": "2019-08-24T14:15:22.123Z"
    }
}

Revoke permission on a team

Revoke multiple permissions on a team