Request

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

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

{
    "programs": [
        {
            "is_required": "boolean",
            "notify_users": "boolean",
            "program_id": "integer"
        }
    ]
}

Properties

Name Example Description Additional
programs[] Optional
programs[].is_required true

Should the program be assigned as required

Optional
programs[].notify_users false

Should users be notified when being assigned to this program

Optional
programs[].program_id 90092

eloomis internal id for the program

Optional

Response

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

Status code Description Resource
200 OK

Programs are queued

TeamStatusOnlyResponse
400 Bad Request

Request contained invalid data

GenericSuccess
401 Unauthorized

Not allowed

ErrorSuccess