eloomi v3 docs: Update a course

Request

PATCH https://api.eloomi.com/v3/courses/{courseId}

Path parameters

Parameter name	Value	Description	Additional
courseId	string	eloomis ID for the course	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

{
    "active": "integer",
    "customAttributes": {
        "{key}": "string"
    },
    "description": "string",
    "expected_duration": "number",
    "name": "string",
    "points": "number",
    "price": "string",
    "reference_number": "string",
    "reward": "number",
    "type": "string"
}

Properties

Name	Example	Description	Additional
active		Flag to indicate if the course is active Possible values are: `%!s(float64=0)` `%!s(float64=1)`	Optional
customAttributes			Optional
customAttributes.{key}		Can contain multiple keys. Exact names and values depend on platform	Optional
description	"Short course on how to be GDPR compliant"	A description of the course	Optional
expected_duration	115	Expected time to finish the course in minutes	Optional
name	"GDPR Compliance"	Course name as it appears in eloomi	Required
points	25	The amount of points a user gets upon course completion	Optional
price		The price of the course if applicable	Optional
reference_number		A reference number of the course	Optional
reward	1	A flag that indicates whether or not points are enabled for this course Possible values are: `%!s(float64=0)` `%!s(float64=1)`	Optional
type		Type of course. `Offline` is called onsite in the eloomi platform Possible values are: `online` `offline` `webinar`	Optional

Response

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

Status code	Description	Resource
200	OK Course updated	CourseSuccess
400	Bad Request Invalid input	GenericSuccess
401	Unauthorized Not allowed	ErrorSuccess