Create a Team.

Create a Team.

application/json

Request Body required

team object
Represents a Fixie Team.
displayName string
The display name for this team.
description string
The description for this team.
avatarUrl string
The URL of the avatar image for this team.
members object[]
The members of this Team.
Array [
user object
The user that is a member of this Team.
email string
The email address for this user.
fullName string
The name of the user. This is only used for display purposes.
avatarUrl string
The URL of the avatar image for this user.
apiToken string
The user's API token. This is only populated when a user accesses their own account information.
subscriptions object[]
The subscriptions for this user.
Array [
]
role object
The user's role on the Team.
isAdmin boolean
True if the user is an admin for the team.
]
subscriptions object[]
The subscriptions for this team.
Array [
]

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

team object
Represents a Fixie Team.
teamId string
The unique ID for this team.
This field should not be populated in client requests.
displayName string
The display name for this team.
description string
The description for this team.
avatarUrl string
The URL of the avatar image for this team.
members object[]
The members of this Team.
Array [
teamId string
The team ID.
user object
The user that is a member of this Team.
userId string
The unique user ID for this user.
This field should not be populated in client requests.
email string
The email address for this user.
fullName string
The name of the user. This is only used for display purposes.
avatarUrl string
The URL of the avatar image for this user.
created date-time
When this user was created.
This field should not be populated in client requests.
modified date-time
When this user was last modified.
This field should not be populated in client requests.
apiToken string
The user's API token. This is only populated when a user accesses their own account information.
lastLogin date-time
When this user last logged in.
This field should not be populated in client requests.
subscriptions object[]
The subscriptions for this user.
Array [
id string
The unique ID for this subscription.
type enum
Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]
The type of subscription this represents.
state enum
Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]
The state of this subscription.
description string
A description of this subscription.
created date-time
When this subscription was created. This may not represent when the subscription was active, due to backdating.
modified date-time
When this subscription was last modified.
startTime date-time
The timestamp when this subscription starts.
endTime date-time
The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.
]
role object
The user's role on the Team.
isAdmin boolean
True if the user is an admin for the team.
pending boolean
Whether the membership is pending acceptance of an invitation by the user.
created date-time
When this membership was created.
modified date-time
When this membership was last modified.
]
created date-time
When this team was created.
This field should not be populated in client requests.
modified date-time
When this team was last modified.
This field should not be populated in client requests.
subscriptions object[]
The subscriptions for this team.
Array [
id string
The unique ID for this subscription.
type enum
Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]
The type of subscription this represents.
state enum
Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]
The state of this subscription.
description string
A description of this subscription.
created date-time
When this subscription was created. This may not represent when the subscription was active, due to backdating.
modified date-time
When this subscription was last modified.
startTime date-time
The timestamp when this subscription starts.
endTime date-time
The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.
]

{
  "team": {
    "teamId": "string",
    "displayName": "string",
    "description": "string",
    "avatarUrl": "string",
    "members": [
      {
        "teamId": "string",
        "user": {
          "userId": "string",
          "email": "string",
          "fullName": "string",
          "avatarUrl": "string",
          "created": "2024-03-07T22:56:08.452Z",
          "modified": "2024-03-07T22:56:08.452Z",
          "apiToken": "string",
          "lastLogin": "2024-03-07T22:56:08.452Z",
          "subscriptions": [
            {
              "id": "string",
              "type": "SUBSCRIPTION_TYPE_UNSPECIFIED",
              "state": "SUBSCRIPTION_STATE_UNSPECIFIED",
              "description": "string",
              "created": "2024-03-07T22:56:08.452Z",
              "modified": "2024-03-07T22:56:08.452Z",
              "startTime": "2024-03-07T22:56:08.452Z",
              "endTime": "2024-03-07T22:56:08.452Z"
            }
          ]
        },
        "role": {
          "isAdmin": true
        },
        "pending": true,
        "created": "2024-03-07T22:56:08.452Z",
        "modified": "2024-03-07T22:56:08.452Z"
      }
    ],
    "created": "2024-03-07T22:56:08.452Z",
    "modified": "2024-03-07T22:56:08.452Z",
    "subscriptions": [
      {
        "id": "string",
        "type": "SUBSCRIPTION_TYPE_UNSPECIFIED",
        "state": "SUBSCRIPTION_STATE_UNSPECIFIED",
        "description": "string",
        "created": "2024-03-07T22:56:08.452Z",
        "modified": "2024-03-07T22:56:08.452Z",
        "startTime": "2024-03-07T22:56:08.452Z",
        "endTime": "2024-03-07T22:56:08.452Z"
      }
    ]
  }
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...