Create User with Role

POST

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

This API creates a new user with the specified role and attributes.

Behavior:

Assigns the user a specific role based on permissions.

Configures user attributes such as name, email, and access level.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "email": "user@example.com",
        "roleId": "Q3VzdG9tUm9sZToyMDgzMQ==",
        "firstName": "John",
        "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/create' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "email": "user@example.com",
        "roleId": "Q3VzdG9tUm9sZToyMDgzMQ==",
        "firstName": "John",
        "directCustomer": true
    }
}'

Responses

🟢200OK

application/json

User created successfully

Body

Example

{
    "data": {
        "addUser": {
            "success": true,
            "errors": [],
            "user": {
                "id": "VXNlcjoxNjUzNjA=",
                "createdAt": "2025-02-03 10:25:44 UTC",
                "directCustomer": true,
                "email": "user@example.com",
                "firstName": "John",
                "lastName": null,
                "inviteStatus": "INVITE_SENT",
                "customRole": {
                    "id": "Q3VzdG9tUm9sZToyMDgzMQ==",
                    "name": "Admin"
                },
                "accountId": "QWNjb3VudDoxNjE1NA==",
                "preferences": {
                    "locale": "en-US",
                    "dateFormat": null,
                    "timezone": null,
                    "columnOrder": null
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-05-15 14:01:51

User Attributes

List Users