Skip to content

docs: optional catalog_id on POST /api/emails leads the email with the value delta #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sweetmantech wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: optional catalog_id on POST /api/emails leads the email with the value delta #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions api-reference/openapi/accounts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3587,6 +3587,11 @@
"type": "string",
"description": "Chat ID to include a chat link in the email footer. Use [Create Chat](/api-reference/chat/create) to create one."
},
"catalog_id": {

@cubic-dev-ai cubic-dev-ai Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The description links to /api-reference/songs/catalog-valuations as a related endpoint, but that page doesn't exist yet in the repository. After this PR merges, users who click this link will see a 404 until the referenced endpoint documentation is added. Since the merge order places this PR first, consider either deferring the link until the endpoint page exists, adding a brief placeholder page, or noting the forward-reference risk so the follow-up PR is not missed.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/accounts.json, line 3590:

<comment>The description links to `/api-reference/songs/catalog-valuations` as a related endpoint, but that page doesn't exist yet in the repository. After this PR merges, users who click this link will see a 404 until the referenced endpoint documentation is added. Since the merge order places this PR first, consider either deferring the link until the endpoint page exists, adding a brief placeholder page, or noting the forward-reference risk so the follow-up PR is not missed.</comment>

<file context>
@@ -3587,6 +3587,11 @@
             "type": "string",
             "description": "Chat ID to include a chat link in the email footer. Use [Create Chat](/api-reference/chat/create) to create one."
           },
+          "catalog_id": {
+            "type": "string",
+            "format": "uuid",
</file context>

"type": "string",
"format": "uuid",
"description": "Optional catalog to lead the email with. When present, the subject is prefixed with the catalog's current estimated value and its signed change since the previous measurement, and a valuation hero block is prepended to the body. A catalog with a single measurement shows the value with a baseline note instead of a change; a catalog the account does not own, or one with no measurements, leaves the email unchanged. Read the underlying series with [Get Catalog Valuations](/api-reference/songs/catalog-valuations)."
},
"account_id": {
"type": "string",
"format": "uuid",
Expand Down