Users

Add a User

Adds a new user to Timetastic, optionally triggering a welcome email.

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 edit 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/add

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/add
  • Auth: none declared

Request body

firstNamestring required

The user's first name

lastNamestring required

The user's last name

emailAddressstring email nullable

The new user's Email address

leaveYearStartinteger nullable

The month that the user's leave year starts (1: Jan, 2: Feb…12: Dec). Omitting this will create a user with the same leave year that occurs most often in your Organisation

allowancenumber double required

The user's annual allowance in days

startDatestring date-time nullable

The user's start date. In ISO 8601 format: 2022-02-04T00:00:00

departmentIdinteger required

The ID of the department that this user is in

sendWelcomeEmailboolean

Whether to send the user an email to set a password and start using Timetastic

Response

The user was created. Returns the ID of the new user, e.g. { "id": 1234 }.

Changes

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