Users

Archive a User

Use this to archive a user from Timetastic. They will be immediately logged out and unable to log in.

This endpoint is limited to 2 requests per second. An archiveDate must be supplied in the body.

post/api/users/archive/{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/archive/{id}
  • Auth: none declared

Path parameters

idinteger required

The ID of the user to archive

Request body

archiveDatestring date-time

The Date this user left your organisation.Must be in the past (UTC). Timetastic will display this on the archived user's profile and in reports

Response

The user was archived.

Changes

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