Update a verification period

curl --request PUT \
  --url https://api.getcortexapp.com/api/v1/verification-periods/{periodCid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endDate": "2023-11-07T05:31:56Z",
  "name": "Q3 Ownership Review",
  "requiredCustomRoleTags": [
    "<string>"
  ],
  "requiredRoles": [
    "OWNER"
  ],
  "requiredTeamRoleTags": [
    "<string>"
  ],
  "scope": {
    "entityGroups": [
      "<string>"
    ],
    "excludedEntityGroups": [
      "<string>"
    ],
    "types": [
      "service"
    ],
    "cqlQuery": "tag != null"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "reasonRequired": false
}
'

import requests

url = "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}"

payload = {
    "endDate": "2023-11-07T05:31:56Z",
    "name": "Q3 Ownership Review",
    "requiredCustomRoleTags": ["<string>"],
    "requiredRoles": ["OWNER"],
    "requiredTeamRoleTags": ["<string>"],
    "scope": {
        "entityGroups": ["<string>"],
        "excludedEntityGroups": ["<string>"],
        "types": ["service"],
        "cqlQuery": "tag != null"
    },
    "startDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "reasonRequired": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    endDate: '2023-11-07T05:31:56Z',
    name: 'Q3 Ownership Review',
    requiredCustomRoleTags: ['<string>'],
    requiredRoles: ['OWNER'],
    requiredTeamRoleTags: ['<string>'],
    scope: {
      entityGroups: ['<string>'],
      excludedEntityGroups: ['<string>'],
      types: ['service'],
      cqlQuery: 'tag != null'
    },
    startDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    reasonRequired: false
  })
};

