Create Briefing Schedule

Create a new briefing with topic, tickers, and schedule in a single call.

POST /v1/briefings

Create Briefing

cURL

curl --request POST \
  --url https://api.eu.linqalpha.com/v1/briefings \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "topic": "<string>",
  "scheduled_time": "<string>",
  "timezone": "<string>",
  "stock_ids": [
    "<string>"
  ],
  "tickers": [
    "<string>"
  ],
  "frequency": "daily",
  "scheduled_day_of_week": 3,
  "scheduled_day_of_month": 16,
  "title": "<string>",
  "source_type": "tfs_only",
  "attach_pdf": false,
  "is_active": true,
  "rms_sources": [
    {
      "source": "<string>",
      "workspace": "<string>"
    }
  ],
  "watchlist_group_id": "<string>",
  "use_custom_email_title": false,
  "organization_id": "<string>",
  "user_id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>"
}
'

201

{
  "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>"
  }
}

Create a new briefing schedule with topic, tickers, and delivery timing in a single API call.

The briefing will be automatically generated and delivered via email at the scheduled time.

Stock Selection

You can specify stocks in two ways:

• stock_ids (recommended) — Internal stock UUIDs. Use the Map Tickers endpoint to convert ticker symbols to stock IDs first.
• tickers — Ticker symbols (e.g. ["AAPL", "MSFT"]). Automatically resolved to stock IDs via the ticker mapping service. If resolution fails, the request will return an error.

If both stock_ids and tickers are provided, stock_ids takes priority.

Scheduled Time Format

The scheduled_time field must be in 12-hour AM/PM format:

• "9:00 AM", "3:30 PM", "12:00 PM"

Timezone

Must be a valid IANA timezone identifier. Common examples:

Region	Timezone
Korea	Asia/Seoul
Hong Kong	Asia/Hong_Kong
China	Asia/Shanghai
Singapore	Asia/Singapore
Taiwan	Asia/Taipei
Japan	Asia/Tokyo
India	Asia/Calcutta
Indonesia	Asia/Jakarta
Malaysia	Asia/Kuala_Lumpur
Australia	Australia/Sydney
UK	Europe/London
US East	America/New_York
US West	America/Los_Angeles
US Central	America/Chicago
UTC	UTC

Language

Supported values: English, Spanish, French, German, Italian, Portuguese, Dutch, Hindi, Japanese, Chinese, Finnish, Korean, Polish, Russian, Turkish, Ukrainian, Vietnamese. Pass null for auto-detection.

Authentication

For platform API keys, you can optionally pass organization_id, user_id, user_email, and user_name in the request body to specify which user the briefing is created for.

Authorizations

X-API-KEY · string · header · required

Body

application/json

topic · string · required

Briefing instructions/topic

scheduled_time · string · required

Time in h:mm AM/PM format. Examples: '9:00 AM', '3:30 PM'

timezone · string · required

IANA timezone identifier (e.g. America/New_York, Asia/Seoul, Europe/London)

stock_ids · string[]

Internal stock UUIDs (preferred). Use /v1/map_tickers to convert ticker symbols.

tickers · string[]

Ticker symbols (e.g. AAPL, 9988.HK). Auto-resolved to stock_ids.

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

frequency · enum<string> · default: daily

Available options: daily, weekly, monthly

scheduled_day_of_week · integer

Day of week for weekly frequency (0=Sun, 1=Mon, ..., 6=Sat)

Required range: 0 <= x <= 6

scheduled_day_of_month · integer

Day of month for monthly frequency

Required range: 1 <= x <= 31

title · string

Custom briefing title (auto-generated if omitted)

source_type · enum<string> · default: tfs_only

Data source: tfs_only (news+filings), rms_only (uploaded documents), both

Available options: tfs_only, rms_only, both

attach_pdf · boolean · default: false

Attach briefing as PDF to delivery email

is_active · boolean · default: true

Enable/disable the schedule

rms_sources · object[]

RMS source configurations for storage-based briefing

Show child attributes

watchlist_group_id · string

Link to watchlist group for dynamic ticker sync

use_custom_email_title · boolean · default: false

Use briefing 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 (used to find or create the user). Ignored by org-bound keys.

user_name · string

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

Response

201 - application/json

Briefing created

error · object | null

payload · object

Show child attributes