Bulk update notification status

Overview

Bulk-updates the lifecycle status of one or more error notifications, marking them acknowledged or resolved.

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/status/update

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 each id.* exists in error_notifications.
  • The controller loads all rows by id and updates them (no partner-tree / company scoping on which ids may be updated).
  • resolved sets resolved=1, status='none', resolved_at=now; acknowledged sets status='acknowledged'.
  • Each updated row is also stamped notified=1/notified_at (only when the caller's company_id is present and the row was not already notified).

Rate limit

  • No rate limit.

Request body

  • Body:
FieldTypeRequiredDescription
idarray of integersYesNotification ids; each must be a known notification.
statusstringYesOne of resolved, acknowledged.
{
  "id": [
    1,
    2,
    3
  ],
  "status": "acknowledged"
}

Response

  • data.message (string) — Selected notifications have been marked as Acknowledged. / . Resolved. (status is ucfirst-ed), or Some notifications not found. if any save failed.

200 Success · 200

{
  "data": { "message": "Selected notifications have been marked as Acknowledged." }
}

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/status/update" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"id": [1, 2, 3], "status": "acknowledged"}'

Did this page help you?