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:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/notification-recipients HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "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": "[email protected]"
      },
      "status": "pending",
      "createdAt": "2025-07-16T17:42:28.054Z",
      "updatedAt": "2025-07-16T17:42:28.054Z",
      "updatedByType": "text",
      "updatedById": "text",
      "createdByType": "text",
      "createdById": "text"
    }
  ]
}

Create a notification recipient

post

Create a notification recipient

Body

An entity or channel to send event notifications.

idstring · uuidRead-onlyOptional
namestringRequired
descriptionstring | nullableOptional
typestring · enumRequiredPossible values:
templatestring | nullableOptional
prioritiesnumber[]Optional

List of priorities for this recipient to be notified

settingsone ofRequired
or
or
or
or
or
or
statusstring · enumRead-onlyOptionalPossible values:
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
updatedByTypestring | nullableOptional
updatedByIdstring | nullableOptional
createdByTypestring | nullableOptional
createdByIdstring | nullableOptional
Responses
201
Created
application/json
post
POST /api/notification-recipients HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[email protected]"
  },
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[email protected]"
  },
  "status": "pending",
  "createdAt": "2025-07-16T17:42:28.054Z",
  "updatedAt": "2025-07-16T17:42:28.054Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

Get a notification recipient

get

Get a notification recipient

Path parameters
notificationrecipientsIdstringRequired
Query parameters
typestringOptional

Filter by type

Responses
200
OK
application/json
get
GET /api/notification-recipients/{notificationrecipientsId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[email protected]"
  },
  "status": "pending",
  "createdAt": "2025-07-16T17:42:28.054Z",
  "updatedAt": "2025-07-16T17:42:28.054Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}

Delete a notification recipient

delete

Delete a notification recipient

Path parameters
notificationrecipientsIdstringRequired
Responses
204
No Content
delete
DELETE /api/notification-recipients/{notificationrecipientsId} HTTP/1.1
Host: app.seedata.io
Accept: */*
204

No Content

No content

Update a notification recipient

patch

Update a notification recipient

Path parameters
notificationrecipientsIdstringRequired
Body

An entity or channel to send event notifications.

idstring · uuidRead-onlyOptional
namestringRequired
descriptionstring | nullableOptional
typestring · enumRequiredPossible values:
templatestring | nullableOptional
prioritiesnumber[]Optional

List of priorities for this recipient to be notified

settingsone ofRequired
or
or
or
or
or
or
statusstring · enumRead-onlyOptionalPossible values:
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
updatedByTypestring | nullableOptional
updatedByIdstring | nullableOptional
createdByTypestring | nullableOptional
createdByIdstring | nullableOptional
Responses
200
OK
application/json
patch
PATCH /api/notification-recipients/{notificationrecipientsId} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[email protected]"
  },
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "email",
  "template": "text",
  "priorities": [
    1
  ],
  "settings": {
    "email": "[email protected]"
  },
  "status": "pending",
  "createdAt": "2025-07-16T17:42:28.054Z",
  "updatedAt": "2025-07-16T17:42:28.054Z",
  "updatedByType": "text",
  "updatedById": "text",
  "createdByType": "text",
  "createdById": "text"
}
PreviousIntelNextTest

Was this helpful?