Create UserImport

POST

/user-imports

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserImport

Example:

UserImport

attributes

object

optional

relationships

object

required

Example

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

Request 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": [
                "user@example.com"
            ],
            "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

data

object (UserImport)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserImport

Example:

UserImport

attributes

object

optional

relationships

object

optional

Example

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

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-07-08 10:51:22

Remove Users from UserGroup

List UserTypes