Create a team

POST

Create a new team and optionally add the current user as a member.

Request

This endpoint expects an object.
display_namestringRequired

Human-readable team display name. This is not a unique identifier.

creator_user_idstringOptional

The ID of the creator of the team. If not specified, the user will not be added to the team. Can be either “me” or the ID of the user. Only used on the client side.

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

Successful response

idstring

The unique identifier of the 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.

Built with