Request

PATCH https://api.eloomi.com/v3/teams/{teamId}

Path parameters

Parameter name Value Description Additional
teamId integer

Id of the required team

Required

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

{
    "add_course_ids": [
        "integer"
    ],
    "course_ids": {
        "{courseId}": {
            "deadline": "string",
            "required": "boolean"
        }
    },
    "custom_attributes": {
        "{key}": "string"
    },
    "description": "string",
    "employee_ids": [
        "string"
    ],
    "leader_ids": [
        "integer"
    ],
    "name": "string",
    "program_ids": {
        "{programId}": {
            "notify": "boolean",
            "required": "boolean"
        }
    },
    "remove_course_ids": [
        "integer"
    ],
    "user_emails": [
        "string"
    ],
    "user_ids": [
        "integer"
    ]
}

Properties

Name Example Description Additional
add_course_ids[] [ 2, 4 ]

IDs of the courses that should be added to the team

Optional
course_ids

IDs and configuration for the courses that should be associated with the team. This should include all information, and not just changes.

Optional
course_ids.{courseId} Optional
course_ids.{courseId}.deadline

The deadline for the course in format YYYY-MM-DD if applicable. Defaults to no deadline

Optional
course_ids.{courseId}.required

Flag to indicate if course should be required. Defaults to false.

Optional
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
program_ids

IDs and configuration for the programs that should be associated with the team. This should include all information, and not just changes.

Optional
program_ids.{programId} Optional
program_ids.{programId}.notify

Flag to indicate if notifications should be sent on assignments. Defaults to true.

Optional
program_ids.{programId}.required

Flag to indicate if course should be required. Defaults to false.

Optional
remove_course_ids[] [ 1, 3 ]

IDs of the courses that should be removed from the team

Optional
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