Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.requestly.com/llms.txt

Use this file to discover all available pages before exploring further.

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

ParameterTypeDescriptionRequired
idStringThe unique identifier of the group to update.Yes

​
Body Parameters

ParameterTypeDescriptionRequiredDefault Value
nameStringThe new name of the group.Yes
statusStringThe updated status of the group.NoActive
isFavouriteBooleanPins the group (true or false).Nofalse

​
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 CodeDescription
200Group updated successfully.
400The provided group ID is invalid.
401Unauthorized action.
404The specified group does not exist.
500An error occurred on the server.