Step by step guide
Contents
Register the sender (optional)
If the sender must be registered in Noticeman, call the user registration endpoint first.
- Register user API call:
POST /api/v1/private/users. See the user operations docs for details.
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.providerto one of:SMTP,NOTICEMAN,SMS,WFB,RCS. Note: the formerEMAILvalue was renamed toSMTPin February 2026 (breaking change). - If you provide
requestId, you can add receivers and attachments later using that identifier. - The response includes
requestIdandnotificationIds.
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 SMTP providers.
- Add attachments API call:
POST /api/v1/private/notifications/requests/{requestId}/attachments. The response includes upload links. - Upload each file to its link with an HTTP PUT. It is not a plain PUT: it requires
the
x-amz-checksum-sha256header with the SHA-256 of the file in base64, not in hexadecimal.
curl -v -H "x-amz-checksum-sha256: GeVzSCAm8YTwvKbEgdmKY0nj+EQhH4i5ZtSpxy+oNR4=" -T "contract.pdf" "<upload link>"
The response does not tell you which link belongs to which file: it carriesurl,expirationandfileId, but not the file name. With several attachments, match them by position, in the same order you declared them. - 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-urlto obtain download links when needed.
Dispatch notifications
Notifications can be dispatched automatically or manually depending on autosend:
- If
autosendistrue, the system dispatches notifications automatically once attachments are ready or when there are no attachments. - If
autosendisfalse, callPOST /api/v1/private/notifications/requests/{requestId}/activateto dispatch.
If the request has attachments, set autosend to false and activate it once every file is uploaded. With autosend: true, a request whose files are uploaded after it is created may stay in DRAFT without being dispatched, and the dispatch is not retried. Requests without attachments are not affected.
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). - Clone notification:
POST /api/v1/private/notifications/{notificationId}/clone(Noticeman only, original notification is not cancelled). - Delete bulk notifications:
DELETE /api/v1/private/bulk/notifications(asynchronous and irreversible clean-up of up to 100 notifications per call).
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. - Generate or package reports in bulk:
POST /api/v1/private/bulk/reports(asynchronous, up to 300 notifications per call by default, configurable per tenant; the result is sent to your webhook). - Download the bulk reports ZIP file:
GET /api/v1/private/bulk/reports/{bulkReportProcessId}/file.