Update custom field

PATCH

https://app.schoolset.io/app/api/v1/custom/field/update/:id

Updates the selected custom field configuration.

AuthorizationBearer

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

idstringRequired

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 PATCH https://app.schoolset.io/app/api/v1/custom/field/update/id \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Student Enrollment Date",
6	"model": "enrollment",
7	"type": "date",
8	"visibility": "public"
9	}'

1	{
2	"status": "success",
3	"message": "Custom field updated successfully.",
4	"data": {
5	"id": 42,
6	"name": "Student Enrollment Date",
7	"model": "enrollment",
8	"slug": "student-enrollment-date",
9	"type": "date",
10	"visibility": "public",
11	"school_id": 15,
12	"created_by_user_id": 7,
13	"academ_year_id": 2024,
14	"created_at": "2024-01-10T09:15:00Z",
15	"updated_at": "2024-06-05T16:45:00Z"
16	}
17	}