Create UserImport

POST

/user-imports

Request

Body Params application/vnd.api+jsonRequired

Example

{
    "data": {
        "type": "UserImport",
        "attributes": {
            "dryRun": true,
            "emails": [
                "string"
            ],
            "personalMessage": "string",
            "generateAccounts": true,
            "disableWelcomeEmail": true
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "csv": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/user-imports' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "UserImport",
        "attributes": {
            "dryRun": true,
            "emails": [
                "string"
            ],
            "personalMessage": "string",
            "generateAccounts": true,
            "disableWelcomeEmail": true
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "csv": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "UserImport",
        "attributes": {
            "dryRun": true,
            "emails": [
                "string"
            ],
            "personalMessage": "string",
            "generateAccounts": true,
            "disableWelcomeEmail": true,
            "usersInvited": [
                "string"
            ],
            "invitesUpdated": [
                "string"
            ],
            "existingUsersAdded": [
                "string"
            ],
            "existingUsersAttributesUpdated": [
                "string"
            ],
            "unchangedUsers": [
                "string"
            ],
            "generatedUsers": [
                "string"
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "csv": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

Modified at 2026-02-03 10:07:28

Remove Users from UserGroup

List UserTypes