Update an Initiative
curl --request PUT \
--url https://api.getcortexapp.com/api/v1/initiatives/{cid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emphasizedLevels": [
{
"rank": 123
}
],
"emphasizedRules": [
{
"expression": "<string>"
}
],
"isDraft": true,
"name": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"description": "<string>",
"filter": {
"groups": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
},
"query": "<string>",
"types": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
}
}
}
'import requests
url = "https://api.getcortexapp.com/api/v1/initiatives/{cid}"
payload = {
"emphasizedLevels": [{ "rank": 123 }],
"emphasizedRules": [{ "expression": "<string>" }],
"isDraft": True,
"name": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"description": "<string>",
"filter": {
"groups": {
"exclude": ["<string>"],
"include": ["<string>"]
},
"query": "<string>",
"types": {
"exclude": ["<string>"],
"include": ["<string>"]
}
}
}
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({
emphasizedLevels: [{rank: 123}],
emphasizedRules: [{expression: '<string>'}],
isDraft: true,
name: '<string>',
scorecardTag: '<string>',
targetDate: '2023-12-25',
description: '<string>',
filter: {
groups: {exclude: ['<string>'], include: ['<string>']},
query: '<string>',
types: {exclude: ['<string>'], include: ['<string>']}
}
})
};
fetch('https://api.getcortexapp.com/api/v1/initiatives/{cid}', 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/initiatives/{cid}",
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([
'emphasizedLevels' => [
[
'rank' => 123
]
],
'emphasizedRules' => [
[
'expression' => '<string>'
]
],
'isDraft' => true,
'name' => '<string>',
'scorecardTag' => '<string>',
'targetDate' => '2023-12-25',
'description' => '<string>',
'filter' => [
'groups' => [
'exclude' => [
'<string>'
],
'include' => [
'<string>'
]
],
'query' => '<string>',
'types' => [
'exclude' => [
'<string>'
],
'include' => [
'<string>'
]
]
]
]),
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/initiatives/{cid}"
payload := strings.NewReader("{\n \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\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/initiatives/{cid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcortexapp.com/api/v1/initiatives/{cid}")
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 \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"emphasizedLevels": [
{
"color": "<string>",
"name": "<string>",
"rank": 123
}
],
"emphasizedRules": [
{
"expression": "<string>",
"description": "<string>",
"title": "<string>"
}
],
"isDraft": true,
"name": "<string>",
"scorecardName": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"cid": "in2da8159dbeefb974",
"description": "<string>",
"filter": {
"groups": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
},
"query": "<string>",
"types": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
}
},
"notificationSchedule": {
"isDisabled": true,
"timeInterval": 123,
"timeUnit": "<string>",
"replyToEmails": [
"<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
}Update an Initiative
Update an Initiative.
API key must have the Edit Initiative permission.
PUT
/
api
/
v1
/
initiatives
/
{cid}
Update an Initiative
curl --request PUT \
--url https://api.getcortexapp.com/api/v1/initiatives/{cid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emphasizedLevels": [
{
"rank": 123
}
],
"emphasizedRules": [
{
"expression": "<string>"
}
],
"isDraft": true,
"name": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"description": "<string>",
"filter": {
"groups": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
},
"query": "<string>",
"types": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
}
}
}
'import requests
url = "https://api.getcortexapp.com/api/v1/initiatives/{cid}"
payload = {
"emphasizedLevels": [{ "rank": 123 }],
"emphasizedRules": [{ "expression": "<string>" }],
"isDraft": True,
"name": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"description": "<string>",
"filter": {
"groups": {
"exclude": ["<string>"],
"include": ["<string>"]
},
"query": "<string>",
"types": {
"exclude": ["<string>"],
"include": ["<string>"]
}
}
}
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({
emphasizedLevels: [{rank: 123}],
emphasizedRules: [{expression: '<string>'}],
isDraft: true,
name: '<string>',
scorecardTag: '<string>',
targetDate: '2023-12-25',
description: '<string>',
filter: {
groups: {exclude: ['<string>'], include: ['<string>']},
query: '<string>',
types: {exclude: ['<string>'], include: ['<string>']}
}
})
};
fetch('https://api.getcortexapp.com/api/v1/initiatives/{cid}', 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/initiatives/{cid}",
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([
'emphasizedLevels' => [
[
'rank' => 123
]
],
'emphasizedRules' => [
[
'expression' => '<string>'
]
],
'isDraft' => true,
'name' => '<string>',
'scorecardTag' => '<string>',
'targetDate' => '2023-12-25',
'description' => '<string>',
'filter' => [
'groups' => [
'exclude' => [
'<string>'
],
'include' => [
'<string>'
]
],
'query' => '<string>',
'types' => [
'exclude' => [
'<string>'
],
'include' => [
'<string>'
]
]
]
]),
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/initiatives/{cid}"
payload := strings.NewReader("{\n \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\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/initiatives/{cid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcortexapp.com/api/v1/initiatives/{cid}")
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 \"emphasizedLevels\": [\n {\n \"rank\": 123\n }\n ],\n \"emphasizedRules\": [\n {\n \"expression\": \"<string>\"\n }\n ],\n \"isDraft\": true,\n \"name\": \"<string>\",\n \"scorecardTag\": \"<string>\",\n \"targetDate\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"filter\": {\n \"groups\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n },\n \"query\": \"<string>\",\n \"types\": {\n \"exclude\": [\n \"<string>\"\n ],\n \"include\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"emphasizedLevels": [
{
"color": "<string>",
"name": "<string>",
"rank": 123
}
],
"emphasizedRules": [
{
"expression": "<string>",
"description": "<string>",
"title": "<string>"
}
],
"isDraft": true,
"name": "<string>",
"scorecardName": "<string>",
"scorecardTag": "<string>",
"targetDate": "2023-12-25",
"cid": "in2da8159dbeefb974",
"description": "<string>",
"filter": {
"groups": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
},
"query": "<string>",
"types": {
"exclude": [
"<string>"
],
"include": [
"<string>"
]
}
},
"notificationSchedule": {
"isDisabled": true,
"timeInterval": 123,
"timeUnit": "<string>",
"replyToEmails": [
"<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
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
Body
application/json
Emphasized levels for the Initiative. Either emphasized levels or rules must be provided
Show child attributes
Show child attributes
Emphasized rules for the Initiative. Either emphasized levels or rules must be provided
Show child attributes
Show child attributes
Whether or not the Initiative is a draft
Name of the Initiative
Tag of the scorecard associated with the Initiative
Target date for the Initiative to be completed. Must be in the future
Optional description of the Initiative
Filter that selects the entities in the catalog, for FILTER catalogs
Show child attributes
Show child attributes
Notification schedule for the Initiative
Show child attributes
Show child attributes
Response
Successfully updated Initiative
Time the Initiative was created
Time the Initiative was last updated
Emphasized levels for the Initiative
Show child attributes
Show child attributes
Emphasized rules for the Initiative
Show child attributes
Show child attributes
Whether or not the Initiative is a draft
Name of the Initiative
Name of the scorecard associated with the Initiative
Tag of the scorecard associated with the Initiative
Target date for the Initiative to be completed
Unique, immutable, 18-character auto-generated identifier for the Initiative.
Example:
"in2da8159dbeefb974"
Optional description of the Initiative
Filter that selects the entities in the catalog, for FILTER catalogs
Show child attributes
Show child attributes
Notification schedule for the Initiative
Show child attributes
Show child attributes
Last modified on September 29, 2026