API reference

API reference · Account

Turn Web Push or Telegram landing notices on or off

PUT/api/studio/noticesSigned in session

Either or both. The signed in account; same origin for a write.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
pushboolean
telegramboolean

Example

{
  "push": false,
  "telegram": false
}

Answer 200

The person's own switches.

Fields of the 200 answer
FieldTypeWhat it is
pushrequiredobjectWeb Push to the person's devices: available only while the operator set the VAPID variables; off until they turn it on.
push.availablerequiredboolean
push.onrequiredboolean
push.devicesrequiredinteger
telegramrequiredobjectThe person's linked Telegram chat: available only while the bot is configured and a chat is linked; on until they turn it off.
telegram.availablerequiredboolean
telegram.onrequiredboolean

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter