Users

Edit a User

Edits an existing user in Timetastic. Allows you to populate more data into a user record after an initial ADD operation. You can pass any combination of the following parameters and only those values will be changed.

This endpoint is limited to 2 requests per second.

Attempts that supply an email address already in use are counted against your organisation. The count is shared with the add endpoint, and after 10 of them both start returning 429. The count expires 24 hours after the first failure, not the last, and succeeding in the meantime does not clear it. Check for an existing user before retrying rather than letting these accumulate.

post/api/users/edit/{id}

Request

Base URL: https://app.timetastic.co.uk (the document declares no server; this is the origin it was published from)
URL: https://app.timetastic.co.uk/api/users/edit/{id}
Auth: none declared

Path parameters

idinteger required

Request body

idinteger

The unique Id for this user

emailAddressstring nullable

The user's email address. To clear a user's email address you must pass a blank string to this parameter: ""

firstnamestring nullable

The user's first name

lastnamestring nullable

The user's last name

startDatestring date-time nullable

The user's start date

birthdaystring date-time nullable

The user's date of birth

departmentIdinteger nullable

The ID of the department that this user is in

adminboolean nullable

Whether the user is a Timetastic Admin (User must have an email address to set this)

directorboolean nullable

approverIdinteger nullable

The user's Approver - set this to 0 to default the user's approver to their department boss

publicHolidaySetIdinteger nullable

The user's public holiday SetId. HasPublicHolidays will need to be enabled for this to update the user. See Public Holidays for details on "sets"

jobTitlestring nullable

payrollIdstring nullable

address1string nullable

address2string nullable

citystring nullable

postCodestring nullable

telephone1string nullable

telephone2string nullable

countrystring nullable

emergencyContactNamestring nullable

emergencyContactPhonestring nullable

hasPublicHolidaysboolean nullable

Whether the user has public holidays enabled. If you're setting public holidays for a new user or user that's not had public holidays enabled before you'll also need to pass a valid PublicHolidaySetId in the same request

Response

The user was updated.

Changes

No recorded changes to this operation across all 1 revision of this API.