Update the team information. Only allowed if the current user is a member of the team and has the $update_team permission.
Path parameters
team_idstringRequired
Request
This endpoint expects an object.
display_namestringOptional
Human-readable team display name. This is not a unique identifier.
profile_image_urlstringOptional
URL of the profile image for team. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.
client_metadatamap from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
Response
This endpoint returns an object.
idstring
The unique identifier of this team
display_namestring
Human-readable team display name. This is not a unique identifier.
profile_image_urlstringOptional
URL of the profile image for team. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.
client_metadatamap from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
client_read_only_metadatamap from strings to anyOptional
Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.