Delete a note

Overview

Remove a note from a problem.

Use this to clean up a mistaken note.

You'll need the note's id (id from List a problem's notes).

The note is removed.

Prerequisites

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

POST /api/v1/partner/error-notifications/notes/delete

Authentication

Partner token

  • Use it only for notes on your own partner's problems.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

FieldTypeRequiredDescription
idintegerYesThe note's id. Must exist.

Request payload

{
  "id": 88
}

Response body

The payload is inside data.

FieldTypeDescription
statusstringsuccess.
messagestringNotification note deleted successfully.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

404 Problem outside your account

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

422 Missing id

{
  "message": "The id field is required.",
  "errors": {
    "id": [
      "The id field is required."
    ]
  }
}

422 Note doesn't exist

{
  "message": "The selected id is invalid.",
  "errors": {
    "id": [
      "The selected id is invalid."
    ]
  }
}
StatusMeaning
200The note was deleted.
401The token is missing, expired or invalid.
404The note's problem isn't in your account tree.
422id is missing or doesn't exist.
500Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/error-notifications/notes/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"id": 88}'

Did this page help you?