Skip to content

[LA-29914] Update documentation for teams_users#update endpoint #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlarcombe merged 2 commits into from
Oct 8, 2025
Merged

[LA-29914] Update documentation for teams_users#update endpoint #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8faac04
Updated API docs
rlarcombe Oct 6, 2025
76d7d0d
PR feedback
rlarcombe Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion source/includes/_team_users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,6 @@ end

user_details = {
userId: 1,
isPrimary: true
}

result = Learnamp::TeamUsers.new(token).add(1, user_details)
Expand All @@ -198,8 +197,25 @@ Add a user to a team.
### Required Scope
This endpoint requires the `team_users:create` scope.

### Data in Body

Parameter | Example value | Description
--------- | ------- | -----------
userId | 1 | User ID of user to add to team
response | Teams::Simple | Optional: (blank value is the default) or "Teams::Simple" or "Teams::Extended". Value of "Teams::Simple" will include basic team information in the response. Value of "Teams::Extended: will include full team information in the response, including full list of users, sub-teams and tags in the JSON response. Only use the "Teams::Extended" response if all this data is required.

> 201 Created - successful response:

```json
{
"id": 1,
"teamId": 3,
"userId": 1
}
```

> 201 Created - successful response, using response = Teams::Extended param

```json
{
"id": 1,
Expand Down Expand Up @@ -369,11 +385,22 @@ teamId | 1200 | ID of the team
teamName | "Marketing" | Name of the team
userId | 1 | User ID of user to add to team
userEmail | "user@email.com" | Email of the new team member
response | Teams::Simple | Optional: (blank value is the default) or "Teams::Simple" or "Teams::Extended". Value of "Teams::Simple" will include basic team information in the response. Value of "Teams::Extended: will include full team information in the response, including full list of users, sub-teams and tags in the JSON response. Only use the "Teams::Extended" response if all this data is required.

Parameters `teamId` and `teamName` are mutually exclusive - only one of them can be present in the request payload. Same rule applies for `userId` and `userEmail`.

> 201 Created - successful response:

```json
{
"id": 1,
"teamId": 3,
"userId": 1
}
```

> 201 Created - successful response, using response = Teams::Extended param

```json
{
"id": 1,
Expand Down