Create a custom column

POST

https://ssuccessv2.com/app/api/v2/column/custom/field/create

Creates a SchoolSet custom column and optionally attaches it to a module and scope in the active school.

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

modulestringOptional

Module system name to attach the new field to

scope_idintegerOptional

Optional module scope identifier

This endpoint expects an object.

namestringRequired<=255 characters

type_dataenumRequired

optionslist of objects or nullOptional

Custom column created and returned as a resource

statusstring

messagestring

dataobject

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/column/custom/field/create \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Emergency contact preference",
>	"type_data": "select",
>	"options": [
>	{
>	"name": "Phone",
>	"value": "phone"
>	}
>	]
>	}'

1	{
2	"status": "success",
3	"message": "Saved successfully.",
4	"data": {
5	"id": 31,
6	"name": "Emergency contact preference",
7	"type": {},
8	"options": [
9	{}
10	],
11	"modules": [
12	{}
13	],
14	"created_by": "School Admin"
15	}
16	}