Skip to main content
PATCH
Update a strategy draft

Authorizations

Authorization
string
header
required

Enter 'Bearer' followed by a space and then your JWT or API Key. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... or Bearer YOUR_API_KEY_HERE

Path Parameters

strategyId
string<uuid>
required

UUID of the strategy.

Body

application/json

Fields to update on a strategy draft. Supply at least one of name, objective, exclusions, or tags.

name
string
objective
string
exclusions
string[]
tags
string[]

Response

The updated strategy.

A user-owned investment strategy.

id
string<uuid>
required
Example:

"83d88f60-f581-4176-bb5c-e0b463d1d442"

user_id
string
required
Example:

"auth0-5dba12a5654f067ba1234567"

name
string
required
Example:

"Electric Vehicles"

exclusions
string[]
required

Phrases used to exclude companies when building the strategy.

public
boolean
required

Whether the strategy is visible in the public catalog.

Example:

false

tags
string[]
required

User-defined tags for the strategy.

Example:
active_version_id
string<uuid> | null
required

The active, submitted version, or null when the strategy has never been submitted.

draft_version_id
string<uuid> | null
required

The saved version whose content matches the current draft, or null when no saved version matches it.

status
integer
required

Run status of the active version's latest live run. 0 means not started or never submitted, 1 through 95 means in progress, 100 means done, -1 means error, and -2 means permanently failed. For per-version and per-date detail, use GET /strategies/{strategyId}/versions/{versionId}.

completed
boolean
required

Whether the active version's latest live run is done, meaning status is 100.

metathemes
string<uuid>[]
required

Metatheme taxonomy group IDs that classify the strategy. Empty when the strategy is unclassified, and populated for the curated public catalog.

gics_sectors
string<uuid>[]
required

GICS sector taxonomy group IDs that classify the strategy. Empty when the strategy is unclassified, and populated for the curated public catalog.

performance
object | null
required

Sparkline performance, made up of a conviction-weighted NAV time series and summary metadata, or null when no sparkline has been computed yet.

archived_at
string<date-time> | null
required

ISO-8601 timestamp of when the strategy was archived, or null when not archived.

permanent_delete_at
string<date-time> | null
required

ISO-8601 timestamp of when an archived strategy is permanently deleted, which is 30 days after archived_at, or null when not archived.

created_at
string<date-time>
required

ISO-8601 timestamp of when the strategy was created.

updated_at
string<date-time> | null
required

ISO-8601 timestamp of when the strategy was last updated.

objective
string | null

The strategy's investment objective.

Example:

"The Electric Vehicles Investment Strategy is to identify companies that focus on EV manufacturing, plus the development of battery technology and charging station infrastructure.\n"