users

Update an existing user.

PUT

/user/{userId}

curl --request PUT \
  --url https://api-sandbox.timeking.nl/api/external/v1/user/{userId} \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activated_at": "2023-11-07T05:31:56Z",
  "activation_code": "<string>",
  "add_hours_mail": 123,
  "address": "<string>",
  "avatar_url": "<string>",
  "banned_at": "2023-11-07T05:31:56Z",
  "banned_reason": "<string>",
  "clock_type": "<string>",
  "contactperson": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_ip_address": "<string>",
  "custom_message": 123,
  "custom_message_history": "<string>",
  "date_of_birth": "2023-12-25",
  "default_administration_id": 123,
  "default_client_id": 123,
  "default_extrawork_id": 123,
  "default_operation_category_id": 123,
  "default_operation_id": 123,
  "default_order_id": 123,
  "default_task_type_slug": "<string>",
  "default_travel_time": 123,
  "default_user_group_id": 123,
  "default_vehicle2_id": 123,
  "default_vehicle3_id": 123,
  "default_vehicle_id": 123,
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": 123,
  "description": "<string>",
  "dont_save_images_to_gallery": 123,
  "email": "<string>",
  "employee_number": "<string>",
  "extra_data": {},
  "first_name": "<string>",
  "groups": [
    {
      "code": "<string>",
      "color": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "pivot": {
        "user_group_id": 123,
        "user_id": 123
      },
      "sort_order": 123
    }
  ],
  "house_number": "<string>",
  "id": 123,
  "initials": "<string>",
  "is_guest": 123,
  "is_mail_blocked": 123,
  "is_support_active": 123,
  "keep_screen_active": 123,
  "language_preference": "<string>",
  "last_ip_address": "<string>",
  "last_name": "<string>",
  "last_seen": "2023-11-07T05:31:56Z",
  "location_administration": 123,
  "location_automatic": 123,
  "location_coordinates": "<string>",
  "location_lastseen": "2023-11-07T05:31:56Z",
  "location_whoiswhere": 123,
  "mails": {},
  "new_tasks_mail": 123,
  "note_entries": [
    {
      "date": "<string>",
      "description": "<string>",
      "title": "<string>"
    }
  ],
  "notes": "<string>",
  "notification_frequency": "<string>",
  "open_pdf_external": 123,
  "open_url_external": 123,
  "phone": "<string>",
  "postal_code": "<string>",
  "primary_group_id": 123,
  "push_token": "<string>",
  "residence": "<string>",
  "settings_location": 123,
  "settings_notification": 123,
  "social_security_number": "<string>",
  "sort_order": 123,
  "superadmin_description": "<string>",
  "supplier_id": 123,
  "task_color": "<string>",
  "task_newtask": 123,
  "task_showclients": 123,
  "task_showoperations": 123,
  "task_workedhours": 123,
  "tasktypes_blocked": [
    "<any>"
  ],
  "times_enable_minimal_pause_minutes": 123,
  "times_enable_minimal_work_hours": 123,
  "times_minimal_pause_minutes": "<string>",
  "times_minimal_work_hours": "<string>",
  "two_factor_confirmed_at": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "username": "<string>",
  "version": "<string>"
}
'

