TEtelgea
Teams

Create a new team

Creates a new team in your organization. Teams help organize users into logical groups for billing, access control, and reporting.

After creating a team, you can assign users to it and associate it with billing entities for billing allocation.

post/v1/teams

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

namestring required

Team name

emojistring

Emoji representing the team

costCodestring

Cost center code applied to all users in this team

userIdsstring[]

Existing user IDs to add to the team on creation

Example request

{
  "name": "Field Sales",
  "emoji": "🚀",
  "costCode": "IT 5000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Team created successfully. Returns the created team object including the auto-generated team ID.

idstring required

UUID of the created team.

Example response

{
  "id": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70"
}

Changes

No recorded changes to this operation across all 1 revision of this API.