Skip to main content

Update General Settings

Updates the general settings of the project

HTTP Request

PATCH/api/settings/general

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with GeneralSettingsPermission or Admin
  • Permission Code: 1002
  • Authentication: Token authentication

Request Body

FieldTypeRequiredDescription
aStringNoDescription for setting a
bStringNoDescription for setting b
cStringNoDescription for setting c

Example Requests

1# Update general settings
2response = requests.patch('http://www.example.com/api/settings/general', 
3  json={
4      'a': 'new_value_a',
5      'b': 'updated_b'
6  },
7  headers={'Authorization': 'Token <your_api_key>'}
8)
9print(response.json())

Response Fields

FieldTypeDescription
astringDescription for setting a
bstringDescription for setting b
cstringDescription for setting c

Example Response

{
"a": "x2",
"b": "y2",
"c": "z2"
}

Notes

  • This endpoint currently has no practical use