POST/transactional-api/archive-custom-dashboard

Archive Custom Dashboard

Archives a custom dashboard template, making it unavailable for use.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/archive-custom-dashboard' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "dashboardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }'

Body parameters

Field	Type	Required	Description
dashboardId	string<uuid>	Yes	ID of the custom dashboard to archive.

Responses

200 Success.

{
  "status": "ok"
}

400 Invalid request.

3 possible code values

Code	Description	When
missing-required-field	fieldName is required	a required field is absent
invalid-operation	Human-readable reason.	business rule violation
invalid-field	fieldName must be a valid UUID	a UUID field is not a valid UUID

{
  "errors": [
    {
      "code": "missing-required-field",
      "description": "fieldName is required"
    }
  ]
}