Step by step guide

Register the sender (optional)

If the sender must be registered in Noticeman, call the user registration endpoint first.

Create a notification request (v2)

Create the notification request with the provider-specific payload. A single request can generate one notification per receiver.

  • Create notification API call: POST /api/v1/private/notifications/v2.
  • Set data.provider to one of: EMAIL, NOTICEMAN, SMS, WFB.
  • If you provide requestId, you can add receivers and attachments later using that identifier.
  • The response includes requestId and notificationIds.

Manage receivers

Receivers can be added or removed while the request is in DRAFT status.

  • Add receivers API call: POST /api/v1/private/notifications/requests/{requestId}/receivers.
  • Delete receivers API call: DELETE /api/v1/private/notifications/requests/{requestId}/receivers.

Manage attachments

Attachments are only supported for NOTICEMAN and EMAIL providers.

  • Add attachments API call: POST /api/v1/private/notifications/requests/{requestId}/attachments. The response includes upload links.
  • Upload the files using the returned upload links.
  • You can also generate a new upload URL for an existing attachment with POST /api/v1/private/requests/{requestId}/attachments/{attachmentId}/upload-url.
  • Use POST /api/v1/private/requests/{requestId}/attachments/{attachmentId}/download-url to obtain download links when needed.

Dispatch notifications

Notifications can be dispatched automatically or manually depending on autosend:

  • If autosend is true, the system dispatches notifications automatically once attachments are ready or when there are no attachments.
  • If autosend is false, call POST /api/v1/private/notifications/requests/{requestId}/activate to dispatch.

Monitor and operate notifications

Use search and detail endpoints to track status. Noticeman notifications also allow cancel, resend, and hot edit operations.

  • Search notifications: GET /api/v1/private/notifications.
  • Notification detail: GET /api/v1/private/notifications/{notificationId}.
  • Cancel notification: POST /api/v1/private/notifications/{notificationId}/cancel (Noticeman only).
  • Resend notification: POST /api/v1/private/notifications/{notificationId}/resend (Noticeman only, original notification is cancelled).
  • Hot edit notification: PATCH /api/v1/private/notifications/{notificationId} (Noticeman only, original notification is cancelled).

Generate reports

Reports can be generated once the request is created. You can download the PDF or the report package when it is ready.

  • Generate report: POST /api/v1/private/reports.
  • Download report PDF: GET /api/v1/private/reports/{reportId}/file.
  • Download report package: GET /api/v1/private/reports/{reportId}/package.