Create general settings

curl --request POST \
  --url https://api.example.com/api/v1/school/general-settings/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "created": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "school_name": "ABC Secondary School",
    "address": "123 Main Street, Dar es Salaam",
    "phone": "+255123456789",
    "email": "info@abcschool.ac.tz",
    "logo": null,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}

School - Settings

Create general settings

Create initial general school settings configuration. This endpoint can only be used once - if settings already exist, it will return an error. Singleton Pattern:

Only one general settings instance is allowed per school
If settings already exist, use the update endpoint instead
Returns a 400 error with “Settings already exist” message if attempting to create duplicates Required Fields:
school_name: Official name of the school
address: Physical address of the school
phone: Contact phone number
email: Official school email address Optional Fields:
logo: School logo image file (uploaded separately) Use Case:
Initial school setup during system configuration
First-time settings initialization

POST

api

school

general-settings

Create general settings

curl --request POST \
  --url https://api.example.com/api/v1/school/general-settings/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "created": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "school_name": "ABC Secondary School",
    "address": "123 Main Street, Dar es Salaam",
    "phone": "+255123456789",
    "email": "info@abcschool.ac.tz",
    "logo": null,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

{key}

any

Response

{key}

any

List general settings Get general settings

⌘I

Overview

Endpoints

Create general settings

Authorizations

Body

Response