> ## Documentation Index
> Fetch the complete documentation index at: https://developers.wrike.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Modify User
Update users by ID (accessible to Admins only).
Scopes: amReadWriteUser
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Wrike API",
"version": "4.0"
},
"servers": [
{
"url": "https://www.wrike.com/api/v4"
},
{
"url": "https://app-eu.wrike.com/api/v4"
},
{
"url": "https://app-us2.wrike.com/api/v4"
}
],
"paths": {
"/users/{userId}": {
"put": {
"tags": [
"Users"
],
"summary": "Modify User",
"description": "Update users by ID (accessible to Admins only).\n\nScopes: amReadWriteUser",
"operationId": "PUT:/users/single",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/UserId"
}
},
{
"name": "profile",
"in": "query",
"description": "[Deprecated] It is recommended to use 'userTypeId' parameter instead. Profile to be updated. Mutually exclusive with other params",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfileParam"
}
}
}
},
{
"name": "userTypeId",
"in": "query",
"description": "Change user type of user in account. Mutually exclusive with other params",
"required": false,
"schema": {
"type": "string",
"description": "Change user type of user in account. Mutually exclusive with other params"
}
},
{
"name": "active",
"in": "query",
"description": "Activate or deactivate user. Mutually exclusive with other params",
"required": false,
"schema": {
"type": "boolean",
"description": "Activate or deactivate user. Mutually exclusive with other params"
}
}
],
"responses": {
"2XX": {
"description": "success response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"kind": {
"$ref": "#/components/schemas/ResponseKind"
}
}
}
}
}
},
"4XX": {
"description": "client-side error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"5XX": {
"description": "server-side error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"HTTP": []
}
]
}
}
},
"components": {
"schemas": {
"ResponseKind": {
"type": "string",
"enum": [
"accounts",
"users",
"contacts",
"assets",
"eDiscoveryReport",
"folders",
"folderTree",
"tasks",
"taskIds",
"timelogs",
"timelogCategories",
"timelogLockPeriods",
"timetrackerTimers",
"comments",
"attachments",
"url",
"version",
"dataExport",
"dataExportSchema",
"auditLog",
"accessRoles",
"stream",
"changes",
"posts",
"mailSettings",
"integrationInfo",
"gmailIntegrationSettings",
"workTypesForIntegrations",
"ids",
"backups",
"domains",
"dependencies",
"workflows",
"workschedules",
"workscheduleExclusions",
"workscheduleUserExclusions",
"customfields",
"customfieldIds",
"customstatuses",
"invitations",
"notifications",
"jobroles",
"placeholders",
"groups",
"session",
"dashboards",
"widgets",
"taskCreationSettings",
"colors",
"experiments",
"topics",
"topicComments",
"webhooks",
"reviews",
"boards",
"textSearch",
"chatChannels",
"chatMessages",
"forms",
"requestForms",
"request",
"report",
"platformWidgets",
"platformWidgetInstances",
"spaces",
"pdf",
"customerSatisfaction",
"asyncJob",
"approvals",
"highlights",
"highlightsList",
"highlightsSettings",
"highlightsCard",
"timesheet",
"timesheetRow",
"timesheetSubmissionRule",
"mobileFeatures",
"mobileSettings",
"folderBlueprintTree",
"taskBlueprintTree",
"feedback",
"timeline_snapshot",
"contactIds",
"bookings",
"integrateThreshold",
"hourlyRatesProvision",
"hourlyRates",
"projectTeamMembers",
"contactsHistory",
"tasksHistory",
"foldersHistory",
"activityDigest",
"workItemTemplates",
"workTemplates",
"workItemMetadata",
"workItem",
"customItemTypes",
"verificationCode",
"views",
"listView",
"tableView",
"userTypes",
"reactions",
"externalRequesters",
"workscheduleCapacityOverrides",
"userCapacityOverrides",
"userCapacityExclusions",
"rollups",
"requestFormPrefill",
"cascadingFieldSettings"
]
},
"Metadata": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value should be less than 1000 symbols, compatible with JSON string. Use JSON 'null' in order to remove metadata entry"
},
"key": {
"type": "string",
"description": "Key should be less than 50 symbols and match following regular expression ([A-Za-z0-9_-]+)"
}
},
"description": "Metadata entries are isolated on per-client (application) basis"
},
"ErrorType": {
"type": "string",
"enum": [
"invalid_request",
"invalid_parameter",
"parameter_required",
"not_authorized",
"access_forbidden",
"not_allowed",
"resource_not_found",
"method_not_found",
"too_many_requests",
"rate_limit_exceeded",
"server_error"
]
},
"UserProfileParam": {
"required": [
"accountId",
"role"
],
"type": "object",
"properties": {
"accountId": {
"$ref": "#/components/schemas/AccountId"
},
"external": {
"type": "boolean",
"description": "Make user external"
},
"role": {
"$ref": "#/components/schemas/UserRole"
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"errorDescription": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/ErrorType"
}
}
},
"AccountId": {
"pattern": "^([A-Z0-9]){8}$",
"type": "string"
},
"UserRole": {
"type": "string",
"description": "* `User`\n* `Collaborator`",
"enum": [
"User",
"Collaborator"
]
},
"User": {
"type": "object",
"properties": {
"userTypeId": {
"type": "string",
"description": "User Type Id"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"metadata": {
"type": "array",
"description": "List of contact metadata entries. Requesting user has read/write access to his own metadata, other entries are read-only",
"items": {
"$ref": "#/components/schemas/Metadata"
}
},
"avatarUrl": {
"type": "string",
"description": "Avatar URL"
},
"timezone": {
"type": "string",
"description": "Timezone Id, e.g 'America/New_York'"
},
"companyName": {
"type": "string",
"description": "User Company Name"
},
"profiles": {
"type": "array",
"description": "List of user profiles in accounts accessible for requesting user",
"items": {
"$ref": "#/components/schemas/UserProfile"
}
},
"type": {
"type": "string",
"enum": [
"Group",
"Asset",
"Person",
"Robot"
]
},
"locale": {
"type": "string",
"description": "Locale"
},
"title": {
"type": "string",
"description": "User Title"
},
"firstName": {
"type": "string",
"description": "First name"
},
"deleted": {
"type": "boolean",
"description": "True if user is deleted, false otherwise"
},
"phone": {
"type": "string",
"description": "User phone"
},
"me": {
"type": "boolean",
"description": "Field is present and set to true only for requesting user"
},
"myTeam": {
"type": "boolean",
"description": "Field is present and set to true for My Team (default) group"
},
"location": {
"type": "string",
"description": "User location"
},
"id": {
"$ref": "#/components/schemas/UserId"
},
"memberIds": {
"type": "array",
"description": "List of group members contact IDs (field is present only for groups)",
"items": {
"$ref": "#/components/schemas/UserId"
}
},
"primaryEmail": {
"type": "string",
"description": "Primary Email"
}
}
},
"UserProfile": {
"required": [
"accountId",
"email",
"role",
"external",
"admin",
"owner",
"active"
],
"type": "object",
"properties": {
"owner": {
"type": "boolean",
"description": "Is user account owner"
},
"accountId": {
"$ref": "#/components/schemas/AccountId"
},
"external": {
"type": "boolean",
"description": "Is user external"
},
"role": {
"$ref": "#/components/schemas/UserRole"
},
"admin": {
"type": "boolean",
"description": "Is user account admin"
},
"active": {
"type": "boolean",
"description": "Is user active in account"
},
"email": {
"type": "string",
"description": "Email address associated with account"
}
}
},
"UserId": {
"pattern": "^([A-Z0-9]){8}$",
"type": "string"
}
},
"securitySchemes": {
"HTTP": {
"type": "http",
"description": "Use OAuth 2.0 access token or permanent access token for authorization.",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```