POST https://api.eloomi.com/v3/course-categories
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 |
{
"customAttributes": {
"{key}": "string"
},
"name": {
"ae": "string",
"cz": "string",
"de": "string",
"dk": "string",
"es": "string",
"fi": "string",
"fr": "string",
"gb": "string",
"he": "string",
"hu": "string",
"id": "string",
"is": "string",
"it": "string",
"ko": "string",
"nl": "string",
"no": "string",
"pl": "string",
"ru": "string",
"se": "string",
"us": "string",
"zh-tw": "string"
},
"parent_id": "number"
}
Name | Example | Description | Additional |
---|---|---|---|
customAttributes | Optional | ||
customAttributes.{key} |
Can contain multiple keys. Exact names and values depend on platform |
Optional | |
name | Required | ||
name.ae |
The name of the category on when platform language is Arabic |
Optional | |
name.cz |
The name of the category on when platform language is Czech |
Optional | |
name.de |
The name of the category on when platform language is German |
Optional | |
name.dk |
The name of the category on when platform language is Danish |
Optional | |
name.es |
The name of the category on when platform language is Spanish |
Optional | |
name.fi |
The name of the category on when platform language is Finnish |
Optional | |
name.fr |
The name of the category on when platform language is French |
Optional | |
name.gb |
The name of the category on when platform language is British English |
Optional | |
name.he |
The name of the category on when platform language is Hebrew |
Optional | |
name.hu |
The name of the category on when platform language is Hungarian |
Optional | |
name.id |
The name of the category on when platform language is Bahasa |
Optional | |
name.is |
The name of the category on when platform language is Icelandish |
Optional | |
name.it |
The name of the category on when platform language is Italian |
Optional | |
name.ko |
The name of the category on when platform language is Korean |
Optional | |
name.nl |
The name of the category on when platform language is Dutch |
Optional | |
name.no |
The name of the category on when platform language is Norwegian |
Optional | |
name.pl |
The name of the category on when platform language is Polish |
Optional | |
name.ru |
The name of the category on when platform language is Russian |
Optional | |
name.se |
The name of the category on when platform language is Swedish |
Optional | |
name.us |
The name of the category on when platform language is American English |
Optional | |
name.zh-tw |
The name of the category on when platform language is Taiwanese |
Optional | |
parent_id | 2 |
eloomis id of the parent of this category |
Optional |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK Category created |
CourseSuccess |
400 | Bad Request Request contained invalid data |
GenericSuccess |
401 | Unauthorized Not allowed |
ErrorSuccess |