Skip to content

Updates the properties of a group.

PATCH
/api/groups/{groupId}

Authorizations

api_key
Type: API Key (header: X-CSRF-Token)

Parameters

Path Parameters

groupId*
Typestring
Required

Request Body

JSON
{
"name": "Testgruppe",
"description": "This is a working group.",
"applyType": 0,
"requiredBananas": 0,
"requiredPickups": 0,
"requiredWeeks": 0,
"photo": "test.jpg"
}

Responses

Success
Authorization
api_key
Variables
Key
Value
groupId*
cURL
curl -X PATCH \
'http://localhost/api/groups/{groupId}' \
 --data '{
  "name": "Testgruppe",
  "description": "This is a working group.",
  "applyType": 0,
  "requiredBananas": 0,
  "requiredPickups": 0,
  "requiredWeeks": 0,
  "photo": "test.jpg"
}'

Samples

cURL
curl -X PATCH http://localhost/api/groups/{groupId}
JavaScript
fetch("http://localhost/api/groups/{groupId}", { method: "PATCH" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://localhost/api/groups/{groupId}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.patch("http://localhost/api/groups/{groupId}")
print(response.json())