Archives or unarchives the user with the specified id.

POST

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.

Path parameters

userIdstringRequired

Id of the user which will be changed.

Request

This endpoint expects an object.

isArchivedbooleanRequired

Flags the entity as archived.

Response

firstNamestringOptional>=0 characters<=1000 characters

The firstname of the user.

lastNamestringOptional>=0 characters<=1000 characters

The lastname of the user.

birthDatedatetimeOptional

The birthdate of the user.

genderstringOptional>=0 characters<=25 characters

The gender of the user.

titlestringOptional>=0 characters<=100 characters

The title of the user.

positionstringOptional>=0 characters<=1000 characters

The position of the user.

languagestringOptional>=0 characters<=25 characters

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

idstringOptional

The id of the user.

statusobjectOptional

The status of the user.

createdOndatetimeOptional

The date this user was created.

createdBystringOptional

The id of the user who created this user.

updatedOndatetimeOptional

The date when this user was last updated.

updatedBystringOptional

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.

deactivatedOndatetimeOptional

The date the user was deactivated.

hasImagebooleanOptional

Whether the user has uploaded a profile image.

shouldMigrateToConnectbooleanOptional

Whether the user should be migrated to Connect.

userContactInfoslist of objectsOptional

The contact information assigned to this user.

resourceVersionlongOptional

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

tagslist of objectsOptional

The tags of this user.

teamslist of objectsOptional

The teams the user is associated to.

isExternalbooleanOptional

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

accountIdstringOptional

The account id of the user. Only used internally.

POST

1 curl -X POST https://api.awork.com/api/v1/users/userId/setarchived \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "isArchived": true
6 }'

200Successful

1 {
2   "firstName": "Carla",
3   "lastName": "Creative",
4   "birthDate": "2024-01-15T09:30:00Z",
5   "gender": "female",
6   "title": "Miss",
7   "position": "position",
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   "deactivatedOn": "2024-01-15T09:30:00Z",
21   "hasImage": true,
22   "shouldMigrateToConnect": true,
23   "userContactInfos": [
24     {
25       "label": "label",
26       "value": "value",
27       "type": "address",
28       "subType": "work",
29       "addressLine1": "Torstrasse 140",
30       "addressLine2": "Hof A",
31       "zipCode": "10119",
32       "city": "Berlin",
33       "state": "state",
34       "country": "DE",
35       "isAddress": true,
36       "id": "123e4567-e89b-12d3-a456-426614174000",
37       "isDeleted": false,
38       "createdOn": "2024-01-15T09:30:00Z",
39       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
40       "updatedOn": "2024-01-15T09:30:00Z",
41       "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
42     }
43   ],
44   "resourceVersion": 637825154598057900,
45   "tags": [
46     {
47       "id": "123e4567-e89b-12d3-a456-426614174000",
48       "name": "Design",
49       "color": "purple"
50     }
51   ],
52   "teams": [
53     {
54       "id": "123e4567-e89b-12d3-a456-426614174000",
55       "name": "Designers",
56       "icon": "paintbrush",
57       "color": "purple"
58     }
59   ],
60   "isExternal": true,
61   "accountId": "123e4567-e89b-12d3-a456-426614174000"
62 }

Returns the capacity of the specified user.

Up Next

Built with

1	curl -X POST https://api.awork.com/api/v1/users/userId/setarchived \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"isArchived": true
6	}'

1	{
2	"firstName": "Carla",
3	"lastName": "Creative",
4	"birthDate": "2024-01-15T09:30:00Z",
5	"gender": "female",
6	"title": "Miss",
7	"position": "position",
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	"deactivatedOn": "2024-01-15T09:30:00Z",
21	"hasImage": true,
22	"shouldMigrateToConnect": true,
23	"userContactInfos": [
24	{
25	"label": "label",
26	"value": "value",
27	"type": "address",
28	"subType": "work",
29	"addressLine1": "Torstrasse 140",
30	"addressLine2": "Hof A",
31	"zipCode": "10119",
32	"city": "Berlin",
33	"state": "state",
34	"country": "DE",
35	"isAddress": true,
36	"id": "123e4567-e89b-12d3-a456-426614174000",
37	"isDeleted": false,
38	"createdOn": "2024-01-15T09:30:00Z",
39	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
40	"updatedOn": "2024-01-15T09:30:00Z",
41	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
42	}
43	],
44	"resourceVersion": 637825154598057900,
45	"tags": [
46	{
47	"id": "123e4567-e89b-12d3-a456-426614174000",
48	"name": "Design",
49	"color": "purple"
50	}
51	],
52	"teams": [
53	{
54	"id": "123e4567-e89b-12d3-a456-426614174000",
55	"name": "Designers",
56	"icon": "paintbrush",
57	"color": "purple"
58	}
59	],
60	"isExternal": true,
61	"accountId": "123e4567-e89b-12d3-a456-426614174000"
62	}