Channels

Update a channel's metadata

patch/api/v1/channels/{id}

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/channels/{id}
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: channels:write)

Path parameters

idstring required

channel ID

Request body

namestring
localestring
countrystring

2-letter country code

avatar_keystring

S3 key of the channel avatar

biostring nullable
cover_keystring

S3 key of the channel cover image

Response

Updated channel

idstring
namestring nullable
localestring nullable
business_idstring
usernamestring
countrystring nullable
avatar_urlstring nullable
biostring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.