Create Staff Member | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v2/staff/member/update/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "status": "success",
  "message": "Staff member update processed successfully.",
  "data": {
    "id": 12345,
    "school_staff_id": "SS-2024-789",
    "firstname": "David",
    "lastname": "Goldberg",
    "full_name": "David Goldberg",
    "firstname_hebrew": "דוד",
    "lastname_hebrew": "גולדברג",
    "display_name": "Mr. Goldberg",
    "title": "Mr.",
    "suffix": "Jr.",
    "home_phone": "+1-555-123-4567",
    "cell_phone": "+1-555-987-6543",
    "marital_status": {
      "id": 2,
      "title": "Married"
    },
    "parent_student": {},
    "maiden_name": "Levin",
    "extension": "123",
    "email": "david.goldberg@example.edu",
    "dob": "1980-04-15",
    "dob_hebrew": "5740-01-23",
    "gender": "male",
    "social_security_number": "123-45-6789",
    "date_of_hire": "2010-08-01",
    "date_of_termination": "2024-06-30",
    "addresses": [
      {}
    ],
    "positions": [
      {
        "id": 101,
        "academic_year": {
          "id": 2024,
          "title": "2023-2024 Academic Year"
        },
        "staff_position": {
          "id": 5,
          "name": "Mathematics Teacher",
          "created_by": "admin_user"
        },
        "staff_member_id": 12345,
        "is_main_teacher": true,
        "staff_position_status": {
          "id": 1,
          "title": "Active"
        },
        "start_date": "2023-09-01",
        "end_date": "2024-06-15",
        "created_by": "hr_manager",
        "grades": [
          {
            "id": 9,
            "name": "Grade 9"
          }
        ],
        "classes": [
          {
            "id": 301,
            "name": "Algebra II"
          }
        ],
        "departments": [
          {
            "id": 12,
            "name": "Mathematics Department"
          }
        ],
        "department_nodes": [
          {
            "id": 45,
            "department_id": 12,
            "department_name": "Mathematics Department",
            "parent_node_id": 10
          }
        ]
      }
    ],
    "created_by": "hr_manager"
  }
}

Creates member update data from submitted details.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

firstnamestring or nullOptional

firstname display value.

lastnamestring or nullOptional

lastname display value.

firstname_hebrewstring or nullOptional

firstname hebrew display value.

lastname_hebrewstring or nullOptional

lastname hebrew display value.

phonestring or nullOptional

phone phone number.

emailstring or nullOptional

Must be a valid email address. Must not be greater than 255 characters.

dobstring or nullOptional

Must be a valid date. Must be a valid date in the format Y-m-d.

dob_hebrewstring or nullOptional

dob hebrew date value.

genderenum or nullOptional

gender value.

Allowed values:

academ_year_iddouble or nullOptional

academ year ID identifier.

school_staff_idstring or nullOptional

school staff ID identifier.

display_namestring or nullOptional

display name display value.

titlestring or nullOptional

title display value.

suffixstring or nullOptional

suffix value.

home_phonestring or nullOptional

home phone phone number.

cell_phonestring or nullOptional

cell phone phone number.

marital_statusstring or nullOptional

marital status status value.

maiden_namestring or nullOptional

maiden name display value.

extensionstring or nullOptional

extension value.

social_security_numberstring or nullOptional

social security number value.

date_of_hirestring or nullOptional

date of hire date value.

date_of_terminationstring or nullOptional

date of termination date value.

marital_status_iddouble or nullOptional

marital status ID status value.

parent_student_iddouble or nullOptional

parent student ID identifier.

classobject or nullOptional

class object.

gradeobject or nullOptional

grade object.

positionobject or nullOptional

position object.

addresslist of objectsOptional

address list.

Response

Success

statusenum

Allowed values:

messagestring

dataobject