Add a note
Overview
Add a free-text note to an error notification.
Prerequisites
- A bearer token. Callable with Partner tokens.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
POST /api/v1/partner/error-notifications/notes/add
Authentication
- Requires a bearer token in the
Authorization: Bearer <bearer-token>header. - Who can call it: Partner tokens.
- Authentication is under the
partnerprefix. - The request validation checks that
notification_idexists inemail_notifications. - There is no partner-tree / ownership-check gate: a note may be attached to any existing notification id.
Rate limit
- No rate limit.
Request body
- Body:
| Field | Type | Required | Description |
|---|---|---|---|
notification_id | integer | Yes | Must be an existing notification. |
note_content | string | Yes | The note text. |
{
"notification_id": 1215,
"note_content": "Escalated to vendor; awaiting reconnect."
}Response
data.status(string) —success.data.message(string) —Notification note saved successfully.
200 Success · 200
200{
"data": { "status": "success", "message": "Notification note saved successfully." }
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Example request
curl --request POST \
--url "https://production-api.shoutaboutus.com/api/v1/partner/error-notifications/notes/add" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"notification_id": 1215, "note_content": "Escalated to vendor; awaiting reconnect."}'Updated 11 days ago
Did this page help you?
