Skip to content
SupaCloud Docs
Select themeSelect language

put_api_settings_chat_accounts_platform_tldr

PUT
/api/settings/chat-accounts/{platform}/tldr
curl --request PUT \
  --url https://example.com/api/settings/chat-accounts/example/tldr \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
platform
required
string

Telegram | discord

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Toggle the task-TL;DR digest for a linked chat account.

object
enabled
required
boolean
Examplegenerated
{
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Toggle updated — returns {“updated”:bool}

Media typeapplication/json

{"updated": <bool>} — an update acknowledgement; updated is false when the row was a no-op (e.g. an already-read notification).

object
updated
required

Whether a row was updated.

boolean
Examplegenerated
{
  "updated": true
}

400

Section titled “400”

Unknown platform (not telegram | discord)

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}