Update AssignmentGroup

PATCH

/assignment-groups/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (AssignmentGroup)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AssignmentGroup

Example:

AssignmentGroup

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AssignmentGroup",
        "attributes": {
            "name": "string",
            "description": "string",
            "shortDescription": "string",
            "image": {
                "url": "string"
            },
            "absoluteDeadline": "2019-08-24T14:15:22Z",
            "relativeDeadline": "string",
            "deadlineType": "indefinite",
            "progressionType": "string",
            "isReviewRequired": true,
            "isArchived": true,
            "status": "inactive",
            "certificateTemplateId": "string",
            "certificateIgnoreSubPortalBranding": true,
            "certificateShareList": [
                {
                    "label": "string",
                    "urlPrefix": "string"
                }
            ],
            "startDate": "string",
            "endDate": "string"
        },
        "relationships": {
            "reviewers": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/assignment-groups/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "AssignmentGroup",
        "attributes": {
            "name": "string",
            "description": "string",
            "shortDescription": "string",
            "image": {
                "url": "string"
            },
            "absoluteDeadline": "2019-08-24T14:15:22Z",
            "relativeDeadline": "string",
            "deadlineType": "indefinite",
            "progressionType": "string",
            "isReviewRequired": true,
            "isArchived": true,
            "status": "inactive",
            "certificateTemplateId": "string",
            "certificateIgnoreSubPortalBranding": true,
            "certificateShareList": [
                {
                    "label": "string",
                    "urlPrefix": "string"
                }
            ],
            "startDate": "string",
            "endDate": "string"
        },
        "relationships": {
            "reviewers": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (AssignmentGroup)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AssignmentGroup

Example:

AssignmentGroup

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AssignmentGroup",
        "attributes": {
            "createdAt": "string",
            "updatedAt": "string",
            "name": "string",
            "description": "string",
            "shortDescription": "string",
            "image": {
                "url": "string"
            },
            "absoluteDeadline": "2019-08-24T14:15:22Z",
            "relativeDeadline": "string",
            "deadlineType": "indefinite",
            "progressionType": "string",
            "isReviewRequired": true,
            "isActive": true,
            "isPendingActivation": true,
            "isCompleted": true,
            "isArchived": true,
            "status": "inactive",
            "certificateTemplateId": "string",
            "certificateIgnoreSubPortalBranding": true,
            "certificateShareList": [
                {
                    "label": "string",
                    "urlPrefix": "string"
                }
            ],
            "startDate": "string",
            "endDate": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "course": {
                "data": {
                    "id": "FID001",
                    "type": "Course"
                }
            },
            "sourceCourse": {
                "data": {
                    "id": "FID001",
                    "type": "Course"
                }
            },
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "reviewers": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get AssignmentGroup

Delete AssignmentGroup