Introduction

This section documents Programs management.

Navigate here to see member-related section.

Program model

Example

{
    "id": 4,
    "type": null,
    "name": { "en": "Program 1" },
    "description": { "en": "Program 1" },
    "terms_and_conditions": { "en": "Lorem Ipsum" },
    "joinable_by_member": true,
    "leavable_by_member": true,
    "registration_message_id": 423,
    "members_group_id": 11,
    "members_count": 15,
    "created_at": "2022-07-14T19:59:34.721853Z",
    "updated_at": "2022-07-14T20:02:43.067472Z",
    "subscription_target_url: "https://url.com"
}

Definition

Key	Type	Static?	Required?	Default	Description
id	integer	yes	yes
type	enum: `['newsletter']`	no	no
name	LocalizedContent	no	yes
description	LocalizedContent	no	no
terms_and_conditions	LocalizedContent	no	no
leavable_by_member	boolean	no	no	true	Can member leave the program by himself?
leavable_by_member	boolean	no	no	true	Can member leave the program by himself?
registration_message_id	integer	no	no		ID of Message that should be sent during registration
members_group_id	integer	yes	yes		ID of Member group associated with the program
members_count	integer	yes	yes		Number of members in a program ([group])
created_at	datetime	yes	yes
updated_at	datetime	yes	yes
subscription_program_url	string	no	no		The url on which redirection will be made after program registration

Program model#

Example#

Definition#

Program model

Example

Definition