Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
profiles

Update profile settings

Update the authenticated user's profile settings.

Supports:

  • is_public: Toggle profile visibility (public/private)
  • description: Set profile bio (max 280 characters, empty string clears it)

The response includes:

  • is_profile_public: Current visibility state after the update
  • description: Current profile bio
  • profile_url: Public profile URL (null if the account has no handle)

Authentication: Authorization: Bearer <CLIENT_JWT>

patch/v1/account/profile

Headers

authorizationstring nullable

Bearer JWT issued by Grove that identifies the account.

Bearer JWT issued by Grove that identifies the account.

Request body

is_publicboolean nullable

Whether profile is publicly visible

descriptionstring nullable

Profile bio (max 280 characters)

tip_to_talk_minnumber nullable

Minimum tip in USD to accept paid messages (Tip to Talk). 0 = accept any amount. >= 0.01 = require at least that amount. Use tip_to_talk_enabled=false to disable entirely.

tip_to_talk_enabledboolean nullable

Set to false to disable paid messages (opt out). Set to true to (re-)enable.

webhook_urlstring nullable

HTTPS URL for stream alert webhooks. Paid messages (tip-to-talk) will be POSTed to this endpoint in real time. Set to empty string to disable.

tip_button_labelstring nullable

CTA label for the tip button on the profile page. Allowed values: buy_coffee, donate, fund, share_the_love, subscribe, support, tip. Feed/content contexts always show 'Tip' regardless of this setting.

Example request

{
  "theme": {
    "accent_color": "#4CAF50",
    "preset": "dark"
  }
}

Response

Successful Response

is_profile_publicboolean required

Current profile visibility setting

descriptionstring nullable

Profile bio (max 280 characters)

profile_urlstring nullable

Public profile URL if handle is set

tip_to_talk_minnumber nullable

Minimum tip in USD for paid messages (Tip to Talk). NULL = disabled.

webhook_configuredboolean

Whether a stream alert webhook is configured.

streamlabs_connectedboolean

Whether a Streamlabs account is connected for stream alerts.

tip_button_labelstring

CTA label for the tip button on the profile page.

Example response

{
  "theme": {
    "accent_color": "#4CAF50",
    "preset": "dark"
  }
}