Create Briefing Schedule

Create Briefing

curl --request POST \
  --url https://api.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>"
}
'

import requests

url = "https://api.linqalpha.com/v1/briefings"

payload = {
    "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>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.linqalpha.com/v1/briefings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linqalpha.com/v1/briefings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linqalpha.com/v1/briefings"

	payload := strings.NewReader("{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linqalpha.com/v1/briefings")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linqalpha.com/v1/briefings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "ENDPOINT_NOT_ENABLED",
    "msg": "This endpoint is not enabled for your organization (public_api_briefing_management). Contact LinqAlpha to enable it.",
    "message": "This endpoint is not enabled for your organization (public_api_briefing_management). Contact LinqAlpha to enable it."
  },
  "payload": null
}

POST

briefings

Create Briefing

curl --request POST \
  --url https://api.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>"
}
'

import requests

url = "https://api.linqalpha.com/v1/briefings"

payload = {
    "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>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.linqalpha.com/v1/briefings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linqalpha.com/v1/briefings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linqalpha.com/v1/briefings"

	payload := strings.NewReader("{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linqalpha.com/v1/briefings")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linqalpha.com/v1/briefings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"topic\": \"<string>\",\n  \"scheduled_time\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"frequency\": \"daily\",\n  \"scheduled_day_of_week\": 3,\n  \"scheduled_day_of_month\": 16,\n  \"title\": \"<string>\",\n  \"source_type\": \"tfs_only\",\n  \"attach_pdf\": false,\n  \"is_active\": true,\n  \"rms_sources\": [\n    {\n      \"source\": \"<string>\",\n      \"workspace\": \"<string>\"\n    }\n  ],\n  \"watchlist_group_id\": \"<string>\",\n  \"use_custom_email_title\": false,\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "ENDPOINT_NOT_ENABLED",
    "msg": "This endpoint is not enabled for your organization (public_api_briefing_management). Contact LinqAlpha to enable it.",
    "message": "This endpoint is not enabled for your organization (public_api_briefing_management). Contact LinqAlpha to enable it."
  },
  "payload": null
}

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

Briefing created

error

object | null

payload

object

Show child attributes

MCP

Basic

Analytics V2

Transcriptions

Evaluations

RMS (On request)

Briefing

Sync Status

Meeting Agent

Stock Selection

Scheduled Time Format

Timezone

Language

Authentication

Authorizations

Body

Response

​Stock Selection

​Scheduled Time Format

​Timezone

​Language

​Authentication

Authorizations

Body

Response

Stock Selection

Scheduled Time Format

Timezone

Language

Authentication