COcortex
Verifications

Update a verification period

Changed on

Replaces the period in full; omitted optional fields are cleared rather than left alone. Changing the scope changes who owes a verification: widening it adds PENDING entries, and narrowing it removes entries along with any answer already recorded for them.

put/api/v1/verification-periods/{periodCid}

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}
  • Auth
    HTTP bearer

Path parameters

periodCidstring required

The CID of the verification period

Request body

descriptionstring

What owners are being asked to confirm

endDatestring date-time required

The day the period closes, inclusive

namestring required

Display name

reasonRequiredboolean

Whether a reason is required to mark an entity incorrect. Marking an entity correct never requires one. Defaults to false.

requiredCustomRoleTagsstring[] required

Tags of custom Cortex roles a user must hold to verify

requiredRolesstring[] required

Cortex roles a user must hold to verify. Empty means any owner of the entity may verify.

requiredTeamRoleTagsstring[] required

Tags of team roles a user must hold on a team that owns the entity in order to verify

startDatestring date-time required

The day the period opens, inclusive

Example request

{
  "name": "Q3 Ownership Review",
  "requiredRoles": [
    "OWNER"
  ],
  "scope": {
    "cqlQuery": "tag != null",
    "types": [
      "service"
    ]
  }
}

Response

The updated verification period

cidstring required

Stable identifier, usable wherever a period CID is accepted

descriptionstring

What owners are being asked to confirm

endDatestring date-time required

When the period closes

isActiveboolean required

Whether the period is open today, and so still accepting verifications

namestring required

Display name

reasonRequiredboolean required

Whether a reason is required when an entity is marked incorrect

requiredCustomRoleTagsstring[] required

Tags of custom Cortex roles a user must hold to verify

requiredRolesstring[] required

Cortex roles a user must hold to verify

requiredTeamRoleTagsstring[] required

Tags of team roles a user must hold on an owning team to verify

startDatestring date-time required

When the period opens

Example response

{
  "cid": "vp0a1b2c3d4e5f6789",
  "counts": {
    "pending": 12,
    "verifiedCorrect": 40,
    "verifiedIncorrect": 3
  },
  "isActive": true,
  "name": "Q3 Ownership Review",
  "requiredRoles": [
    "OWNER"
  ],
  "scope": {
    "cqlQuery": "tag != null",
    "types": [
      "service"
    ]
  }
}

Changes