Skip to main content
PATCH
/
api
/
public
/
v1
/
compliance
/
checks
/
{id}
Update assigned compliance check
curl --request PATCH \
  --url https://app.msportal.ai/api/public/v1/compliance/checks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "statusItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notesPublic": "<string>",
  "notesPrivate": "<string>",
  "flagged": true,
  "dueDate": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "status": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>",
      "isPositive": true,
      "isComplete": true
    },
    "criticality": 5,
    "flagged": true,
    "dueDate": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "notesPublic": "<string>",
    "notesPrivate": "<string>",
    "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "runName": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "groupName": "<string>",
    "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deviceName": "<string>",
    "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locationName": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

​
id
string<uuid>
required

Assigned check ID

Body

application/json
​
statusItemId
string<uuid>

New status item ID

​
notesPublic
string

Public notes (max 10000 chars)

Maximum string length: 10000
​
notesPrivate
string

Private notes (max 10000 chars)

Maximum string length: 10000
​
priority
enum<string>

Priority level

Available options:
High,
Medium,
Low
​
flagged
boolean

Flag status

​
dueDate
string<date-time> | null

Due date (ISO 8601)

Response

Updated assigned compliance check

​
data
object
required