Create GenericNotification

POST

/generic-notifications

Notifications

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

GenericNotification

Example:

GenericNotification

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "GenericNotification",
        "attributes": {
            "subject": "string",
            "body": "string",
            "previewText": "string",
            "replyTo": "string",
            "ccSender": true,
            "bcc": [
                {
                    "name": "string",
                    "email": "string"
                }
            ],
            "attachments": [
                {
                    "filename": "string",
                    "content": "string",
                    "type": "application/pdf"
                }
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "attempts": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                ]
            },
            "users": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "User"
                    }
                ]
            },
            "user": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/generic-notifications' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "GenericNotification",
        "attributes": {
            "subject": "string",
            "body": "string",
            "previewText": "string",
            "replyTo": "string",
            "ccSender": true,
            "bcc": [
                {
                    "name": "string",
                    "email": "string"
                }
            ],
            "attachments": [
                {
                    "filename": "string",
                    "content": "string",
                    "type": "application/pdf"
                }
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "attempts": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                ]
            },
            "users": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "User"
                    }
                ]
            },
            "user": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (GenericNotification)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

GenericNotification

Example:

GenericNotification

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "GenericNotification",
        "attributes": {
            "subject": "string",
            "body": "string",
            "previewText": "string",
            "replyTo": "string",
            "ccSender": true,
            "bcc": [
                {
                    "name": "string",
                    "email": "string"
                }
            ],
            "attachments": [
                {
                    "filename": "string",
                    "content": "string",
                    "type": "application/pdf"
                }
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "attempts": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                ]
            },
            "users": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "User"
                    }
                ]
            },
            "user": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

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

Get BackgroundJob

List NotificationGroups