This endpoint enables you to update details such as the name, status, and favorite status of an existing group using its unique ID.
For a live view and to test this API interactively, visit the API Playground.
Endpoint
-
Method: PUT
-
URL:
https://api2.requestly.io/v1/groups/{id}
Path Parameters
Parameter | Type | Description | Required |
---|---|---|---|
| String | The unique identifier of the group to update. | Yes |
Body Parameters
Parameter | Type | Description | Required | Default Value |
---|---|---|---|---|
| String | The new name of the group. | Yes | |
| String | The updated status of the group. | No |
|
| Boolean | Pins the group (true or false). | No |
|
cURL Request
curl --request PUT \
--url https://api2.requestly.io/v1/groups/Group_qrszh \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: your_api_key' \
--data '{
"name": "Data",
"status": "Active",
"isFavourite": true
}'
Sample Response
{
"success": true,
"data": {
"id": "Group_qrszh",
"creationDate": 1736059835086,
"modificationDate": 1736059838864,
"createdBy": "IUAGkRiEx6XI0B6qCc82qbwroKX2",
"lastModifiedBy": "IUAGkRiEx6XI0B6qCc82qbwroKX2",
"name": "Data",
"objectType": "group",
"status": "Active",
"isFavourite": true
}
}
Response Codes
Status Code | Description |
---|---|
200 | Group updated successfully. |
400 | The provided group ID is invalid. |
401 | Unauthorized action. |
404 | The specified group does not exist. |
500 | An error occurred on the server. |