Mark problems resolved or in progress

Overview

Change the status of one or many problems at once.

Use this to mark problems resolved after you fix them, or acknowledged (in progress) while you work.

You'll need the notification ids and the new status.

The problems are updated: resolved closes them and records when; acknowledged moves them to the acknowledged list. Each is also marked as opened.

Prerequisites

A Partner bearer token. See Authentication.
Use ids of your own problems, from List open problems.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/partner/error-notifications/status/update

Authentication

Partner token

Use it only for your own partner's problems, from List open problems. A problem outside your account tree returns 404.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`id`	array of integers	Yes	The problems' ids. Each must exist.
`status`	string	Yes	`resolved` or `acknowledged`.

Request payload

{
  "id": [
    1215,
    1216
  ],
  "status": "acknowledged"
}

Response body

The payload is inside data.

Field	Type	Description
`message`	string	`Selected notifications have been marked as Acknowledged.` or `Selected notifications have been marked as Resolved.`; `Some notifications not found.` if any couldn't be saved.

Response payload

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

Examples

Success payload

Acknowledged: see Response payload.

Resolved:

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

Error payload

404 Problem outside your account

{
  "message": "Notification not found.",
  "status": "error",
  "errors": []
}

422 Missing fields

{
  "message": "The id field is required. (and 1 more error)",
  "errors": {
    "id": [
      "The id field is required."
    ],
    "status": [
      "The status field is required."
    ]
  }
}

422 Invalid values

{
  "message": "The selected status is invalid. (and 1 more error)",
  "errors": {
    "status": [
      "The selected status is invalid."
    ],
    "id.0": [
      "The selected id.0 is invalid."
    ]
  }
}

Status	Meaning
`200`	The problems were updated.
`401`	The token is missing, expired or invalid.
`404`	One of the problems isn't in your account tree. Nothing is updated.
`422`	`id` or `status` is missing, the status isn't allowed, or an id doesn't exist.
`500`	Unexpected 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": [1215, 1216], "status": "acknowledged"}'

Updated 14 days ago

Did this page help you?