> For the complete documentation index, see [llms.txt](https://docs.cortex.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cortex.io/api/readme/initiatives.md).

# Initiatives

Use these operations to interact with [Initiatives](/improve/initiatives.md) in Cortex.

### Required permissions

* Create, read, update, or delete Initiatives: Your API key must have the `Edit Initiatives` permission.
* View Initiatives: Your API key must have the `View Initiatives` permission.

## Operations

## List Initiatives

> Retrieves a list of Initiatives.\
> \
> API key must have the \`View Initiatives\` permission.

```json
{"openapi":"3.0.1","info":{"title":"Cortex API","version":"v1"},"tags":[{"name":"Initiatives"}],"servers":[{"url":"https://api.getcortexapp.com","description":"Cortex Cloud API host"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"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.","scheme":"bearer","type":"http"}},"schemas":{"InitiativeListResponse":{"required":["initiatives","page","total","totalPages"],"type":"object","properties":{"initiatives":{"type":"array","items":{"$ref":"#/components/schemas/Initiative"}},"page":{"type":"integer","description":"Current page number, 0-indexed","format":"int32"},"total":{"type":"integer","description":"Total number of results","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages","format":"int32"}}},"Initiative":{"required":["dateCreated","dateUpdated","emphasizedLevels","emphasizedRules","isDraft","name","scorecardName","scorecardTag","targetDate"],"type":"object","properties":{"cid":{"type":"string","description":"Unique, immutable, 18-character auto-generated identifier for the Initiative."},"dateCreated":{"type":"string","description":"Time the Initiative was created","format":"date-time"},"dateUpdated":{"type":"string","description":"Time the Initiative was last updated","format":"date-time"},"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"uniqueItems":true,"type":"array","description":"Emphasized levels for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedLevel"}},"emphasizedRules":{"uniqueItems":true,"type":"array","description":"Emphasized rules for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedRule"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardName":{"type":"string","description":"Name of the scorecard associated with the Initiative"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed","format":"date"}}},"EmphasizedLevel":{"required":["color","name","rank"],"type":"object","properties":{"color":{"type":"string","description":"Color associated with the emphasized level"},"name":{"type":"string","description":"Name of the emphasized level"},"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative"},"EmphasizedRule":{"required":["expression"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the emphasized rule"},"expression":{"type":"string","description":"CQL expression for the emphasized rule"},"title":{"type":"string","description":"Optional title of the emphasized rule"}},"description":"Emphasized rules for the Initiative"},"Filter":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/GroupFilter"},"query":{"type":"string","description":"CQL expression to apply as a filter"},"types":{"$ref":"#/components/schemas/TypeFilter"}},"description":"Filter applied to the Initiative"},"GroupFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity groups to include or exclude"},"TypeFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set"},"NotificationSchedule":{"required":["isDisabled","timeInterval","timeUnit"],"type":"object","properties":{"isDisabled":{"type":"boolean","description":"Whether or not notifications are disabled for this Initiative"},"replyToEmails":{"type":"array","description":"Optional list of reply-to emails","items":{"type":"string","description":"Optional list of reply-to emails"}},"timeInterval":{"type":"integer","description":"Time interval for the notification schedule cadence","format":"int32"},"timeUnit":{"type":"string","description":"Time unit for the notification schedule. Must be one of DAY, WEEK, MONTH"}},"description":"Notification schedule for the Initiative"},"TooManyRequestsProblemDetail":{"required":["type","title","status"],"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"retryAfter":{"minimum":0,"type":"integer","description":"The number of seconds until the rate limiting resets.","format":"int32"},"status":{"maximum":599,"minimum":100,"type":"integer","format":"int32","enum":[429]},"title":{"type":"string"},"type":{"type":"string","format":"uri-reference"}}}},"responses":{"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsProblemDetail"}}},"description":"The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.","headers":{"Retry-After":{"description":"The number of seconds until the rate limiting resets.","schema":{"minimum":0,"type":"integer","format":"int32"}}}}}},"paths":{"/api/v1/initiatives":{"get":{"description":"Retrieves a list of Initiatives.\n\nAPI key must have the `View Initiatives` permission.","operationId":"listInitiatives","parameters":[{"description":"Whether or not to include draft Initiatives in the response","in":"query","name":"includeDrafts","required":false,"schema":{"type":"boolean","default":false}},{"description":"Whether or not to include expired Initiatives in the response","in":"query","name":"includeExpired","required":false,"schema":{"type":"boolean","default":false}},{"description":"Number of results to return per page, between 1 and 1000. Default 250.","in":"query","name":"pageSize","required":true,"schema":{"type":"integer","format":"int32","default":250}},{"description":"Page number to return, 0-indexed. Default 0.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiativeListResponse"}}},"description":"Successfully retrieved Initiatives"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List Initiatives","tags":["Initiatives"]}}}}
```

## Get Initiative

> Get Initiative.\
> \
> API key must have the \`View Initiatives\` permission.

```json
{"openapi":"3.0.1","info":{"title":"Cortex API","version":"v1"},"tags":[{"name":"Initiatives"}],"servers":[{"url":"https://api.getcortexapp.com","description":"Cortex Cloud API host"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"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.","scheme":"bearer","type":"http"}},"schemas":{"Initiative":{"required":["dateCreated","dateUpdated","emphasizedLevels","emphasizedRules","isDraft","name","scorecardName","scorecardTag","targetDate"],"type":"object","properties":{"cid":{"type":"string","description":"Unique, immutable, 18-character auto-generated identifier for the Initiative."},"dateCreated":{"type":"string","description":"Time the Initiative was created","format":"date-time"},"dateUpdated":{"type":"string","description":"Time the Initiative was last updated","format":"date-time"},"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"uniqueItems":true,"type":"array","description":"Emphasized levels for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedLevel"}},"emphasizedRules":{"uniqueItems":true,"type":"array","description":"Emphasized rules for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedRule"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardName":{"type":"string","description":"Name of the scorecard associated with the Initiative"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed","format":"date"}}},"EmphasizedLevel":{"required":["color","name","rank"],"type":"object","properties":{"color":{"type":"string","description":"Color associated with the emphasized level"},"name":{"type":"string","description":"Name of the emphasized level"},"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative"},"EmphasizedRule":{"required":["expression"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the emphasized rule"},"expression":{"type":"string","description":"CQL expression for the emphasized rule"},"title":{"type":"string","description":"Optional title of the emphasized rule"}},"description":"Emphasized rules for the Initiative"},"Filter":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/GroupFilter"},"query":{"type":"string","description":"CQL expression to apply as a filter"},"types":{"$ref":"#/components/schemas/TypeFilter"}},"description":"Filter applied to the Initiative"},"GroupFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity groups to include or exclude"},"TypeFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set"},"NotificationSchedule":{"required":["isDisabled","timeInterval","timeUnit"],"type":"object","properties":{"isDisabled":{"type":"boolean","description":"Whether or not notifications are disabled for this Initiative"},"replyToEmails":{"type":"array","description":"Optional list of reply-to emails","items":{"type":"string","description":"Optional list of reply-to emails"}},"timeInterval":{"type":"integer","description":"Time interval for the notification schedule cadence","format":"int32"},"timeUnit":{"type":"string","description":"Time unit for the notification schedule. Must be one of DAY, WEEK, MONTH"}},"description":"Notification schedule for the Initiative"},"ErrorResponse":{"required":["message","type"],"type":"object","properties":{"details":{"type":"string"},"errorCode":{"type":"string"},"gatewayHttpStatus":{"type":"integer","format":"int32"},"httpStatus":{"type":"integer","format":"int32"},"message":{"type":"string"},"requestId":{"type":"string"},"type":{"type":"string","enum":["INTEGRATION_MISSING","INTEGRATION_UNREGISTERED","INTEGRATION_UNSUPPORTED","INTEGRATION_GRAPHQL_ERROR","INTEGRATION_BAD_REQUEST","INTEGRATION_UNAUTHORIZED","INTEGRATION_FORBIDDEN","INTEGRATION_NOT_FOUND","INTEGRATION_UNPROCESSABLE_CONTENT","INTEGRATION_RATE_LIMITED","INTEGRATION_INTERNAL_ERROR","INTEGRATION_NOT_IMPLEMENTED","INTEGRATION_BAD_GATEWAY","INTEGRATION_UNAVAILABLE","INTEGRATION_GATEWAY_TIMEOUT","INTEGRATION_TIMED_OUT","INTEGRATION_CACHE_ERROR","INTEGRATION_UNHANDLED_HTTP_ERROR","INTEGRATION_UNHANDLED_EXCEPTION","INTEGRATION_UNEXPECTED_ERROR","ILLEGAL_ARGUMENT_ERROR","BAD_REQUEST","FORBIDDEN","NOT_FOUND","REQUEST_TIMEOUT","CONFLICT","UNHANDLED_EXCEPTION","UNCATEGORIZED","SERVICE_CREATOR","UNKNOWN_HOST","TOO_MANY_REQUESTS"]}}},"TooManyRequestsProblemDetail":{"required":["type","title","status"],"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"retryAfter":{"minimum":0,"type":"integer","description":"The number of seconds until the rate limiting resets.","format":"int32"},"status":{"maximum":599,"minimum":100,"type":"integer","format":"int32","enum":[429]},"title":{"type":"string"},"type":{"type":"string","format":"uri-reference"}}}},"responses":{"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsProblemDetail"}}},"description":"The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.","headers":{"Retry-After":{"description":"The number of seconds until the rate limiting resets.","schema":{"minimum":0,"type":"integer","format":"int32"}}}}}},"paths":{"/api/v1/initiatives/{cid}":{"get":{"description":"Get Initiative.\n\nAPI key must have the `View Initiatives` permission.","operationId":"getInitiative","parameters":[{"in":"path","name":"cid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative"}}},"description":"Successfully retrieved Initiative"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Initiative not found"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get Initiative","tags":["Initiatives"]}}}}
```

## Create an Initiative

> Create an Initiative.\
> \
> API key must have the \`Edit Initiative\` permission.

```json
{"openapi":"3.0.1","info":{"title":"Cortex API","version":"v1"},"tags":[{"name":"Initiatives"}],"servers":[{"url":"https://api.getcortexapp.com","description":"Cortex Cloud API host"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"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.","scheme":"bearer","type":"http"}},"schemas":{"InitiativeRequest":{"required":["emphasizedLevels","emphasizedRules","isDraft","name","scorecardTag","targetDate"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"type":"array","description":"Emphasized levels for the Initiative. Either emphasized levels or rules must be provided","items":{"$ref":"#/components/schemas/EmphasizedLadderLevelRequest"}},"emphasizedRules":{"type":"array","description":"Emphasized rules for the Initiative. Either emphasized levels or rules must be provided","items":{"$ref":"#/components/schemas/EmphasizedRuleRequest"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed. Must be in the future","format":"date"}}},"EmphasizedLadderLevelRequest":{"required":["rank"],"type":"object","properties":{"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative. Either emphasized levels or rules must be provided"},"EmphasizedRuleRequest":{"required":["expression"],"type":"object","properties":{"expression":{"type":"string","description":"CQL expression for the emphasized rule"}},"description":"Emphasized rules for the Initiative. Either emphasized levels or rules must be provided"},"Filter":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/GroupFilter"},"query":{"type":"string","description":"CQL expression to apply as a filter"},"types":{"$ref":"#/components/schemas/TypeFilter"}},"description":"Filter applied to the Initiative"},"GroupFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity groups to include or exclude"},"TypeFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set"},"NotificationSchedule":{"required":["isDisabled","timeInterval","timeUnit"],"type":"object","properties":{"isDisabled":{"type":"boolean","description":"Whether or not notifications are disabled for this Initiative"},"replyToEmails":{"type":"array","description":"Optional list of reply-to emails","items":{"type":"string","description":"Optional list of reply-to emails"}},"timeInterval":{"type":"integer","description":"Time interval for the notification schedule cadence","format":"int32"},"timeUnit":{"type":"string","description":"Time unit for the notification schedule. Must be one of DAY, WEEK, MONTH"}},"description":"Notification schedule for the Initiative"},"Initiative":{"required":["dateCreated","dateUpdated","emphasizedLevels","emphasizedRules","isDraft","name","scorecardName","scorecardTag","targetDate"],"type":"object","properties":{"cid":{"type":"string","description":"Unique, immutable, 18-character auto-generated identifier for the Initiative."},"dateCreated":{"type":"string","description":"Time the Initiative was created","format":"date-time"},"dateUpdated":{"type":"string","description":"Time the Initiative was last updated","format":"date-time"},"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"uniqueItems":true,"type":"array","description":"Emphasized levels for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedLevel"}},"emphasizedRules":{"uniqueItems":true,"type":"array","description":"Emphasized rules for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedRule"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardName":{"type":"string","description":"Name of the scorecard associated with the Initiative"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed","format":"date"}}},"EmphasizedLevel":{"required":["color","name","rank"],"type":"object","properties":{"color":{"type":"string","description":"Color associated with the emphasized level"},"name":{"type":"string","description":"Name of the emphasized level"},"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative"},"EmphasizedRule":{"required":["expression"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the emphasized rule"},"expression":{"type":"string","description":"CQL expression for the emphasized rule"},"title":{"type":"string","description":"Optional title of the emphasized rule"}},"description":"Emphasized rules for the Initiative"},"ErrorResponse":{"required":["message","type"],"type":"object","properties":{"details":{"type":"string"},"errorCode":{"type":"string"},"gatewayHttpStatus":{"type":"integer","format":"int32"},"httpStatus":{"type":"integer","format":"int32"},"message":{"type":"string"},"requestId":{"type":"string"},"type":{"type":"string","enum":["INTEGRATION_MISSING","INTEGRATION_UNREGISTERED","INTEGRATION_UNSUPPORTED","INTEGRATION_GRAPHQL_ERROR","INTEGRATION_BAD_REQUEST","INTEGRATION_UNAUTHORIZED","INTEGRATION_FORBIDDEN","INTEGRATION_NOT_FOUND","INTEGRATION_UNPROCESSABLE_CONTENT","INTEGRATION_RATE_LIMITED","INTEGRATION_INTERNAL_ERROR","INTEGRATION_NOT_IMPLEMENTED","INTEGRATION_BAD_GATEWAY","INTEGRATION_UNAVAILABLE","INTEGRATION_GATEWAY_TIMEOUT","INTEGRATION_TIMED_OUT","INTEGRATION_CACHE_ERROR","INTEGRATION_UNHANDLED_HTTP_ERROR","INTEGRATION_UNHANDLED_EXCEPTION","INTEGRATION_UNEXPECTED_ERROR","ILLEGAL_ARGUMENT_ERROR","BAD_REQUEST","FORBIDDEN","NOT_FOUND","REQUEST_TIMEOUT","CONFLICT","UNHANDLED_EXCEPTION","UNCATEGORIZED","SERVICE_CREATOR","UNKNOWN_HOST","TOO_MANY_REQUESTS"]}}},"TooManyRequestsProblemDetail":{"required":["type","title","status"],"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"retryAfter":{"minimum":0,"type":"integer","description":"The number of seconds until the rate limiting resets.","format":"int32"},"status":{"maximum":599,"minimum":100,"type":"integer","format":"int32","enum":[429]},"title":{"type":"string"},"type":{"type":"string","format":"uri-reference"}}}},"responses":{"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsProblemDetail"}}},"description":"The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.","headers":{"Retry-After":{"description":"The number of seconds until the rate limiting resets.","schema":{"minimum":0,"type":"integer","format":"int32"}}}}}},"paths":{"/api/v1/initiatives":{"post":{"description":"Create an Initiative.\n\nAPI key must have the `Edit Initiative` permission.","operationId":"createInitiative","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiativeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative"}}},"description":"Successfully created Initiative"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an Initiative","tags":["Initiatives"]}}}}
```

## Update an Initiative

> Update an Initiative.\
> \
> API key must have the \`Edit Initiative\` permission.

```json
{"openapi":"3.0.1","info":{"title":"Cortex API","version":"v1"},"tags":[{"name":"Initiatives"}],"servers":[{"url":"https://api.getcortexapp.com","description":"Cortex Cloud API host"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"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.","scheme":"bearer","type":"http"}},"schemas":{"InitiativeRequest":{"required":["emphasizedLevels","emphasizedRules","isDraft","name","scorecardTag","targetDate"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"type":"array","description":"Emphasized levels for the Initiative. Either emphasized levels or rules must be provided","items":{"$ref":"#/components/schemas/EmphasizedLadderLevelRequest"}},"emphasizedRules":{"type":"array","description":"Emphasized rules for the Initiative. Either emphasized levels or rules must be provided","items":{"$ref":"#/components/schemas/EmphasizedRuleRequest"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed. Must be in the future","format":"date"}}},"EmphasizedLadderLevelRequest":{"required":["rank"],"type":"object","properties":{"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative. Either emphasized levels or rules must be provided"},"EmphasizedRuleRequest":{"required":["expression"],"type":"object","properties":{"expression":{"type":"string","description":"CQL expression for the emphasized rule"}},"description":"Emphasized rules for the Initiative. Either emphasized levels or rules must be provided"},"Filter":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/GroupFilter"},"query":{"type":"string","description":"CQL expression to apply as a filter"},"types":{"$ref":"#/components/schemas/TypeFilter"}},"description":"Filter applied to the Initiative"},"GroupFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity groups to include or exclude"},"TypeFilter":{"type":"object","properties":{"exclude":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"include":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set"},"NotificationSchedule":{"required":["isDisabled","timeInterval","timeUnit"],"type":"object","properties":{"isDisabled":{"type":"boolean","description":"Whether or not notifications are disabled for this Initiative"},"replyToEmails":{"type":"array","description":"Optional list of reply-to emails","items":{"type":"string","description":"Optional list of reply-to emails"}},"timeInterval":{"type":"integer","description":"Time interval for the notification schedule cadence","format":"int32"},"timeUnit":{"type":"string","description":"Time unit for the notification schedule. Must be one of DAY, WEEK, MONTH"}},"description":"Notification schedule for the Initiative"},"Initiative":{"required":["dateCreated","dateUpdated","emphasizedLevels","emphasizedRules","isDraft","name","scorecardName","scorecardTag","targetDate"],"type":"object","properties":{"cid":{"type":"string","description":"Unique, immutable, 18-character auto-generated identifier for the Initiative."},"dateCreated":{"type":"string","description":"Time the Initiative was created","format":"date-time"},"dateUpdated":{"type":"string","description":"Time the Initiative was last updated","format":"date-time"},"description":{"type":"string","description":"Optional description of the Initiative"},"emphasizedLevels":{"uniqueItems":true,"type":"array","description":"Emphasized levels for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedLevel"}},"emphasizedRules":{"uniqueItems":true,"type":"array","description":"Emphasized rules for the Initiative","items":{"$ref":"#/components/schemas/EmphasizedRule"}},"filter":{"$ref":"#/components/schemas/Filter"},"isDraft":{"type":"boolean","description":"Whether or not the Initiative is a draft"},"name":{"type":"string","description":"Name of the Initiative"},"notificationSchedule":{"$ref":"#/components/schemas/NotificationSchedule"},"scorecardName":{"type":"string","description":"Name of the scorecard associated with the Initiative"},"scorecardTag":{"type":"string","description":"Tag of the scorecard associated with the Initiative"},"targetDate":{"type":"string","description":"Target date for the Initiative to be completed","format":"date"}}},"EmphasizedLevel":{"required":["color","name","rank"],"type":"object","properties":{"color":{"type":"string","description":"Color associated with the emphasized level"},"name":{"type":"string","description":"Name of the emphasized level"},"rank":{"type":"integer","description":"Rank of the level where 1 is the highest","format":"int32"}},"description":"Emphasized levels for the Initiative"},"EmphasizedRule":{"required":["expression"],"type":"object","properties":{"description":{"type":"string","description":"Optional description of the emphasized rule"},"expression":{"type":"string","description":"CQL expression for the emphasized rule"},"title":{"type":"string","description":"Optional title of the emphasized rule"}},"description":"Emphasized rules for the Initiative"},"ErrorResponse":{"required":["message","type"],"type":"object","properties":{"details":{"type":"string"},"errorCode":{"type":"string"},"gatewayHttpStatus":{"type":"integer","format":"int32"},"httpStatus":{"type":"integer","format":"int32"},"message":{"type":"string"},"requestId":{"type":"string"},"type":{"type":"string","enum":["INTEGRATION_MISSING","INTEGRATION_UNREGISTERED","INTEGRATION_UNSUPPORTED","INTEGRATION_GRAPHQL_ERROR","INTEGRATION_BAD_REQUEST","INTEGRATION_UNAUTHORIZED","INTEGRATION_FORBIDDEN","INTEGRATION_NOT_FOUND","INTEGRATION_UNPROCESSABLE_CONTENT","INTEGRATION_RATE_LIMITED","INTEGRATION_INTERNAL_ERROR","INTEGRATION_NOT_IMPLEMENTED","INTEGRATION_BAD_GATEWAY","INTEGRATION_UNAVAILABLE","INTEGRATION_GATEWAY_TIMEOUT","INTEGRATION_TIMED_OUT","INTEGRATION_CACHE_ERROR","INTEGRATION_UNHANDLED_HTTP_ERROR","INTEGRATION_UNHANDLED_EXCEPTION","INTEGRATION_UNEXPECTED_ERROR","ILLEGAL_ARGUMENT_ERROR","BAD_REQUEST","FORBIDDEN","NOT_FOUND","REQUEST_TIMEOUT","CONFLICT","UNHANDLED_EXCEPTION","UNCATEGORIZED","SERVICE_CREATOR","UNKNOWN_HOST","TOO_MANY_REQUESTS"]}}},"TooManyRequestsProblemDetail":{"required":["type","title","status"],"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"retryAfter":{"minimum":0,"type":"integer","description":"The number of seconds until the rate limiting resets.","format":"int32"},"status":{"maximum":599,"minimum":100,"type":"integer","format":"int32","enum":[429]},"title":{"type":"string"},"type":{"type":"string","format":"uri-reference"}}}},"responses":{"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsProblemDetail"}}},"description":"The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.","headers":{"Retry-After":{"description":"The number of seconds until the rate limiting resets.","schema":{"minimum":0,"type":"integer","format":"int32"}}}}}},"paths":{"/api/v1/initiatives/{cid}":{"put":{"description":"Update an Initiative.\n\nAPI key must have the `Edit Initiative` permission.","operationId":"updateInitiative","parameters":[{"in":"path","name":"cid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiativeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative"}}},"description":"Successfully updated Initiative"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Initiative not found"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an Initiative","tags":["Initiatives"]}}}}
```

## DELETE /api/v1/initiatives/{cid}

> Delete Initiative

```json
{"openapi":"3.0.1","info":{"title":"Cortex API","version":"v1"},"tags":[{"name":"Initiatives"}],"servers":[{"url":"https://api.getcortexapp.com","description":"Cortex Cloud API host"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"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.","scheme":"bearer","type":"http"}},"schemas":{"ErrorResponse":{"required":["message","type"],"type":"object","properties":{"details":{"type":"string"},"errorCode":{"type":"string"},"gatewayHttpStatus":{"type":"integer","format":"int32"},"httpStatus":{"type":"integer","format":"int32"},"message":{"type":"string"},"requestId":{"type":"string"},"type":{"type":"string","enum":["INTEGRATION_MISSING","INTEGRATION_UNREGISTERED","INTEGRATION_UNSUPPORTED","INTEGRATION_GRAPHQL_ERROR","INTEGRATION_BAD_REQUEST","INTEGRATION_UNAUTHORIZED","INTEGRATION_FORBIDDEN","INTEGRATION_NOT_FOUND","INTEGRATION_UNPROCESSABLE_CONTENT","INTEGRATION_RATE_LIMITED","INTEGRATION_INTERNAL_ERROR","INTEGRATION_NOT_IMPLEMENTED","INTEGRATION_BAD_GATEWAY","INTEGRATION_UNAVAILABLE","INTEGRATION_GATEWAY_TIMEOUT","INTEGRATION_TIMED_OUT","INTEGRATION_CACHE_ERROR","INTEGRATION_UNHANDLED_HTTP_ERROR","INTEGRATION_UNHANDLED_EXCEPTION","INTEGRATION_UNEXPECTED_ERROR","ILLEGAL_ARGUMENT_ERROR","BAD_REQUEST","FORBIDDEN","NOT_FOUND","REQUEST_TIMEOUT","CONFLICT","UNHANDLED_EXCEPTION","UNCATEGORIZED","SERVICE_CREATOR","UNKNOWN_HOST","TOO_MANY_REQUESTS"]}}},"TooManyRequestsProblemDetail":{"required":["type","title","status"],"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"retryAfter":{"minimum":0,"type":"integer","description":"The number of seconds until the rate limiting resets.","format":"int32"},"status":{"maximum":599,"minimum":100,"type":"integer","format":"int32","enum":[429]},"title":{"type":"string"},"type":{"type":"string","format":"uri-reference"}}}},"responses":{"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsProblemDetail"}}},"description":"The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.","headers":{"Retry-After":{"description":"The number of seconds until the rate limiting resets.","schema":{"minimum":0,"type":"integer","format":"int32"}}}}}},"paths":{"/api/v1/initiatives/{cid}":{"delete":{"operationId":"deleteInitiative","parameters":[{"in":"path","name":"cid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted Initiative"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Initiative not found"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete Initiative","tags":["Initiatives"]}}}}
```