Update App Settings

PATCH

/settings

Requires authenticated session. Requires manage:settings permission.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠401unauthorized

🟠403forbidden

🔴500server-error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/settings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schoolName": "string",
    "appShortName": "string",
    "activeAcademicYear": "string",
    "address": "string",
    "email": "user@example.com",
    "phone": "string",
    "latitude": -90,
    "longitude": -180
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "CR-100001",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "schoolName": "string",
        "appShortName": "string",
        "logo": "string",
        "loginBackground": "string",
        "enrollmentBanner": "string",
        "enrollmentThankYouImage": "string",
        "activeAcademicYear": "string",
        "attendanceTimezone": "string",
        "address": "string",
        "email": "string",
        "phone": "string",
        "latitude": 0,
        "longitude": 0
    }
}

Modified at 2026-07-25 07:30:01

Retrieve App Settings

Get All Attendance Settings