Archives or unarchives the user with the specified id. | awork API

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

{
  "firstName": "Carla",
  "lastName": "Creative",
  "birthDate": "1998-04-19T00:00:00Z",
  "gender": "female",
  "title": "Miss",
  "position": "Graphic Designer",
  "language": "en-GB",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": {
    "invitationAccepted": true,
    "isDeactivated": true
  },
  "createdOn": "2023-11-10T08:45:00Z",
  "createdBy": "987e6543-e21b-45d3-b456-426614174999",
  "updatedOn": "2024-04-20T14:22:00Z",
  "updatedBy": "987e6543-e21b-45d3-b456-426614174999",
  "isArchived": true,
  "isDeactivated": true,
  "deactivatedOn": "2024-04-15T10:00:00Z",
  "deletedOn": "2024-05-01T12:00:00Z",
  "hasImage": true,
  "shouldMigrateToConnect": true,
  "userContactInfos": [
    {
      "type": "address",
      "subType": "work",
      "addressLine1": "Torstrasse 140",
      "addressLine2": "Hof A",
      "zipCode": "10119",
      "city": "Berlin",
      "country": "DE",
      "isAddress": true,
      "id": "456e7890-e12b-34d3-c456-426614174111",
      "createdOn": "2023-11-10T08:45:00Z",
      "createdBy": "987e6543-e21b-45d3-b456-426614174999",
      "updatedOn": "2024-04-20T14:22:00Z",
      "updatedBy": "987e6543-e21b-45d3-b456-426614174999"
    }
  ],
  "resourceVersion": 637825154598057900,
  "tags": [
    {
      "id": "789e1234-e56b-78d3-f456-426614174222",
      "name": "Design",
      "color": "purple"
    }
  ],
  "teams": [
    {
      "id": "321e6547-e89b-12d3-a456-426614174333",
      "name": "Designers",
      "icon": "paintbrush",
      "color": "purple"
    }
  ],
  "isExternal": true,
  "accountId": "654e3210-e98b-76d3-a456-426614174444"
}

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 null0-1000 characters

The firstname of the user.

lastNamestring or null0-1000 characters

The lastname of the user.

birthDatedatetime or null

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.

createdOndatetime

The date this user was created.

createdBystringformat: "uuid"

The id of the user who created this user.

updatedOndatetime

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.

deactivatedOndatetime or null

The date the user was deactivated.

deletedOndatetime or null

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).

accountIdstring or nullformat: "uuid"

The account id of the user. Only used internally.

Errors

400

Bad Request Error

404

Not Found Error