HEhexclave
Teams

Update a team

Changed on

Update the team information. Only allowed if the current user is a member of the team and has the $update_team permission.

patch/teams/{team_id}

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/teams/{team_id}
  • Auth
    none declared

Path parameters

team_idstring required

Request body

display_namestring

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

profile_image_url'null' nullable

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_metadataobject nullable

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

Example request

{
  "display_name": "My Team",
  "profile_image_url": "https://example.com/image.jpg",
  "client_metadata": {
    "key": "value"
  }
}

Response

Successful response

idstring required

The unique identifier of the team

display_namestring required

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

profile_image_url'null' nullable

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_metadataobject nullable

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_metadataobject nullable

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.

Example response

{
  "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
  "display_name": "My Team",
  "profile_image_url": "https://example.com/image.jpg",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  }
}

Changes

  • fc669d833a13Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      added the new undefined enum value to the response property for the response status

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the new undefined enum value to the request property