Add user to group

https://your-domain.atlassian.net/rest/api/3/group/user

Adds a user to a group. **Permissions required:** Site administration (that is, member of the *site-admin* group).

Access Token Required: API Key

Query Params

groupnamestring

As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This parameter cannot be used with the `groupId` parameter.

groupIdstring

The ID of the group. This parameter cannot be used with the `groupName` parameter.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request POST \
     --url 'https://your-domain.atlassian.net/rest/api/3/group/user' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

POST