feat: add bulk job status retrieval documentation - #237
Conversation
|
A review app will be deployed. Get the URL by going to https://cds-snc.github.io/notification-documentation/ |
Review AppsURLSLast updated atMon Aug 31 2026 17:18:03 GMT+0000 (Coordinated Universal Time) |
There was a problem hiding this comment.
English content looks good! One suggestion - I think it would be better to move this to its own section, so instead of:
Get message status
- Email status
- Text message status
- Get bulk job status
- Get the status of multiple messages
we have:
Get message status
- Email status
- Text message status
- Get the status of multiple messages
Get bulk job status
Since the new endpoint doesn't actually return the status of individual messages.
Good point, I'll make those changes... |
jimleroyer
left a comment
There was a problem hiding this comment.
The French additions are good. I left a nitpick on formulation but overall, the changes are aligned with existing precedents.
Co-authored-by: Jimmy Royer <jimmy.royer@cds-snc.ca>
|
Looks good Andrew! |
Summary | Résumé
This pull request adds new documentation for the bulk job status endpoints in both the English and French API reference guides. The updates describe how to retrieve the status and statistics for bulk notification jobs, including details on the endpoints, request parameters, response formats, and error codes.
Related Issues | Cartes liées
Test instructions | Instructions pour tester la modification
Release Instructions | Instructions pour le déploiement
None.
Reviewer checklist | Liste de vérification du réviseur