---
title: "Update a User"
method: POST
path: "/users/update"
tags: ["User Management"]
---

# Update a User

`POST /users/update`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/users/update`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/users/update/post.ts> (a function with typed inputs; its response is checked against the schema)

This API updates specific parameters associated with a user.

Behavior:
- Allows modifying user attributes such as name, email, or role.
- It supports updating permissions and access settings.
- Ensures only editable fields can be modified.

## Headers

- `Authorization` string

## Request body

- object
  - `input` object
    - `id` string, required: Base64 encoded user ID
    - `email` string, email: User's email address
    - `firstName` string, required: User's first name
    - `lastName` string: User's last name
    - `roleId` string, required: Base64 encoded role ID
    - `phone` string: User's phone number
    - `archived` boolean: User's archive status
    - `directCustomer` boolean: Whether the user is a direct customer

## Response `200`

Successfully updated user

- object
  - `data` object
    - `updateUser` object
      - `success` boolean
      - `errors` string[]
      - `user` object
        - `id` string: Base64 encoded user ID
        - `createdAt` string, date-time
        - `directCustomer` boolean
        - `email` string, email
        - `firstName` string
        - `lastName` string
        - `inviteStatus` 'RESEND_INVITE' | 'INVITE_SENT'
        - `customRole` object
          - `id` string
          - `name` string
        - `accountId` string
        - `preferences` object
          - `locale` string
          - `dateFormat` string, nullable
          - `timezone` string, nullable
          - `columnOrder` string, nullable

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)