Update User Name

PUT /users/{userId}/name
Api key

Update user name

Path parameters

  • userId string(uuid) Required

    User UUID.

application/json

Body Required

  • firstName string Required

    The first name of the user.

    Minimum length is 1.

  • lastName string Required

    The last name of the user.

    Minimum length is 1.

Responses

  • 200 application/json

    User name updated succssfully.

    Hide response attribute Show response attribute object
    • user object Required
      Hide user attributes Show user attributes object
      • userId string(uuid) Required

        User UUID.

      • roles array[string]

        User roles

        Values are manager, editor, leadership, guardian, teacher, or student.

      • username string Required

        The username of the user.

      • upn string

        The Unique Pupil Number (UPN) of the user.

      • externalId string

        Identifier from an external source

      • fullName string Required

        The full name of the user.

      • firstName string Required

        The first name of the user.

      • middleName string

        The middle name of the user.

      • lastName string Required

        The last name of the user.

      • emails array[string(email)]

        A list of all email addresses associated with the user.

      • gender string Required

        The gender of the user.

        Values are male, female, other, or unknown. Default value is unknown.

      • dateOfBirth string(date)

        The date of birth of the user.

      • createdAt string(date-time)
      • updatedAt string(date-time)
  • 400

    Invalid request.

  • 401

    Invalid authentication credentials

  • 403

    Not authorised to access this resource

  • 404

    User not found.

PUT /users/{userId}/name 
curl \
 --request PUT 'https://connect.century.tech/api/v1/users/68f06c66-702a-4c26-b8c5-b6dc4f81f25d/name' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"firstName":"John","lastName":"Doe"}'
Request examples 
{
  "firstName": "John",
  "lastName": "Doe"
}
Response examples (200) 
{
  "user": {
    "upn": "Y89421121401A",
    "roles": [
      "student"
    ],
    "emails": [
      "john.doe@email.com"
    ],
    "gender": "male",
    "userId": "68f06c66-702a-4c26-b8c5-b6dc4f81f25d",
    "fullName": "John Doe",
    "lastName": "Doe",
    "username": "john_doe",
    "createdAt": "2024-01-01T12:00:00Z",
    "firstName": "John",
    "updatedAt": "2024-01-01T12:00:00Z",
    "externalId": "External_ID_123",
    "dateOfBirth": "2010-07-01"
  }
}