GOgorgias
Teams

Create a team

Changed on
post/api/teams

Request

Request body

namestring required

Name of the team.

descriptionstring nullable

Longer description of the team.

default_email_integration_idinteger nullable

Configured default email integration ID for the team. Null means no team preference. Non-null values in create/update requests must reference an active email integration on the same account that can send email; otherwise the request returns HTTP 400. Responses retain the configured ID even if the integration becomes unavailable.

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.

default_email_integration_idinteger nullable

Configured default email integration ID for the team. Null means no team preference. Non-null values in create/update requests must reference an active email integration on the same account that can send email; otherwise the request returns HTTP 400. Responses retain the configured ID even if the integration becomes unavailable.

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": {}
    }
  ]
}

Changes

  • 3fdfcb5b6678Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status