Notification recipients

List notification recipients

get

List notification recipients

Query parameters

typestringoptional

Filter by type

offsetintegeroptional

Pagination offset

limitinteger · min: 1 · max: 100optional

Pagination limit

orderBystringoptional

Order the results by this field, in this direction

Example: createdAt:desc

Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.seedata.io/api/notification-recipients'

200

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "type": "email",
      "template": "text",
      "priorities": [
        1
      ],
      "settings": {
        "email": "[e-mail]"
      },
      "status": "pending",
      "createdAt": "2025-03-31T16:52:39.788Z",
      "updatedAt": "2025-03-31T16:52:39.788Z",
      "updatedByType": "text",
      "updatedById": "text",
      "createdByType": "text",
      "createdById": "text"
    }
  ]
}

OK

Create a notification recipient

post

Create a notification recipient

Body

idstring · uuidread-onlyoptional

namestringrequired

descriptionstring | nullableoptional

typestring · enumrequired

Available options:

templatestring | nullableoptional

prioritiesnumber[]optional

List of priorities for this recipient to be notified

settingsone ofrequired

statusstring · enumread-onlyoptional

Available options:

createdAtstring · date-timeread-onlyoptional

updatedAtstring · date-timeread-onlyoptional

updatedByTypestring | nullableoptional

updatedByIdstring | nullableoptional

createdByTypestring | nullableoptional

createdByIdstring | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.seedata.io/api/notification-recipients' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "type": "email",
    "template": "text",
    "priorities": [
      1
    ],
    "settings": {
      "email": "[e-mail]"
    },
    "updatedByType": "text",
    "updatedById": "text",
    "createdByType": "text",
    "createdById": "text"
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2025-03-31T16:52:39.788Z",
  "updatedAt": "2025-03-31T16:52:39.788Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

Created

Get a notification recipient

get

Get a notification recipient

Path parameters

notificationrecipientsIdstringrequired

Query parameters

typestringoptional

Filter by type

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2025-03-31T16:52:39.788Z",
  "updatedAt": "2025-03-31T16:52:39.788Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

OK

Delete a notification recipient

delete

Delete a notification recipient

Path parameters

notificationrecipientsIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}'

204

204

No body

No Content

Update a notification recipient

patch

Update a notification recipient

Path parameters

notificationrecipientsIdstringrequired

Body

idstring · uuidread-onlyoptional

namestringrequired

descriptionstring | nullableoptional

typestring · enumrequired

Available options:

templatestring | nullableoptional

prioritiesnumber[]optional

List of priorities for this recipient to be notified

settingsone ofrequired

statusstring · enumread-onlyoptional

Available options:

createdAtstring · date-timeread-onlyoptional

updatedAtstring · date-timeread-onlyoptional

updatedByTypestring | nullableoptional

updatedByIdstring | nullableoptional

createdByTypestring | nullableoptional

createdByIdstring | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/notification-recipients/{notificationrecipientsId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "type": "email",
    "template": "text",
    "priorities": [
      1
    ],
    "settings": {
      "email": "[e-mail]"
    },
    "updatedByType": "text",
    "updatedById": "text",
    "createdByType": "text",
    "createdById": "text"
  }'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[e-mail]"
  },
  "status": "pending",
  "createdAt": "2025-03-31T16:52:39.788Z",
  "updatedAt": "2025-03-31T16:52:39.788Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

OK