POST user

Tien Bui
Tien Bui
Sixth Anniversary Kudos 1 Facilitator 1
in Education Management APIs

{
first_name: 'student_a',
last_name: 'student_a',
middle_name: 'middle_student_a',
email: 'student@example.com',
nick_name: 'student_nick'
}




Has anyone tried creating a student user account using the SKY API?

The above fields look to be the only ones that are supported in the documentation.


This seems to be quite limiting when we're trying to call the API to create a Student (ie. missing: birth_date, gender, custom fields, username)

Likewise for parents (ie. missing: phone_number, address)


I might be blind, can someone confirm that there's no API to update those fields I mentioned?

Comments

  • Brian Gray
    Brian Gray Community All-Star
    Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
    The POST Single User endpoint (https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersPost) has a few more fields than you listed, but not DOB. PATCH Single User allows you to update the same fields.


    I don't see an endpoint that will add DOB. There must be a way to do it, though. We use a third-party service for Admission, and they can push incoming students and parents to Core.
  • Tien Bui
    Tien Bui
    Sixth Anniversary Kudos 1 Facilitator 1
    Brian,

    Does that third-party service use the SKY API? The previous version (SDK) has a lot more function and they might still be using that.

    You are correct that there are some other attributes that the POST on the user supports. However, we are primarily looking for username and birthdate.


    I just find it weird that I can mark the account "deceased" and "lost" but not give them a birthdate or set a username. ?
  • Brian Gray
    Brian Gray Community All-Star
    Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
    I asked the service provider for details about how they're creating records for us. I will post an update when I get it.
  • Jeremiah Ellington
    Jeremiah Ellington
    Fourth Anniversary Facilitator 1

    I do this with the User Create Endpoint.

    7371a7ce5e365edbb46c2f97dbbd2e22-huge-im

Categories