For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
      • GETReturns the currently logged-in user and workspace.
      • GETReturns all users with their details.
      • GETTries to retrieve user name and gender for the specified email.
      • GETReturns the currently logged-in user and workspace.
      • GETReturns the user with the specified id.
      • PUTUpdates the user with the specified id.
      • DELDeletes the user with the specified id.
      • POSTActivates the user with the specified id.
      • GETReturns the contact infos of the user with the specified id.
      • POSTCreates a new contact info for the user with the specified id.
      • GETReturns the contact info of the user with the specified id.
      • PUTUpdates the contact info of the user with the specified id.
      • DELDeletes the contact info of the user with the specified id.
      • POSTDeactivates the user with the specified id.
      • POSTArchives or unarchives the user with the specified id.
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceUsers

Updates the user with the specified id.

PUT
https://api.awork.com/api/v1/users/:userId
PUT
/api/v1/users/:userId
$curl -X PUT https://api.awork.com/api/v1/users/userId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "firstName": "Carla",
3  "lastName": "Creative",
4  "birthDate": "1998-04-19T00:00:00Z",
5  "gender": "female",
6  "title": "Miss",
7  "position": "Senior Graphic Designer",
8  "language": "en-GB",
9  "id": "123e4567-e89b-12d3-a456-426614174000",
10  "status": {
11    "invitationAccepted": true,
12    "isDeactivated": false
13  },
14  "createdOn": "2023-11-10T08:45:00Z",
15  "createdBy": "987e6543-e21b-45d3-b456-426614174999",
16  "updatedOn": "2024-04-20T14:22:00Z",
17  "updatedBy": "987e6543-e21b-45d3-b456-426614174999",
18  "isArchived": false,
19  "isDeactivated": false,
20  "isAgent": false,
21  "deactivatedOn": "2024-01-15T09:30:00Z",
22  "deletedOn": "2024-02-01T10:00:00Z",
23  "hasImage": true,
24  "shouldMigrateToConnect": true,
25  "userContactInfos": [
26    {
27      "label": null,
28      "value": null,
29      "type": "address",
30      "subType": "work",
31      "addressLine1": "Torstrasse 140",
32      "addressLine2": "Hof A",
33      "zipCode": "10119",
34      "city": "Berlin",
35      "state": null,
36      "country": "DE",
37      "isAddress": true,
38      "id": "123e4567-e89b-12d3-a456-426614174000",
39      "createdOn": "2023-11-10T08:45:00Z",
40      "createdBy": "987e6543-e21b-45d3-b456-426614174999",
41      "updatedOn": "2024-04-20T14:22:00Z",
42      "updatedBy": "987e6543-e21b-45d3-b456-426614174999"
43    }
44  ],
45  "resourceVersion": 637825154598057900,
46  "tags": [
47    {
48      "id": "a12b3456-c78d-90ef-1234-56789abcdef0",
49      "name": "Design",
50      "color": "purple"
51    }
52  ],
53  "teams": [
54    {
55      "id": "b23c4567-d89e-01fa-2345-67890bcdef12",
56      "name": "Designers",
57      "icon": "paintbrush",
58      "color": "purple"
59    }
60  ],
61  "isExternal": true
62}
<Check title="Required Permissions" icon="key">The user must be an admin or the creator or have `user-master-data:write` permissions.</Check>
Was this page helpful?
Previous

Deletes the user with the specified id.

Next
Built with
Required Permissions
The user must be an admin or the creator or have user-master-data:write permissions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user.

Request

The model to update the user.
firstNamestring or nullOptional0-1000 characters
The firstname of the user.
lastNamestring or nullOptional0-1000 characters
The lastname of the user.
birthDatestring or nullOptionalformat: "date-time"
The birthdate of the user.
genderstring or nullOptional0-25 characters
The gender of the user.
titlestring or nullOptional0-100 characters
The title of the user.
positionstring or nullOptional0-1000 characters
The position of the user.
languagestring or nullOptional0-25 characters

The language preference of the user in ISO 639-1 format.

Response

OK
firstNamestring or null0-1000 characters
The firstname of the user.
lastNamestring or null0-1000 characters
The lastname of the user.
birthDatestring or nullformat: "date-time"
The birthdate of the user.
genderstring or null0-25 characters
The gender of the user.
titlestring or null0-100 characters
The title of the user.
positionstring or null0-1000 characters
The position of the user.
languagestring or null0-25 characters

The language preference of the user in ISO 639-1 format.

idstringformat: "uuid"
The id of the user.
statusobject
The status of the user.
createdOnstringformat: "date-time"
The date this user was created.
createdBystringformat: "uuid"
The id of the user who created this user.
updatedOnstringformat: "date-time"
The date when this user was last updated.
updatedBystringformat: "uuid"
The id of the user who updated the entity.
isArchivedboolean
Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.
isDeactivatedboolean
Whether the user has been deactivated.
isAgentboolean
Whether this user represents an agent.
deactivatedOnstring or nullformat: "date-time"
The date the user was deactivated.
deletedOnstring or nullformat: "date-time"

The date the user was deleted (soft delete).

hasImageboolean
Whether the user has uploaded a profile image.
shouldMigrateToConnectboolean
Whether the user should be migrated to Connect.
userContactInfoslist of objects or null
The contact information assigned to this user.
resourceVersionlongRead-only
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
tagslist of objects or null
The tags of this user.
teamslist of objects or null
The teams the user is associated to.
isExternalboolean

True if this entity is coming from an external workspace (awork Connect).

Errors

404
Not Found Error