Request
The primary key for each resource.
Body Params application/vnd.api+json
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "Invite",
"attributes": {
"status": "pending",
"lastSent": "string"
},
"relationships": {}
}
}
Request samples
curl --location --request PATCH 'https://api.synap.ac/v3/invites/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "Invite",
"attributes": {
"status": "pending",
"lastSent": "string"
},
"relationships": {}
}
}'
Responses
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "Invite",
"attributes": {
"emailAddress": "string",
"name": "string",
"personalMessage": "string",
"expiryDate": "string",
"valid": true,
"status": "pending",
"lastSent": "string",
"externalId": "string",
"attr": {}
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"invitee": {
"data": {
"id": "FID001",
"type": "User"
}
},
"userGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
}
}
}
}
Modified at 2025-07-08 10:51:21