Update subscribed alerts for an ambassador (manager)

PATCH /manager/ambassadors/{id}/alerts
Bearer token

Path parameters

  • id integer Required

    The ambassador id

application/json

Body

Responses

  • 200 application/json

    Return all subscribed alerts for an ambassador

    Hide response attributes Show response attributes object
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
  • 403

    Forbidden - You don't have permission to access this route

  • 404

    Not found - The ambassador does not exist

  • 422 application/json

    Unprocessable Content

    Hide response attributes Show response attributes object
    • message string

      Error message.

    • errors object
      Hide errors attributes Show errors attributes object
      • field array[string]

        Error message details.

      • * array[string] Additional properties

        Error message details.
PATCH /manager/ambassadors/{id}/alerts 
curl \
 -X PATCH https://domain.tld/api/v2/manager/ambassadors/{id}/alerts \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"alerts":[42]}'
Request examples 
{
  "alerts": [
    42
  ]
}
Response examples (200) 
[
  {
    "id": 42,
    "name": "string",
    "isManagerAlert": true
  }
]
Response examples (401) 
{
  "message": "Unauthorized."
}
Response examples (422) 
{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}