LIlinearb
Users

Patch User

Users API endpoint performs a LinearB update user. Note: if custom_info is not provided, it will not be overwritten.

patch/api/v1/users/{user_id}

Request

Path parameters

user_idinteger required

User object ID

Request body

namestring

username must be at least 3 characters long, start with a letter

emailstring

User's email address

Example request

{
  "name": "ada lovelace",
  "email": "ada@lovelace.io",
  "permission": {
    "team_scopes": [
      "All Teams"
    ]
  },
  "team_membership": [
    {
      "name": "Ada engineering",
      "joined_at": "2025-01-01"
    }
  ],
  "custom_info": {
    "extra_emails": [
      "user@lovelace.io"
    ],
    "extra_ids": [
      "1234567890"
    ]
  }
}

Response

Successful Response

idinteger required

The unique identifier of the user

organization_idstring required

The ID of the organization this user belongs to

namestring required

The full name of the user

emailstring

The user's email address

avatar_urlstring

URL to the user's avatar image

extraobject

Additional custom information about the user

created_atstring required

The timestamp when the user was created

updated_atstring

The timestamp when the user was last updated

deleted_atstring

The timestamp when the user was deleted, if applicable

team_membershipobject[]

List of teams the user belongs to

user_type_idinteger

The type identifier for this user

permissionsobject

User's permission settings

Changes

No recorded changes to this operation across all 1 revision of this API.