Add a note to a problem

Overview

Attach a note to a problem for your team.

Use this to record what you found or did.

You'll need the notification id and the note.

The note is saved with a timestamp, and shows as the problem's latestNote in List open problems.

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/notes/add

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
`notification_id`	integer	Yes	The problem's id. Must exist.
`note_content`	string	Yes	The note text.

Request payload

{
  "notification_id": 1215,
  "note_content": "Raised with the vendor; awaiting reconnect."
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`message`	string	`Notification note saved successfully.`

Response payload

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

Examples

Success payload

See Response payload.

Error payload

404 Problem outside your account

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

422 Missing fields

{
  "message": "The notification id field is required. (and 1 more error)",
  "errors": {
    "notification_id": [
      "The notification id field is required."
    ],
    "note_content": [
      "The note content field is required."
    ]
  }
}

422 Problem doesn't exist

{
  "message": "The selected notification id is invalid.",
  "errors": {
    "notification_id": [
      "The selected notification id is invalid."
    ]
  }
}

Status	Meaning
`200`	The note was saved.
`401`	The token is missing, expired or invalid.
`404`	The problem isn't in your account tree.
`422`	A field is missing, or `notification_id` doesn't exist.
`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": "Raised with the vendor; awaiting reconnect."}'

Updated 14 days ago

Did this page help you?