Skip to content

Edit an existing achievement

PATCH
/api/achievements/{achievementId}

Authorizations

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

Parameters

Path Parameters

achievementId*
Typestring
Required

Request Body

JSON
{
"id": 1,
"regionId": 1,
"name": "Food Hygiene Certificate",
"description": "Awarded for completing a food hygiene course",
"icon": "fas fa-hands-wash",
"validityInDaysAfterAssignment": "356",
"isRequestableByFoodsaver": true,
"createdAt": "string",
"updatedAt": "string"
}

Responses

Success
Authorization
api_key
Variables
Key
Value
achievementId*
cURL
curl -X PATCH \
'http://localhost/api/achievements/{achievementId}' \
 --data '{
  "id": 1,
  "regionId": 1,
  "name": "Food Hygiene Certificate",
  "description": "Awarded for completing a food hygiene course",
  "icon": "fas fa-hands-wash",
  "validityInDaysAfterAssignment": "356",
  "isRequestableByFoodsaver": true,
  "createdAt": "string",
  "updatedAt": "string"
}'

Samples

cURL
curl -X PATCH http://localhost/api/achievements/{achievementId}
JavaScript
fetch("http://localhost/api/achievements/{achievementId}", { method: "PATCH" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://localhost/api/achievements/{achievementId}");
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/achievements/{achievementId}")
print(response.json())