Skip to main content
PATCH
Update a strategy's metadata or companies

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
required

UUID of the user strategy

Body

application/json

The updated name, objective, or exclusions of the strategy

name
string
objective
string
exclusions
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"

objective
string
required

The investment objective the strategy was built from.

Example:

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

created_at
string
required

Timestamp when the strategy was created (RFC 7231 HTTP-date string).

Example:

"Sat, 05 Apr 2025 17:43:37 GMT"

updated_at
string
required

Timestamp when the strategy was last updated (RFC 7231 HTTP-date string).

Example:

"Mon, 07 Apr 2025 18:39:41 GMT"

public
boolean
required

Whether the strategy is visible to other users.

Example:

true

growth
number<float> | null
required
deprecated

Revenue growth of the companies in this strategy.

Example:

0.1350849124986786

status
integer
required

Generation progress as a percentage. Reaches 100 when generation has finished, and is negative when a run has failed.

Example:

100

tags
string[]
required

User-defined tags for the strategy.

Example:
exchanges
string[] | null
required

When set, restricts the strategy to companies listed on these exchanges.

limit
integer | null
required

Maximum number of companies the strategy may contain.

min_market_cap
number | null
required

Minimum market capitalization a company must have to be included.

max_market_cap
number | null
required

Maximum market capitalization a company may have to be included.

min_evidence_count
integer | null
required

Minimum number of supporting evidence pieces a company must have.

completed
boolean
required

Whether strategy generation has finished.

has_factsheet
boolean
required

Whether a factsheet is available for the strategy.

exclusions
string[]

Optional list of exclusions used to build the strategy.

gics_sectors
string[]

GICS sectors associated with the strategy.

metathemes
string[]

Metatheme identifiers associated with the strategy.

performance
object | null