v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB

Users

Update user

Update an existing user.

gigstack Connect: Update other teams' users using the team parameter.

put/users/{id}

Path parameters

idstring required

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

Request body

emailstring email nullable

first_namestring nullable

last_namestring nullable

phonestring nullable

company_rolestring nullable

auto_joinboolean nullable

If true, automatically adds the user to the team associated with the API key. Defaults to false if not specified. When true and role is specified, the user will be added with that role.

role'editor' | 'admin' | 'viewer' nullable

Role to assign to the user when auto_join is true. Can be "editor", "admin", or "viewer". Defaults to "viewer" if not specified. This parameter works in conjunction with auto_join - when auto_join is true, the user will be added to the team with the specified role.

Example request

{
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+52 55 1234 5678",
  "company_role": "Manager",
  "address": {
    "country": "MEX",
    "street": "Av. Insurgentes Sur",
    "zip": "03100",
    "city": "Ciudad de México",
    "state": "CDMX",
    "exterior": "123",
    "municipality": "Benito Juárez",
    "neighborhood": "Del Valle"
  },
  "auto_join": true,
  "role": "viewer"
}

Response

User updated successfully

messagestring required

dataobject required

Example response

{
  "message": "Operation completed successfully"
}