Skip to content

Test Failure Groups

Update Test Failure Group Annotation

PUT https://api.appelium.com/v1/testFailureGroups/:testFailureGroupId

Updates the annotation for a test failure group. Annotations are limited to 1,000 characters.

Parameters

NAME PLACEMENT TYPE DESCRIPTION
X-Appelium-Token
Required		 Header string API token generated in Dashboard
testFailureGroupId
Required		 Path int ID of the test failure group to update
annotation Body string Annotation for the test failure group. Maximum 1,000 characters. Pass null or omit to clear the annotation.

Sample request payload:

{
    "annotation": "Tracked in QA-1234. The failing test is being investigated."
}

200: OK

The updated test failure group is returned in the response body.

401: Unauthorized

{
    "id": "388677B7-B016-4A6C-A8AE-887B3814114C",
    "httpStatus": 401,
    "title": "Unauthorized",
    "detail": "Invalid or missing X-Appelium-Token header"
}

404: Not Found

Returned when the test failure group does not exist.