Update a User

POST

https://api.synup.com/api/v4/users/update

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.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "id": "VXNlcjo5OTY0",
        "email": "pttqa1+4186@gmail.com",
        "roleId": "Q3VzdG9tUm9sZToxNzc4Mw==",
        "firstName": "pttqa1+4187",
        "lastName": "",
        "phone": "",
        "archived": false,
        "directCustomer": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/users/update' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "id": "VXNlcjo5OTY0",
        "email": "pttqa1+4186@gmail.com",
        "roleId": "Q3VzdG9tUm9sZToxNzc4Mw==",
        "firstName": "pttqa1+4187",
        "lastName": "",
        "phone": "",
        "archived": false,
        "directCustomer": true
    }
}'

Responses

🟢200OK

application/json

Successfully updated user

Body

Examples

defaultalternative

{
    "data": {
        "updateUser": {
            "success": true,
            "errors": [],
            "user": {
                "id": "VXNlcjo5OTY0",
                "createdAt": "2019-12-24 00:00:00 UTC",
                "directCustomer": true,
                "email": "pttqa1+4187@gmail.com",
                "firstName": "pttqa1+4187",
                "lastName": "",
                "inviteStatus": "RESEND_INVITE",
                "customRole": {
                    "id": "Q3VzdG9tUm9sZToxNzc4Mw==",
                    "name": "Manager"
                },
                "accountId": "QWNjb3VudDoxMTA3Mw=="
            }
        }
    }
}

Modified at 2025-07-21 11:51:20

List User Resources

Remove Folders for User