Archives or unarchives the user with the specified id.

POST

https://api.awork.com/api/v1/users/:userId/setarchived

POST

/api/v1/users/:userId/setarchived

$ curl -X POST https://api.awork.com/api/v1/users/userId/setarchived \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "firstName": "Carla",
3   "lastName": "Creative",
4   "birthDate": "1998-04-19T00:00:000Z",
5   "gender": "female",
6   "title": "Miss",
7   "position": "string",
8   "language": "en-GB",
9   "id": "123e4567-e89b-12d3-a456-426614174000",
10   "status": {
11     "invitationAccepted": true,
12     "isDeactivated": true
13   },
14   "createdOn": "2024-01-15T09:30:00Z",
15   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
16   "updatedOn": "2024-01-15T09:30:00Z",
17   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
18   "isArchived": false,
19   "isDeactivated": false,
20   "isAgent": false,
21   "deactivatedOn": "2024-01-15T09:30:00Z",
22   "deletedOn": "2024-01-15T09:30: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": "2024-01-15T09:30:00Z",
40       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
41       "updatedOn": "2024-01-15T09:30:00Z",
42       "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
43     }
44   ],
45   "resourceVersion": 637825154598057900,
46   "tags": [
47     {
48       "id": "123e4567-e89b-12d3-a456-426614174000",
49       "name": "Design",
50       "color": "purple"
51     }
52   ],
53   "teams": [
54     {
55       "id": "123e4567-e89b-12d3-a456-426614174000",
56       "name": "Designers",
57       "icon": "paintbrush",
58       "color": "purple"
59     }
60   ],
61   "isExternal": true,
62   "accountId": "123e4567-e89b-12d3-a456-426614174000"
63 }

Archived objects can not be used any longer but still exist for being referenced by other entities.

Required Permissions

The user must be an admin or have project-manage-config:write permissions.

Archived objects can not be used any longer but still exist for being referenced by other entities. <Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

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 archive or unarchive the user.

isArchivedbooleanOptional

Flags the entity as archived.

Response

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.

idstringOptionalformat: "uuid"

The id of the user.

statusobjectOptional

The status of the user.

createdOnstringOptionalformat: "date-time"

The date this user was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this user.

updatedOnstringOptionalformat: "date-time"

The date when this user was last updated.

updatedBystringOptionalformat: "uuid"

The id of the user who updated the entity.

isArchivedbooleanOptional

Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.

isDeactivatedbooleanOptional

Whether the user has been deactivated.

isAgentbooleanOptional

Whether this user represents an agent.

deactivatedOnstring or nullOptionalformat: "date-time"

The date the user was deactivated.

deletedOnstring or nullOptionalformat: "date-time"

The date the user was deleted (soft delete).

hasImagebooleanOptional

Whether the user has uploaded a profile image.

shouldMigrateToConnectbooleanOptional

Whether the user should be migrated to Connect.

userContactInfoslist of objects or nullOptional

The contact information assigned to this user.

resourceVersionlongOptionalRead-only

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

tagslist of objects or nullOptional

The tags of this user.

teamslist of objects or nullOptional

The teams the user is associated to.

isExternalbooleanOptional

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

accountIdstring or nullOptionalformat: "uuid"

The account id of the user. Only used internally.

Errors

400

Bad Request Error

404

Not Found Error