Update Briefing Schedule

Update an existing briefing. All fields are optional.

PATCH /v1/briefings/{id}

Update Briefing

cURL

curl --request PATCH \
  --url https://api.eu.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,
  "organization_id": "<string>",
  "user_id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>"
}
'

200

{
  "error": {},
  "payload": {
    "id": "<string>",
    "title": "<string>",
    "topic": "<string>",
    "tickers": [
      "<string>"
    ],
    "language": "<string>",
    "scheduled_time": "<string>",
    "timezone": "<string>",
    "frequency": "daily",
    "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>"
  }
}

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
}

Omitting a field leaves it unchanged. Sending null does not clear a field — for example, a linked watchlist group cannot currently be unlinked via this endpoint, and language: null does not reset an already-set language.

Field Reference

Field	Type	Description
topic	string	Briefing instructions
stock_ids	string[]	Internal stock UUIDs (preferred)
tickers	string[]	Ticker symbols (auto-resolved)
language	string | null	Output language (null = auto-detect; see note above)
scheduled_time	string	h:mm AM/PM format
timezone	string	IANA timezone (e.g. America/New_York)
frequency	string	daily, weekly, or monthly
scheduled_day_of_week	integer	0 (Sun) – 6 (Sat), for weekly
scheduled_day_of_month	integer	1–31, for monthly
title	string	Custom briefing title
source_type	string	tfs_only, rms_only, or both
attach_pdf	boolean	Attach PDF to delivery email
is_active	boolean	Enable/disable the schedule
rms_sources	object[]	RMS source configs (source, workspace)
watchlist_group_id	string	Watchlist group ID to link (unlink via null not supported)
use_custom_email_title	boolean	Use title as fixed email subject
user_id	string	Platform (EDS) keys only: target user’s customer_id
user_email	string	Platform (EDS) keys only: target user’s email
user_name	string	Platform (EDS) keys only: display name (used when creating)

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

Show child attributes

watchlist_group_id · string | null

Watchlist group ID to link for dynamic ticker sync. Note: unlinking by sending null is not currently supported.

use_custom_email_title · boolean

Use title as fixed email subject

organization_id · string

Platform (EDS) keys only: org UUID under the key's platform. Ignored by org-bound keys.

user_id · string

Platform (EDS) keys only: the target user's customer_id (your external user id, not a UUID). Ignored by org-bound keys.

user_email · string

Platform (EDS) keys only: the target user's email. Ignored by org-bound keys.

user_name · string

Platform (EDS) keys only: optional display name (used only when creating the user).

Response

200 - application/json

Briefing updated

error · object | null

payload · object

Show child attributes