course_settings_apply
Changes menu, review, progress, display or appearance settings in the Course app (pApp C00007). Appearance and general settings are changed separately. Shows a preview first; the change runs only after confirmation. Called without confirmToken it previews and returns a confirmToken; repeating the same input with it executes once.
Inputs
| Field | Required here | Contract |
|---|---|---|
change |
Yes | object |
change.settings |
Yes | object |
change.settings.homeClassListLayout |
No | LIST_A, LIST_B, CARD, FOCUS_THUMBNAIL |
change.settings.homeClassListPrice |
No | HIDE_PRICE, LOWEST_PRICE, MONTHLY_PRICE |
change.settings.homeClassListMonthlyDivisor |
No | integer; minimum 2; maximum 12; Display divisor 2-12; requires MONTHLY_PRICE. Does not alter product prices or payment installments. |
change.settings.homeClassListRatingsVisible |
No | boolean |
change.settings.homeClassListHideRatingsBelow4 |
No | boolean |
change.settings.homeClassListRatingCountVisible |
No | boolean |
change.settings.classDetailLayout |
No | TABBAR_2COL_LEFT_INFO, VISUAL_TABBAR_INFO, VISUAL_TABBAR_2COL_LEFT_INFO, BASIC, VISUAL_BASIC |
change.settings.classDetailPrice |
No | HIDE_PRICE, LOWEST_PRICE, MONTHLY_PRICE |
change.settings.classDetailMonthlyDivisor |
No | integer; minimum 2; maximum 12; Display divisor 2-12; requires MONTHLY_PRICE. Does not alter product prices or payment installments. |
change.settings.classDetailRatingsVisible |
No | boolean |
change.settings.classDetailHideRatingsBelow4 |
No | boolean |
change.settings.classDetailRatingCountVisible |
No | boolean |
change.settings.homeTitle |
No | string; min length 1; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 1–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.myClassesTitle |
No | string; min length 1; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 1–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.bookmarksTitle |
No | string; min length 1; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 1–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.reviewsTitle |
No | string; min length 1; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 1–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.introductionTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.curriculumTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.discussionTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.noticesTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.studentNoticesTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.classReviewsTitle |
No | string; min length 2; max length 12; pattern ^[^<>'"/\\&=();]+$; Menu label, 2–12 characters; no < > ' " / \ & = ( ) ;. No automatic translation. |
change.settings.discussionVisible |
No | boolean |
change.settings.noticesVisible |
No | boolean |
change.settings.studentNoticesVisible |
No | boolean |
change.settings.reviewsEnabled |
No | boolean |
change.settings.reviewRatingsEnabled |
No | boolean |
change.settings.reviewSort |
No | SORT_BY_LATEST, SORT_BY_RATING |
change.settings.reviewProgressRequirement |
No | 1PERCENT, 10PERCENT, 100PERCENT; 1PERCENT is restricted to four original source channel codes; other channels support 10PERCENT or 100PERCENT. |
change.settings.sessionProtectionEnabled |
No | boolean |
change.settings.commentsVisible |
No | boolean |
change.settings.showEndDateHome |
No | boolean |
change.settings.showEndDateMyClasses |
No | boolean |
change.settings.showEndDateBookmarks |
No | boolean |
change.settings.showEndDateClassDetail |
No | boolean |
confirmToken |
No | string; pattern ^ct[a-f\d]{32}$; The confirmToken from this tool's preview result. Omit it to preview; repeat the same input with it to execute. |