---
title: "Update a Student"
method: PATCH
path: "/student/{id}"
tags: ["Student"]
---

# Update a Student

`PATCH /student/{id}`

Update a Student

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `external` ExternalRequest — ExternalRequest is the External-object used on Update and Create operations, since it should only be allowed to set SourceID, the Source-field is not included.
    - `sourceID` string, required — The ID of the external source
  - `gender` 'Female' | 'Male' | 'Other' — The gender of the person
  - `identityNumber` string, required — The identity number of the student in the format YYYYMMDD-NNNN, must be unique within the organization.
  - `identityTemporary` boolean — If the identity number is temporary for the student
  - `firstName` string, required — The first name of the student
  - `lastName` string, required — The last name of the student
  - `dateOfBirth` string, date, nullable — The date of birth of the student
  - `address` Address — Address is a reusable object that can be used to store address information.
    - `postalAddress` string, nullable — The postal address of the address
    - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area.
    - `postalCity` string, nullable — The city of the address
    - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden).
    - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to.
  - `emailAddress1` string, nullable — The primary email address of the student, will be used for communication with the student from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.
  - `emailAddress2` string, nullable — The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
  - `phoneNumber1` string, nullable — The primary phone number of the student, will be used for communication with the student from the system.
  - `phoneNumber2` string, nullable — The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
  - `eduPersonPrincipalName` string, nullable — The eduPersonPrincipalName (EPPN) of the student, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster). Format: `localIdentifier@domain` — e.g. `kalko@edu.goteborg.se`

## Response `200`

Response for Student Update operation - returns the updated Student

- Student — Student holds the personal information about a student, information about the school is stored in the StudentPlacement-resource.
  - `id` string, uuid, required — Unique identifier for the Student
  - `meta` Meta — Meta contains information about the creation and modification of a resource for auditing purposes
    - `createdAt` string, date-time, required — Timestamp when the resource was created
    - `createdBy` string, uuid, nullable — User who created the resource
    - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated
    - `updatedBy` string, uuid, nullable — User who last updated the resource
  - `external` External — External is a reusable object that can be used to store external information from another system, used for third-party integration tracking.
    - `sourceID` string, nullable — The ID of the external source
    - `source` string, nullable — The source of the external information
  - `gender` 'Female' | 'Male' | 'Other' — The gender of the person
  - `identityNumber` string, required — The identity number of the student in the format YYYYMMDD-NNNN, must be unique within the organization.
  - `identityTemporary` boolean — If the identity number is temporary for the student
  - `firstName` string, required — The first name of the student
  - `lastName` string, required — The last name of the student
  - `dateOfBirth` string, date, nullable — The date of birth of the student
  - `address` Address — Address is a reusable object that can be used to store address information.
    - `postalAddress` string, nullable — The postal address of the address
    - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area.
    - `postalCity` string, nullable — The city of the address
    - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden).
    - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to.
  - `emailAddress1` string, nullable — The primary email address of the student, will be used for communication with the student from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.
  - `emailAddress2` string, nullable — The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
  - `phoneNumber1` string, nullable — The primary phone number of the student, will be used for communication with the student from the system.
  - `phoneNumber2` string, nullable — The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
  - `eduPersonPrincipalName` string, nullable — The eduPersonPrincipalName (EPPN) of the student, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster). Format: `localIdentifier@domain` — e.g. `kalko@edu.goteborg.se`

## Other responses

- `400` — Bad Request - The request was malformed or contained invalid parameters
- `401` — Unauthorized - The request is missing valid authentication credentials
- `403` — Forbidden - Request is authenticated, but the user is not allowed to perform the operation
- `404` — Not Found - The requested resource does not exist
- `409` — Conflict - The request could not be completed due to a conflict
- `422` — Validation error for Student Update operation - request data failed validation
- `429` — Too Many Requests - When the rate limit has been exceeded
- `500` — Internal Server Error - An unexpected server error occurred

---

[API](https://skmtc.net/meitner/apis/directory-api.md) · [All operations](https://skmtc.net/meitner/apis/directory-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meitner/directory-api/revisions/014348a7bc35/schema)
