---
updatedAt: 2025-09-18T22:04:01.000Z
agentTools:
  projectIndex: https://dev.kevel.com/llms.txt
---

# Update Login

This updates the name or time zone of a user. This will NOT update the password or email address.

> 🚧
>
> Make sure to send `Name` when updating a Login via the API. Leaving this blank will set it to `null`. (In the the SDK, however, this is unnecessary. You can specify only what you want to change.)

> ❗️
>
> The "Password" field in the response is a legacy field that is no longer in use. The value is always returned as an empty string.

> 🚧
>
> In order for `CanAccessStudio` = `true`, `AccessLevel` must = `admn` or `edit`.
>
> When editing a user, if you set `AccessLevel` to `read` and specify `CanAccessStudio` = `true`, then the call will fail.
>
> When editing a user, if you set `AccessLevel` to `read` and do not specify `CanAccessStudio`, then `CanAccessStudio` will be set to `false`, even if it was previous set to `true`.

> 📘 Clearing attribute values
>
> To unset or clear an attribute, set its value to `NULL`.

<br />

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "management-api-2",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.kevel.co"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "X-Adzerk-ApiKey",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/login/{LoginID}": {
      "put": {
        "summary": "Update Login",
        "description": "This updates the name or time zone of a user. This will NOT update the password or email address.",
        "operationId": "update-login",
        "parameters": [
          {
            "name": "loginId",
            "in": "path",
            "description": "ID from the Create Login Endpoint. Can get from List Logins endpoint.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "id",
                  "email",
                  "name"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Login ID of the user"
                  },
                  "email": {
                    "type": "string",
                    "description": "Required by the API, but not updated. You can send as an empty string."
                  },
                  "name": {
                    "type": "string",
                    "description": "Friendly name of the user. If not included, will reset to `null`"
                  },
                  "defaultTimeZone": {
                    "type": "string",
                    "description": "If allowed by the network, the preferred time zone of the user."
                  },
                  "accessLevel": {
                    "type": "string",
                    "description": "The [user permission level](doc:user-permissions-new). Must be one of admn, edit, or read. If AccessLevel is not set, the user will retain the current AccessLevel.",
                    "default": "<current AccessLevel>"
                  },
                  "canAccessStudio": {
                    "type": "boolean",
                    "description": "Must be `true` or `false`. Controls whether or not this user can access [Studio](doc:studio-overview). Defaults to `false`. Setting `CanAccessStudio` to `true` requires that `AccessLevel` be set to `admn` or `edit`.",
                    "default": false
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "id": 12345,
                    "email": "",
                    "name": "George Harrison",
                    "defaultTimeZone": "UTC",
                    "accessLevel": "read",
                    "canAccessStudio": "false"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\":12345,\n    \"email\":\"george.harrison@example.com\",\n    \"password\":\"\",\n    \"name\":\"George Harrison\",\n    \"defaultTimeZone\": \"UTC\",\n    \"accessLevel\":\"read\",\n    \"canAccessStudio\": \"false\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 12345,
                      "default": 0
                    },
                    "email": {
                      "type": "string",
                      "example": "george.harrison@example.com"
                    },
                    "password": {
                      "type": "string",
                      "example": ""
                    },
                    "name": {
                      "type": "string",
                      "example": "George Harrison"
                    },
                    "defaultTimeZone": {
                      "type": "string",
                      "example": "UTC"
                    },
                    "accessLevel": {
                      "type": "string",
                      "example": "read"
                    },
                    "canAccessStudio": {
                      "type": "string",
                      "example": "false"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl -X PUT -H \"X-Adzerk-ApiKey:$ADZERK_API_KEY\" -H \"Content-Type:application/json\" \"https://api.kevel.co/v1/login/12345\" --data-binary '{\"Id\":12345,\"Email\":\"\",\"Name\":\"George Harrison\",\"DefaultTimeZone\":\"UTC\",\"AccessLevel\":\"read\",\"CanAccessStudio\":\"false\"}'"
            },
            {
              "language": "javascript",
              "code": "const Adzerk = require('@adzerk/management-sdk');\nconst apiKey = process.env.ADZERK_API_KEY;\n\nasync function updateUser() {\n  let specifications = await Adzerk.fetchSpecifications();\n  let client = await Adzerk.buildClient({apiKey, specifications});\n\n  let user = await client.run('user', 'update', {\n    id: 12345,\n    email: '',\n    name: 'George Harrison',\n    defaultTimeZone: 'UTC',\n    accessLevel: 'read',\n  });\n  console.log(user);\n}\n\nupdateUser();"
            },
            {
              "language": "ruby",
              "code": "require \"adzerk\"\n\ndef update_user()\n    client = Adzerk::Client.new(ENV[\"ADZERK_API_KEY\"])\n    data = {\n        id: 12345,\n        email: 'user@example.com',\n        name: 'New User Name',\n        default_time_zone: 'UTC',\n      \taccess_level: 'read',\n    }\n    pp client.logins.update(data)\nend\nupdate_user()"
            }
          ],
          "samples-languages": [
            "curl",
            "javascript",
            "ruby"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "X-Adzerk-Sdk-Version",
        "value": "Readme.io:ManagementAPI2"
      }
    ],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```