Create Internal Markers Group

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object

optional

type

enum<string>

optional

Identifies the Resource.

Allowed value:

UserGroup

Example:

_User

Example

{
    "data": {
        "type": "UserGroup"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/vnd.api+json

Created

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

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

links

object

optional

self

string

optional

This field should be a valid URL.

Example:

https://some-url.com/path?query=true

meta

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"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "links": {
        "self": "https://some-url.com/path?query=true"
    },
    "meta": {}
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found