Update UserGroup

PATCH

/user-groups/{object_id}

User Groups

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (UserGroup)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserGroup

Example:

UserGroup

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "UserGroup",
        "attributes": {
            "name": "string",
            "description": "string",
            "attr": {},
            "isArchived": true,
            "membershipExpiryEnabled": true,
            "membershipExpiryTimeToExpireInMs": 0
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "userType": {
                "data": {
                    "id": "FID001",
                    "type": "UserType"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "parentGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/user-groups/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "UserGroup",
        "attributes": {
            "name": "string",
            "description": "string",
            "attr": {},
            "isArchived": true,
            "membershipExpiryEnabled": true,
            "membershipExpiryTimeToExpireInMs": 0
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "userType": {
                "data": {
                    "id": "FID001",
                    "type": "UserType"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "parentGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (UserGroup)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserGroup

Example:

UserGroup

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "UserGroup",
        "attributes": {
            "name": "string",
            "description": "string",
            "attr": {},
            "isDefaultGroup": true,
            "defaultGroupType": "string",
            "isArchived": true,
            "totalUsers": 0,
            "parentId": "string",
            "internal": true,
            "membershipExpiryEnabled": true,
            "membershipExpiryTimeToExpireInMs": 0
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "userType": {
                "data": {
                    "id": "FID001",
                    "type": "UserType"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "parentGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:22

Get UserGroup

Delete UserGroup