{
  "data": {
    "result": "<string>",
    "user": {
      "activated_at": "2023-11-07T05:31:56Z",
      "activation_code": "<string>",
      "add_hours_mail": 123,
      "address": "<string>",
      "avatar_url": "<string>",
      "banned_at": "2023-11-07T05:31:56Z",
      "banned_reason": "<string>",
      "clock_type": "<string>",
      "contactperson": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_ip_address": "<string>",
      "custom_message": 123,
      "custom_message_history": "<string>",
      "date_of_birth": "2023-12-25",
      "default_administration_id": 123,
      "default_client_id": 123,
      "default_extrawork_id": 123,
      "default_operation_category_id": 123,
      "default_operation_id": 123,
      "default_order_id": 123,
      "default_task_type_slug": "<string>",
      "default_travel_time": 123,
      "default_user_group_id": 123,
      "default_vehicle2_id": 123,
      "default_vehicle3_id": 123,
      "default_vehicle_id": 123,
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": 123,
      "description": "<string>",
      "dont_save_images_to_gallery": 123,
      "email": "<string>",
      "employee_number": "<string>",
      "extra_data": {},
      "first_name": "<string>",
      "groups": [
        {
          "code": "<string>",
          "color": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>",
          "pivot": {
            "user_group_id": 123,
            "user_id": 123
          },
          "sort_order": 123
        }
      ],
      "house_number": "<string>",
      "id": 123,
      "initials": "<string>",
      "is_guest": 123,
      "is_mail_blocked": 123,
      "is_support_active": 123,
      "keep_screen_active": 123,
      "language_preference": "<string>",
      "last_ip_address": "<string>",
      "last_name": "<string>",
      "last_seen": "2023-11-07T05:31:56Z",
      "location_administration": 123,
      "location_automatic": 123,
      "location_coordinates": "<string>",
      "location_lastseen": "2023-11-07T05:31:56Z",
      "location_whoiswhere": 123,
      "mails": {},
      "new_tasks_mail": 123,
      "note_entries": [
        {
          "date": "<string>",
          "description": "<string>",
          "title": "<string>"
        }
      ],
      "notes": "<string>",
      "notification_frequency": "<string>",
      "open_pdf_external": 123,

Autorisaties

X-API-Keystringheaderverplicht

Padparameters

userIdstringverplicht

The id of the user to perform the action on.

Body

User object.

activated_atstring

The date and time the account of this user was activated.

activation_codestring

The account activation code of this user, a legacy field that is no longer used.

add_hours_mailinteger

Whether this hiring user is emailed when hours need to be filled in. Returned as 1 (yes) or 0 (no).

addressstring

The street address of this user.

avatar_urlstring

The URL of the avatar of this user; always null in this API because the avatar is not loaded.

banned_atstring

The date and time this user was banned, or null when this user is not banned.

banned_reasonstring

The reason this user was banned.

clock_typestring

The clock style the app uses for this user, either 'tasktype' (per task type), 'ios' or 'android'.

contactpersonstring

The contact person of this hiring user.

created_atstring

The date and time this user was created.

created_ip_addressstring

The IP address this user was created from.

custom_messageinteger

Whether this user receives personal notifications in the app. Returned as 1 (yes) or 0 (no).

custom_message_historystring

The history of the personal messages of this user.

date_of_birthstring

The date of birth of this user.

default_administration_idinteger

The ID of the default administration of this user.

default_client_idinteger

The ID of the default client (klant) of this user.

default_extrawork_idinteger

The ID of the default extra work operation of this user.

default_operation_category_idinteger

The ID of the default operation category of this user.

default_operation_idinteger

The ID of the default operation (werkzaamheid) of this user.

default_order_idinteger

The ID of the default order (project) of this user.

default_task_type_slugstring

The slug of the default task type of this user.

default_travel_timeinteger

The default travel time of this user in minutes.

default_user_group_idinteger

The ID of the default user group of this user.

default_vehicle2_idinteger

The ID of the default second vehicle (vehicle2) of this user.

default_vehicle3_idinteger

The ID of the default third vehicle (vehicle3) of this user.

default_vehicle_idinteger

The ID of the default vehicle of this user.

deleted_atstring

The date and time this user was deleted, or null when this user is not deleted.

deleted_byinteger

The ID of the backend user who deleted this user.

descriptionstring

The internal note about this user.

dont_save_images_to_galleryinteger

Whether photos taken in the app are kept out of the gallery of the device of this user. Returned as 1 (yes) or 0 (no).

emailstring

The email address of this user.

employee_numberstring

The employee number of this user.

extra_dataobject

The custom field values of this user, keyed by custom field code.

first_namestring

The first name of this user.

groupsobject[]

The user groups this user belongs to.

child attributes tonen

house_numberstring

The house number of this user.

idintegerverplicht

The ID of this user (medewerker).

initialsstring

The initials of this user.

is_guestinteger

Whether this user is a guest account. Returned as 1 (yes) or 0 (no).

is_mail_blockedinteger

Whether email to this user is blocked, a legacy flag that is no longer read. Returned as 1 (yes) or 0 (no).

is_support_activeinteger

Whether support access to the account of this user is enabled. Returned as 1 (yes) or 0 (no).

keep_screen_activeinteger

Whether the app keeps the screen active for this user. Returned as 1 (yes) or 0 (no).

language_preferencestring

The app language of this user, either 'nl', 'en', 'de', 'fr', 'fy', 'sv', 'ro', 'pl', 'uk' or 'bg'.

last_ip_addressstring

The IP address this user last signed in from.

last_namestring

The last name of this user.

last_seenstring

The date and time this user was last active.

location_administrationinteger

Whether the location of this user is recorded for the administration. Returned as 1 (yes) or 0 (no).

location_automaticinteger

Whether the app records the location of this user automatically. Returned as 1 (yes) or 0 (no).

location_coordinatesstring

The last known location coordinates of this user, as reported by the app.

location_lastseenstring

The date and time the location of this user was last reported.

location_whoiswhereinteger

Whether the location of this user is shared in "Who is where". Returned as 1 (yes) or 0 (no).

mailsobject

The custom email templates of this hiring user, keyed by 'new_account', 'new_tasks_available' or 'add_hours'.

new_tasks_mailinteger

Whether this hiring user is emailed when new work is available. Returned as 1 (yes) or 0 (no).

note_entriesobject[]

The notes about this user.

child attributes tonen

notesstring

The legacy notes of this user, replaced by note_entries.

notification_frequencystring

The notification frequency of this user.

open_pdf_externalinteger

Whether the app opens PDF files in an external viewer for this user. Returned as 1 (yes) or 0 (no).

open_url_externalinteger

Whether the app opens URLs in an external browser for this user. Returned as 1 (yes) or 0 (no).

phonestring

The phone number of this user.

postal_codestring

The postal code of this user.

primary_group_idinteger

The ID of the primary user group of this user.

push_tokenstring

The push notification token of the mobile app of this user.

residencestring

The city of residence of this user.

settings_locationinteger

Whether location is enabled in the app settings of this user. Returned as 1 (yes) or 0 (no).

settings_notificationinteger

Whether this user receives push notifications in the app. Returned as 1 (yes) or 0 (no).

The social security number (BSN) of this user; this is sensitive personal data and is returned unmasked.

sort_orderinteger

The sort order of this user.

superadmin_descriptionstring

The note about this user that only super admins can see.

supplier_idinteger

The ID of the supplier whose purchase invoices are matched against the tasks of this hiring user.

task_colorstring

The default color of the tasks of this user.

task_newtaskinteger

Whether this user can create new tasks in the app. Returned as 1 (yes) or 0 (no).

task_showclientsinteger

Whether clients (klanten) are shown to this user in the app. Returned as 1 (yes) or 0 (no).

task_showoperationsinteger

Whether operations (werkzaamheden) are shown to this user in the app. Returned as 1 (yes) or 0 (no).

task_workedhoursinteger

Whether worked hours are enabled for this user in the app. Returned as 1 (yes) or 0 (no).

tasktypes_blockedany[]

The task types that are blocked for this user in the app.

times_enable_minimal_pause_minutesinteger

Whether this user must declare at least the break minutes of the contract. Returned as 1 (yes) or 0 (no).

times_enable_minimal_work_hoursinteger

Whether this user must declare at least the work hours of the contract. Returned as 1 (yes) or 0 (no).

times_minimal_pause_minutesstring

The minimum number of break minutes, as a numeric string, this user must declare when the contract minimum is not used.

times_minimal_work_hoursstring

The minimum number of hours, as a numeric string, this user must declare when the contract minimum is not used.

two_factor_confirmed_atstring

The date and time two-factor authentication was confirmed for this user, or null when it is not enabled.

typestring

The account type of this user, either 'regular' (app user), 'for_hire' (hiring), 'no_app' (non app user) or 'free'.

updated_atstring

The date and time this user was last updated.

usernamestring

The username of this user, which defaults to the email address.

versionstring

A counter, as a numeric string, that increases every time this user is saved so the app can detect changes; it restarts at 1 after 1000.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team