Add Users to UserGroup

POST

/user-groups/{object_id}/relationships/users

Request

Path Params

Body Params application/vnd.api+json

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "User"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/user-groups//relationships/users' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": [
        {
            "id": "FID001",
            "type": "User"
        }
    ]
}'

Responses

🟢202Accepted

application/vnd.api+json

Accepted

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "BackgroundJob"
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-09-15 09:58:55

Delete UserGroup

Remove Users from UserGroup