Section Object


A section groups related steps within an online program.

Sections have no separate draft or publish lifecycle. They can be reordered and made available after a delay counted from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced programs.

Properties
createdDatestringRead-onlyformat date-time

Date and time the section was created.


delayInDaysintegerminimum 0maximum 5000

Number of days before the section becomes available. The count starts from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced ones. Someone joining a scheduled program after it began may find several sections already open. Use 0 for a section available from the start.


descriptionDescription

Section title.


extendedFieldsExtendedFields

Custom field data for the section. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Section ID.


orderingnumberRead-only

Position rank used to order sections within a program. To reorder sections, call Move Section.


programIdstringRead-onlyformat GUIDimmutable

Program ID of the parent program. Provide it when creating a section. After creation, this value can't be changed.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the section is updated. To prevent conflicting changes, the current revision must be passed when updating the section.


totalStepsintegerRead-onlyformat int32

Total number of steps in the section.


updatedDatestringRead-onlyformat date-time

Date and time the section was last updated.

Did this help?