From 11f42e3f1e1a19e9c86dd8924263c79b82ca425a Mon Sep 17 00:00:00 2001 From: "simon.sarrafi" Date: Fri, 15 Nov 2024 16:15:44 +0100 Subject: [PATCH] [TF-2142] API add/remove tester from group --- docs/testfairy/api-reference/rest-api.md | 99 +++++++++++++++++++++++- 1 file changed, 98 insertions(+), 1 deletion(-) diff --git a/docs/testfairy/api-reference/rest-api.md b/docs/testfairy/api-reference/rest-api.md index b9f670903b..1f38a51f91 100644 --- a/docs/testfairy/api-reference/rest-api.md +++ b/docs/testfairy/api-reference/rest-api.md @@ -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 "john@example.com:00001234cafecafe" "https://mobile.saucelabs.com/api/1/projects/" ``` ### EU-Central-1 (Access keys are different in each Data Center) + ```bash curl -u "john@example.com:coffee00001234" "https://mobile.eu-central-1.saucelabs.com/api/1/projects/" ``` @@ -273,7 +275,6 @@ Invite one or more tester groups to this specific build. You can optionally send - --- ### List All Recorded Sessions in Build @@ -560,6 +561,102 @@ Delete a single tester, remove them from any tester-groups they might be in, and +--- + +### Add a Tester to a Group + +
+POST/api/1/testers/groups/{group-id} +

+ +Add a single or multiple testers to a specific group. + +#### Parameters + + + + + + + + +
email

| REQUIRED | STRING |

One or more email addresses, separated by commas, to be added to a group.

+ +#### Responses + + + + + + + + +
200Success.
+ +```json title="Sample Response" +{ + "status": "ok", + "testers": [ + { + "email": "tester1@saucelabs.com" + }, + { + "email": "tester2@saucelabs.com" + } + ] +} +``` + +
+ +--- + +### Remove a Tester from a Group + +
+DELETE/api/1/testers/groups/{group-id} +

+ +Remove a single or multiple testers from a specific group. + +#### Parameters + + + + + + + + +
email

| REQUIRED | STRING |

One or more email addresses, separated by commas, to be removed from a group.

+ +#### Responses + + + + + + + + +
200Success.
+ +```json title="Sample Response" +{ + "status": "ok", + "testers": [ + { + "email": "tester1@saucelabs.com" + }, + { + "email": "tester2@saucelabs.com" + } + ] +} +``` + +
+ ## Feedbacks ### Get Latest Recorded Feedbacks