Register a User
Prerequisite reading
User resource
User
is any individual such as a student, an educator or an admin, that can access your portal. We have a few User-adjacent resources defined in the API which are used in specific contexts.Registering a single user
/v3/user-registrations
.Register a student into the default Students user group
userGroups
relationship is specified, all users are registered into the default Students User Group.curl --location --request POST 'https://api.synap.ac/v3/user-registrations' \
--header 'Authorization: Bearer <PAT>' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"type": "UserRegistration",
"attributes": {
"name": "First Last",
"emailAddress": "f.last@domain.com",
"password": "PasswordABC123!"
},
"relationships": {}
}
}'
Register an educator into an Educator User Group
--data-raw '{
"data": {
"type": "UserRegistration",
"attributes": {
"name": "First Last",
"emailAddress": "f.last@domain.com",
"password": "PasswordABC123!"
},
"relationships": {
"userGroups": {
"data": [
{
"id": "FID_EDU_001",
"type": "UserGroup"
}
]
}
}
}
}'
userGroups
relationship is an array field, right now we only support a single value. Registering into multiple groups is currently prohibited due to the potential of request timeouts.Register a student into a specific Sub Portal
--data-raw '{
"data": {
"type": "UserRegistration",
"attributes": {
"name": "First Last",
"emailAddress": "f.last@domain.com",
"password": "PasswordABC123!"
},
"relationships": {
"subPortal": {
"data":
{
"id": "FID_SUBP_001",
"type": "SubPortal"
}
}
}
}
}'
Specify time zone, locale and disable welcome email
--data-raw '{
"data": {
"type": "UserRegistration",
"attributes": {
"name": "First Last",
"emailAddress": "f.last@domain.com",
"password": "PasswordABC123!",
"locale": "it-IT",
"timeZone": "Europe/Rome",
"welcomeEmailDisabled": true
},
"relationships": {}
}
}'
Add Custom Attributes
--data-raw '{
"data": {
"type": "UserRegistration",
"attributes": {
"name": "First Last",
"emailAddress": "f.last@domain.com",
"password": "PasswordABC123!",
"attr": {
"employee-id": "int-123",
"department": "Sales"
}
},
"relationships": {}
}
}'
Registering multiple users
Modified at 2025-07-08 11:30:34