Admin APIs
tickers

Update Ticker

put/api/v1/admin/tickers/{ticker_id}

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/tickers/{ticker_id}
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

ticker_idstring required

Request body

messagestring nullable

Message content in Markdown format

priorityinteger nullable

Priority level (higher numbers = higher priority)

is_activeboolean nullable

Whether the ticker should be shown (active/inactive)

starts_atstring date-time nullable

Start time (ISO-8601), null = immediate

ends_atstring date-time nullable

End time (ISO-8601), null = indefinite

clientsstring[] nullable

Optional list of client IDs to target

Response

Successful Response

messagestring required

Message content in Markdown format

priorityinteger

Priority level (higher numbers = higher priority)

is_activeboolean

Whether the ticker should be shown (active/inactive)

starts_atstring date-time nullable

Start time (ISO-8601), null = immediate

ends_atstring date-time nullable

End time (ISO-8601), null = indefinite

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
created_bystring nullable required
clientsstring[] nullable

List of client IDs this ticker is assigned to

Changes

No recorded changes to this operation across all 4 revisions of this API.