Add a note

Overview

Add a free-text note to an error notification.

Prerequisites

  • A bearer token. Callable with Partner tokens.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://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 partner prefix.
  • The request validation checks that notification_id exists in email_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:
FieldTypeRequiredDescription
notification_idintegerYesMust be an existing notification.
note_contentstringYesThe 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

{
  "data": { "status": "success", "message": "Notification note saved successfully." }
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422The request failed validation — the response names the fields
500Unexpected 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."}'

Did this page help you?