Request

POST https://api.eloomi.com/v3/teams

Request headers

Parameter name Value Description Additional
ClientId string

Provided by eloomi

Required
Authorization string

Look in the documentation for the authentication endpoint on how to construct this

Required

Request body

{
    "custom_attributes": {
        "{key}": "string"
    },
    "description": "string",
    "employee_ids": [
        "string"
    ],
    "leader_ids": [
        "integer"
    ],
    "name": "string",
    "user_emails": [
        "string"
    ],
    "user_ids": [
        "integer"
    ]
}

Properties

Name Example Description Additional
custom_attributes Optional
custom_attributes.{key}

Can contain multiple keys. Exact names and values depend on platform

Optional
description "Band of villains working for good"

The description of the team

Optional
employee_ids[] [ "DS", "JK", "HQ" ]

The employee ids of the users in the team

Optional
leader_ids[] [ 1, 2, 3 ]

The eloomi ids of the team leaders

Optional
name "Suicide Squad"

The name of the team

Required
user_emails[] [ "desh@example.org", "smile@example.org", "checkers@example.org" ]

The emails the users in the team

Optional
user_ids[] [ 1, 2, 3 ]

The eloomi ids of the users in the team

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Team created

TeamSuccess
400 Bad Request

Request contained invalid data

GenericSuccess
401 Unauthorized

Not allowed

ErrorSuccess