Skip to main content
PATCH
/
api
/
v1
/
school
/
general-settings
/
{id}
Update general settings partial
curl --request PATCH \
  --url https://test-api.afrainity.com/api/v1/school/general-settings/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logo": "<string>",
  "address": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "school_name": "<string>"
}
'
{
  "address": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "school_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "logo": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this general settings.

Body

Auto-populate created_by from request.user when available.

​
logo
file | null
​
address
string
Required string length: 1 - 255
​
phone
string
Required string length: 1 - 255
​
email
string<email>
Required string length: 1 - 254
​
school_name
string
Required string length: 1 - 255

Response

200 - application/json

Auto-populate created_by from request.user when available.

​
address
string
required
Maximum string length: 255
​
phone
string
required
Maximum string length: 255
​
email
string<email>
required
Maximum string length: 254
​
school_name
string
required
Maximum string length: 255
​
id
string<uuid>
​
logo
string<uri> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>