Skip to content
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

[TF-2142] API add/remove tester from group #3012

Merged
merged 1 commit into from
Nov 19, 2024
Merged

[TF-2142] API add/remove tester from group #3012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
99 changes: 98 additions & 1 deletion docs/testfairy/api-reference/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ Getting started with the REST API can be done via the command line with any prog
Supported Public Cloud endpoints:

### US-East-1

```bash
curl -u "[email protected]:00001234cafecafe" "https://mobile.saucelabs.com/api/1/projects/"
```

### EU-Central-1 (Access keys are different in each Data Center)

```bash
curl -u "[email protected]:coffee00001234" "https://mobile.eu-central-1.saucelabs.com/api/1/projects/"
```
Expand Down Expand Up @@ -273,7 +275,6 @@ Invite one or more tester groups to this specific build. You can optionally send

</details>


---

### List All Recorded Sessions in Build
Expand Down Expand Up @@ -560,6 +561,102 @@ Delete a single tester, remove them from any tester-groups they might be in, and

</details>

---

### Add a Tester to a Group

<details>
<summary><span className="api post">POST</span><code>/api/1/testers/groups/&#123;group-id&#125;</code></summary>
<p></p>

Add a single or multiple testers to a specific group.

#### Parameters

<table id="table-api">
<tbody>
<tr>
<td><code>email</code></td>
<td><p><small>| REQUIRED | STRING |</small></p><p>One or more email addresses, separated by commas, to be added to a group.</p></td>
</tr>
</tbody>
</table>

#### Responses

<table id="table-api">
<tbody>
<tr>
<td><code>200</code></td>
<td colSpan='2'>Success.</td>
</tr>
</tbody>
</table>

```json title="Sample Response"
{
"status": "ok",
"testers": [
{
"email": "[email protected]"
},
{
"email": "[email protected]"
}
]
}
```

</details>

---

### Remove a Tester from a Group

<details>
<summary><span className="api delete">DELETE</span><code>/api/1/testers/groups/&#123;group-id&#125;</code></summary>
<p></p>

Remove a single or multiple testers from a specific group.

#### Parameters

<table id="table-api">
<tbody>
<tr>
<td><code>email</code></td>
<td><p><small>| REQUIRED | STRING |</small></p><p>One or more email addresses, separated by commas, to be removed from a group.</p></td>
</tr>
</tbody>
</table>

#### Responses

<table id="table-api">
<tbody>
<tr>
<td><code>200</code></td>
<td colSpan='2'>Success.</td>
</tr>
</tbody>
</table>

```json title="Sample Response"
{
"status": "ok",
"testers": [
{
"email": "[email protected]"
},
{
"email": "[email protected]"
}
]
}
```

</details>

## Feedbacks

### Get Latest Recorded Feedbacks
Expand Down