🟢POST groups/users

Add a user to an organisation group.

URL

POST https://training.tapintosafety.com.au/api/v2/groups/{Group Id}/users

Parameters

Schema

URL Parameters

Name	Description
Group Id*	The Id of the group to add the given user to. Formatted as a GUID. A list of groups can be found using GET groups.

* required

Body Parameters

Name	Type	Description
userId*	string	The Id of the user to add to the group. Formatted as a GUID.

* required

Example

curl https://training.tapintosafety.com.au/api/v2/groups/00000000-0000-0000-0000-000000000000/users \
    -d '{"userId":"00000000-0000-0000-0000-000000000000"}'    \
    -H "Authorization: Bearer $APIKey"                        \
    -H "Content-Type: application/json" 

Responses

A 204 response will be received even if the specified user is already part of the given group.

204 - OK

No response body.

400 - Bad Request

Error Code: INVALID_MODEL

userId has not been specified.

400 - Bad Request

Error Code: NO_GROUPS_AVAILABLE

Your organisation has not created any groups to add users to.

400 - Bad Request

Error Code: GROUP_NOT_FOUND

A group could not be found with the specified Group Id.

400 - Bad Request

Error Code: USER_NOT_FOUND

A user could not be found with the specified userId.