Request
Body Params application/vnd.api+jsonRequired
{
"data": {
"id": "FID001",
"type": "User",
"attributes": {
"name": "string",
"emailAddress": "string",
"externalId": "string",
"profilePicture": {
"__type": "File",
"name": "string",
"url": "string"
},
"preferences": {},
"attr": {},
"timeZone": "string",
"notificationConfig": {},
"marketingEmailsConsent": "string"
},
"relationships": {
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"userAttributes": {
"data": [
{
"id": "FID001",
"type": "UserAttribute"
}
]
},
"userGroups": {
"data": [
{
"id": "FID001",
"type": "UserGroup"
}
]
}
}
}
}
Request Code Samples
curl --location --request PATCH 'https://api.synap.ac/v3/users/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "User",
"attributes": {
"name": "string",
"emailAddress": "string",
"externalId": "string",
"profilePicture": {
"__type": "File",
"name": "string",
"url": "string"
},
"preferences": {},
"attr": {},
"timeZone": "string",
"notificationConfig": {},
"marketingEmailsConsent": "string"
},
"relationships": {
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"userAttributes": {
"data": [
{
"id": "FID001",
"type": "UserAttribute"
}
]
},
"userGroups": {
"data": [
{
"id": "FID001",
"type": "UserGroup"
}
]
}
}
}
}'
Modified at 2025-09-30 10:40:38