v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Teams

Create a team

post/api/teams

Request body

namestring required

Name of the team.

descriptionstring nullable

Longer description of the team.

decorationobject nullable

Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team's name.

Example request

{
  "name": "Warehouse team",
  "members": [
    {
      "name": "Marie Curie",
      "email": "marie@gorgias.io",
      "meta": {}
    }
  ]
}

Response

The created team.

idinteger

ID of the team.

uristring

URI of the object (auto-generated)

namestring

Name of the team.

descriptionstring nullable

Longer description of the team.

decorationobject nullable

Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team's name.

created_datetimestring date-time nullable

When the team was created.

Example response

{
  "id": 123,
  "name": "Warehouse team",
  "members": [
    {
      "name": "Marie Curie",
      "email": "marie@gorgias.io",
      "meta": {}
    }
  ]
}