fetch('https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'endDate' => '2023-11-07T05:31:56Z',
    'name' => 'Q3 Ownership Review',
    'requiredCustomRoleTags' => [
        '<string>'
    ],
    'requiredRoles' => [
        'OWNER'
    ],
    'requiredTeamRoleTags' => [
        '<string>'
    ],
    'scope' => [
        'entityGroups' => [
                '<string>'
        ],
        'excludedEntityGroups' => [
                '<string>'
        ],
        'types' => [
                'service'
        ],
        'cqlQuery' => 'tag != null'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'reasonRequired' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}"

	payload := strings.NewReader("{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}"

response = http.request(request)
puts response.read_body

{
  "cid": "vp0a1b2c3d4e5f6789",
  "counts": {
    "pending": 12,
    "verifiedCorrect": 40,
    "verifiedIncorrect": 3
  },
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "name": "Q3 Ownership Review",
  "reasonRequired": false,
  "requiredCustomRoleTags": [
    "<string>"
  ],
  "requiredRoles": [
    "OWNER"
  ],
  "requiredTeamRoleTags": [
    "<string>"
  ],
  "scope": {
    "entityGroups": [
      "<string>"
    ],
    "excludedEntityGroups": [
      "<string>"
    ],
    "types": [
      "service"
    ],
    "cqlQuery": "tag != null"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "status": 429,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "retryAfter": 1
}

PUT

api

verification-periods

{periodCid}

Update a verification period

curl --request PUT \
  --url https://api.getcortexapp.com/api/v1/verification-periods/{periodCid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endDate": "2023-11-07T05:31:56Z",
  "name": "Q3 Ownership Review",
  "requiredCustomRoleTags": [
    "<string>"
  ],
  "requiredRoles": [
    "OWNER"
  ],
  "requiredTeamRoleTags": [
    "<string>"
  ],
  "scope": {
    "entityGroups": [
      "<string>"
    ],
    "excludedEntityGroups": [
      "<string>"
    ],
    "types": [
      "service"
    ],
    "cqlQuery": "tag != null"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "reasonRequired": false
}
'

import requests

url = "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}"

payload = {
    "endDate": "2023-11-07T05:31:56Z",
    "name": "Q3 Ownership Review",
    "requiredCustomRoleTags": ["<string>"],
    "requiredRoles": ["OWNER"],
    "requiredTeamRoleTags": ["<string>"],
    "scope": {
        "entityGroups": ["<string>"],
        "excludedEntityGroups": ["<string>"],
        "types": ["service"],
        "cqlQuery": "tag != null"
    },
    "startDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "reasonRequired": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    endDate: '2023-11-07T05:31:56Z',
    name: 'Q3 Ownership Review',
    requiredCustomRoleTags: ['<string>'],
    requiredRoles: ['OWNER'],
    requiredTeamRoleTags: ['<string>'],
    scope: {
      entityGroups: ['<string>'],
      excludedEntityGroups: ['<string>'],
      types: ['service'],
      cqlQuery: 'tag != null'
    },
    startDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    reasonRequired: false
  })
};

fetch('https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'endDate' => '2023-11-07T05:31:56Z',
    'name' => 'Q3 Ownership Review',
    'requiredCustomRoleTags' => [
        '<string>'
    ],
    'requiredRoles' => [
        'OWNER'
    ],
    'requiredTeamRoleTags' => [
        '<string>'
    ],
    'scope' => [
        'entityGroups' => [
                '<string>'
        ],
        'excludedEntityGroups' => [
                '<string>'
        ],
        'types' => [
                'service'
        ],
        'cqlQuery' => 'tag != null'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'reasonRequired' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}"

	payload := strings.NewReader("{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcortexapp.com/api/v1/verification-periods/{periodCid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"Q3 Ownership Review\",\n  \"requiredCustomRoleTags\": [\n    \"<string>\"\n  ],\n  \"requiredRoles\": [\n    \"OWNER\"\n  ],\n  \"requiredTeamRoleTags\": [\n    \"<string>\"\n  ],\n  \"scope\": {\n    \"entityGroups\": [\n      \"<string>\"\n    ],\n    \"excludedEntityGroups\": [\n      \"<string>\"\n    ],\n    \"types\": [\n      \"service\"\n    ],\n    \"cqlQuery\": \"tag != null\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"reasonRequired\": false\n}"

response = http.request(request)
puts response.read_body

{
  "cid": "vp0a1b2c3d4e5f6789",
  "counts": {
    "pending": 12,
    "verifiedCorrect": 40,
    "verifiedIncorrect": 3
  },
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "name": "Q3 Ownership Review",
  "reasonRequired": false,
  "requiredCustomRoleTags": [
    "<string>"
  ],
  "requiredRoles": [
    "OWNER"
  ],
  "requiredTeamRoleTags": [
    "<string>"
  ],
  "scope": {
    "entityGroups": [
      "<string>"
    ],
    "excludedEntityGroups": [
      "<string>"
    ],
    "types": [
      "service"
    ],
    "cqlQuery": "tag != null"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "status": 429,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "retryAfter": 1
}

Authorizations

Authorization

string

header

required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

periodCid

string

required

The CID of the verification period

Body

application/json

A verification period to create, or the full replacement state for one

endDate

string<date-time>

required

The day the period closes, inclusive

name

string

required

Display name

Example:

"Q3 Ownership Review"

requiredCustomRoleTags

string[]

required

Tags of custom Cortex roles a user must hold to verify

requiredRoles

enum<string>[]

required

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

Available options:

VIEWER,

USER,

MANAGER,

API,

OWNER

Example:

["OWNER"]

requiredTeamRoleTags

string[]

required

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

scope

object

required

Which entities a verification period covers. An empty scope covers every entity. Combined conditions all have to hold.

Show child attributes

startDate

string<date-time>

required

The day the period opens, inclusive

description

string

What owners are being asked to confirm

reasonRequired

boolean

default:false

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

Example:

false

Response

The updated verification period

A verification period and how far along it is

cid

string

required

Stable identifier, usable wherever a period CID is accepted

Example:

"vp0a1b2c3d4e5f6789"

counts

object

required

Entity counts for one verification period

Show child attributes

endDate

string<date-time>

required

When the period closes

isActive

boolean

required

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

Example:

true

name

string

required

Display name

Example:

"Q3 Ownership Review"

reasonRequired

boolean

required

Whether a reason is required when an entity is marked incorrect

Example:

false

requiredCustomRoleTags

string[]

required

Tags of custom Cortex roles a user must hold to verify

requiredRoles

enum<string>[]

required

Cortex roles a user must hold to verify

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

Available options:

VIEWER,

USER,

MANAGER,

API,

OWNER

Example:

["OWNER"]

requiredTeamRoleTags

string[]

required

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

scope

object

required

Which entities a verification period covers. An empty scope covers every entity. Combined conditions all have to hold.

Show child attributes

startDate

string<date-time>

required

When the period opens

description

string

What owners are being asked to confirm

Last modified on September 29, 2026

Get started

REST API operations

Update a verification period

Authorizations

Path Parameters

Body

Response