Synap API

Create UserRegistration

Staging

https://api-stage.synap.ac/v3

POST

/user-registrations

Users

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserRegistration

Example:

UserRegistration

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "UserRegistration",
        "attributes": {
            "name": "string",
            "emailAddress": "string",
            "password": "string",
            "signUpSource": "Web",
            "marketingEmailsConsent": "string",
            "registration": {},
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "utm": {}
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-stage.synap.ac/v3/user-registrations' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "UserRegistration",
        "attributes": {
            "name": "string",
            "emailAddress": "string",
            "password": "string",
            "signUpSource": "Web",
            "marketingEmailsConsent": "string",
            "registration": {},
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "utm": {}
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (UserRegistration)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserRegistration

Example:

UserRegistration

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "UserRegistration",
        "attributes": {
            "name": "string",
            "emailAddress": "string",
            "password": "string",
            "signUpSource": "Web",
            "marketingEmailsConsent": "string",
            "registration": {},
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "utm": {}
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-06-25 20:41:14

Create UserPassword

Get UserStat