v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Update Login

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

put/v1/login/{LoginID}

Path parameters

loginIdinteger required

ID from the Create Login Endpoint. Can get from List Logins endpoint.

Request body

idstring required

emailstring required

Required by the API, but not updated. You can send as an empty string.

namestring required

Friendly name of the user. If not included, will reset to null

defaultTimeZonestring

If allowed by the network, the preferred time zone of the user.

accessLevelstring

The user permission level. Must be one of admn, edit, or read. If AccessLevel is not set, the user will retain the current AccessLevel.

canAccessStudioboolean

Must be true or false. Controls whether or not this user can access Studio. Defaults to false. Setting CanAccessStudio to true requires that AccessLevel be set to admn or edit.

Response

200

idinteger

emailstring

passwordstring

namestring

defaultTimeZonestring

accessLevelstring

canAccessStudiostring

Example response

{
  "id": 12345,
  "email": "george.harrison@example.com",
  "name": "George Harrison",
  "defaultTimeZone": "UTC",
  "accessLevel": "read",
  "canAccessStudio": "false"
}