Skip to main content
PATCH
/
v1
/
briefings
/
{id}
Update Briefing
curl --request PATCH \
  --url https://api.linqalpha.com/v1/briefings/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "topic": "<string>",
  "stock_ids": [
    "<string>"
  ],
  "tickers": [
    "<string>"
  ],
  "scheduled_time": "<string>",
  "timezone": "<string>",
  "scheduled_day_of_week": 3,
  "scheduled_day_of_month": 16,
  "title": "<string>",
  "attach_pdf": true,
  "is_active": true,
  "rms_sources": [
    {
      "source": "<string>",
      "workspace": "<string>"
    }
  ],
  "watchlist_group_id": "<string>",
  "use_custom_email_title": true
}
'
{
  "error": {},
  "payload": {
    "id": "<string>",
    "title": "<string>",
    "topic": "<string>",
    "tickers": [
      "<string>"
    ],
    "language": "<string>",
    "scheduled_time": "<string>",
    "timezone": "<string>",
    "scheduled_day_of_week": 123,
    "scheduled_day_of_month": 123,
    "next_delivery_at": "<string>",
    "is_active": true,
    "source_type": "<string>",
    "attach_pdf": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.linqalpha.com/llms.txt

Use this file to discover all available pages before exploring further.

Update an existing briefing schedule. All fields are optional — only include the fields you want to change.

​
Stock Selection

Same as Create Briefing: provide stock_ids (preferred) or tickers. Use the Map Tickers endpoint to convert ticker symbols to stock IDs.

​
Scheduled Time Format

Must be in 12-hour AM/PM format: "9:00 AM", "3:30 PM", "12:00 PM".

​
Partial Update

Only fields included in the request body will be updated. For example, to change only the schedule time: 
{
  "scheduled_time": "8:00 AM"
}
To deactivate a briefing without deleting it: 
{
  "is_active": false
}

​
Field Reference

FieldTypeDescription
topicstringBriefing instructions
stock_idsstring[]Internal stock UUIDs (preferred)
tickersstring[]Ticker symbols (auto-resolved)
languagestring | nullOutput language. null for auto-detect
scheduled_timestringh:mm AM/PM format
timezonestringIANA timezone (e.g. America/New_York)
frequencystringdaily, weekly, or monthly
scheduled_day_of_weekinteger0 (Sun) – 6 (Sat), for weekly
scheduled_day_of_monthinteger1–31, for monthly
titlestringCustom briefing title
source_typestringtfs_only, rms_only, or both
attach_pdfbooleanAttach PDF to delivery email
is_activebooleanEnable/disable the schedule

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Body

application/json

All fields are optional. Only include fields you want to change.

​
topic
string

Briefing instructions/topic

​
stock_ids
string[]

Internal stock UUIDs (preferred)

​
tickers
string[]

Ticker symbols (auto-resolved)

​
language
enum<string> | null

Output language (null = auto-detect)

Available options:
English,
Spanish,
French,
German,
Italian,
Portuguese,
Dutch,
Hindi,
Japanese,
Chinese,
Finnish,
Korean,
Polish,
Russian,
Turkish,
Ukrainian,
Vietnamese
​
scheduled_time
string

h:mm AM/PM format (e.g. '9:00 AM')

​
timezone
string

IANA timezone (e.g. Asia/Seoul)

​
frequency
enum<string>
Available options:
daily,
weekly,
monthly
​
scheduled_day_of_week
integer | null

0=Sun, 6=Sat

Required range: 0 <= x <= 6
​
scheduled_day_of_month
integer | null
Required range: 1 <= x <= 31
​
title
string | null

Custom briefing title

​
source_type
enum<string>
Available options:
tfs_only,
rms_only,
both
​
attach_pdf
boolean
​
is_active
boolean

Enable/disable the schedule

​
rms_sources
object[]

RMS source configurations

​
watchlist_group_id
string | null

Watchlist group ID (null to unlink)

​
use_custom_email_title
boolean

Use title as fixed email subject

Response

200 - application/json

Briefing updated

​
error
object
​
payload
object