Program Object


A program is an Online Programs course, challenge, or structured journey. Programs contain lifecycle state, public description, timeline, access rules, pricing, SEO, rewards, and summary information for their content.

Properties
categoryIdsArray <string>Read-onlyformat GUIDmaxItems 10

Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories.


contentSummaryContentSummaryRead-only

Read-only counts of content entities in the program.


createdDatestringRead-onlyformat date-time

Date and time the program was created.


descriptionDescription

Public-facing program title, details, and media.


extendedFieldsExtendedFields

Custom fields for apps that extend the Program entity.


idstringRead-onlyformat GUID

Program ID.


ownerUserIdstringRead-onlyformat GUID

ID of the site user who created the program.


priceMoney

Optional one-time payment price for joining the program.


restrictionsRestrictions

Program access, participation, and progression rules.


revisionstringRead-onlyformat int64

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


rewardsArray <Reward>maxItems 10

Rewards assigned to participants when they reach configured milestones.


seoSeo

SEO settings used for the program page.


shouldSendInvoiceboolean

Whether to send an invoice after a single-payment purchase. When false, the buyer receives a payment confirmation email instead.


socialGroupIdstringformat GUID

ID of the social group connected to the program, if one exists.


statusstringRead-only

statusUpdatedDatestringRead-onlyformat date-time

Date and time when status last changed.


timelineTimeline

Program timeline settings. Use this to configure self-paced or scheduled programs.


updatedDatestringRead-onlyformat date-time

Date and time the program was last updated.


videoStepsSettingsVideoStepsSettings

Settings that control how video steps behave in this program.

Did this help?