Skip to main content

Update General Settings

Updates the general settings of the platform.

HTTP Request

PATCH/api/settings/general

Authorization

Authorization

  • Required: Yes
  • Permission: Staff or Admin
  • Authentication: Token authentication

Request Body

FieldTypeRequiredDescription
aStringNoDescription for setting a
bStringNoDescription for setting b
cIntegerNoDescription for setting c
dBooleanNoDescription for setting d
eStringNoDescription for setting e

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())

Status Codes

CodeDescription
200Request logs updated successfully
400Bad request — invalid query parameters
401Unauthorized — authentication required
403Forbidden — insufficient permissions
500Internal server error

Response Fields

FieldTypeDescription
astringDescription for setting a
bstringDescription for setting b
cintegerDescription for setting c
dbooleanDescription for setting d
estringDescription for setting e