Create custom field

POST

https://app.schoolset.io/app/api/v1/custom/field/create

Creates a new custom field with the provided configuration.

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

This endpoint expects an object.

namestringRequired

name display value.

modelstringRequired

model value.

typestringRequired

type value.

visibilitystringRequired

visibility value.

Success

statusenum

Allowed values:

messagestring

dataobject

1	curl -X POST https://app.schoolset.io/app/api/v1/custom/field/create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Student Grade",
6	"model": "student_records",
7	"type": "integer",
8	"visibility": "public"
9	}'

1	{
2	"status": "success",
3	"message": "Custom field created successfully.",
4	"data": {
5	"id": 42,
6	"name": "Student Grade",
7	"model": "student_records",
8	"slug": "student-grade",
9	"type": "integer",
10	"visibility": "public",
11	"school_id": 15,
12	"created_by_user_id": 7,
13	"academ_year_id": 2024,
14	"created_at": "2024-06-01T10:15:30Z",
15	"updated_at": "2024-06-01T10:15:30Z"
16	}
17	}