Create Column Custom Field | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v2/column/custom/field/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Student Email",
  "type_data": "email"
}'

{
  "status": "success",
  "message": "Custom field created successfully.",
  "data": {
    "id": 1024,
    "name": "Student Email",
    "type": {},
    "options": [
      {
        "id": 10,
        "name": "Primary Email",
        "value": "primary@example.com",
        "created_by": "admin_user"
      }
    ],
    "modules": [
      {
        "id": 5,
        "name": "Student Management",
        "sysname": "student_mgmt",
        "slug": "student-management",
        "parent_id": 2
      }
    ],
    "created_by": "admin_user"
  }
}

Creates field create data from submitted details.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

Must not be greater than 255 characters.

type_dataenumRequired

type data type value.

modulestring or nullOptional

module value.

scope_idinteger or nullOptional

scope ID identifier.

optionslist of objectsOptional

options list.

Response

Success

statusenum

Allowed values:

messagestring

dataobject