Add members

Add users to an organization user group. This endpoint allows you to add one or more organization users to an existing user group.

POST https://api.tedee.com/api/v37/organization/{organizationId}/user-groups/{groupId}/members

URI Parameters

Name	Type	Description
groupId	UUID	id of user group
organizationId	number	id of organization

Body Parameters

Name	Type	Description
organizationUserIds	numbers []	List of organization user IDs to add

Responses

Name	Type	Description
207 Multi-Status	Organization member operation result []	successful operation

Scopes

Name	Description
Organization.ReadWrite	Grants user possibility to read and write organization data

Examples

Add single member

Sample request

curl -X POST "https://api.tedee.com/api/v37/organization/1/user-groups/a4d5e6f7-8b9c-4d2e-9f1a-3b4c5d6e7f8a/members" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "organizationUserIds": [14]
}

Sample response

HTTP status code: 207

{
    "organizationUsers": [
        {
            "organizationUserId": 14,
            "success": true,
            "error": null
        }
    ]
}

Add multiple members

Sample request

curl -X POST "https://api.tedee.com/api/v37/organization/1/user-groups/a4d5e6f7-8b9c-4d2e-9f1a-3b4c5d6e7f8a/members" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "organizationUserIds": [14, 15, 16]
}

Sample response

HTTP status code: 207

{
    "organizationUsers": [
        {
            "organizationUserId": 14,
            "success": true,
            "error": null
        },
        {
            "organizationUserId": 15,
            "success": true,
            "error": null
        }
    ]
}

Note

Users must be members of the organization before they can be added to a group. If a user is already a member of the group, they will be skipped.