curl --request POST \
--url https://schoolmaker.co/api/v1/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lesson_id": "LESSON_ID",
"title": "Practice",
"action_type": "input_text",
"is_optional": true,
"miscellaneous_input_text_action_type": "Your answer"
}
'{
"id": "00000000-0000-4000-8000-000000000002",
"lesson_id": "00000000-0000-4000-8000-000000000003",
"title": "Steps HTTP basic",
"position": 2,
"action_type": "basic",
"is_optional": true,
"is_published": true,
"min_duration": null,
"max_duration": null,
"description": "<div class=\"trix-content lexxy-content\" data-controller=\"add-target-blank-to-links\">\n <p><strong>Imported</strong></p><!-- schoolmaker-lexxy-content -->\n</div>\n",
"form_description": "",
"reviewer_ids": [
"00000000-0000-4000-8000-000000000001"
],
"unlock_badge_id": null,
"miscellaneous_permanent_action_type": null,
"miscellaneous_link_action_type": null,
"miscellaneous_input_text_action_type": "Fill the field below",
"miscellaneous_textarea_action_type": "Fill the field below",
"miscellaneous_post_action_type": null,
"miscellaneous_topic_action_type": null,
"miscellaneous_topic_title_option": null,
"miscellaneous_milestone_requires_review_option": false,
"miscellaneous_milestone_action_type": "file_upload",
"miscellaneous_milestone_text_proof_label_option": "Fill the field below",
"optional_topic_post_body_template": "",
"miscellaneous_milestone_triggers_testimonial_toggle_option": null,
"miscellaneous_milestone_triggers_testimonial_text_option": "Congrats on reaching that big milestone! It's the perfect time to leave a testimonial and tell us how you did it\n",
"miscellaneous_accept_rich_text_option": null,
"miscellaneous_title_form": null,
"miscellaneous_display_type_form": "step_by_step"
}Create a Step
Creates a step in a lesson. New steps are unpublished and required by default.
curl --request POST \
--url https://schoolmaker.co/api/v1/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lesson_id": "LESSON_ID",
"title": "Practice",
"action_type": "input_text",
"is_optional": true,
"miscellaneous_input_text_action_type": "Your answer"
}
'{
"id": "00000000-0000-4000-8000-000000000002",
"lesson_id": "00000000-0000-4000-8000-000000000003",
"title": "Steps HTTP basic",
"position": 2,
"action_type": "basic",
"is_optional": true,
"is_published": true,
"min_duration": null,
"max_duration": null,
"description": "<div class=\"trix-content lexxy-content\" data-controller=\"add-target-blank-to-links\">\n <p><strong>Imported</strong></p><!-- schoolmaker-lexxy-content -->\n</div>\n",
"form_description": "",
"reviewer_ids": [
"00000000-0000-4000-8000-000000000001"
],
"unlock_badge_id": null,
"miscellaneous_permanent_action_type": null,
"miscellaneous_link_action_type": null,
"miscellaneous_input_text_action_type": "Fill the field below",
"miscellaneous_textarea_action_type": "Fill the field below",
"miscellaneous_post_action_type": null,
"miscellaneous_topic_action_type": null,
"miscellaneous_topic_title_option": null,
"miscellaneous_milestone_requires_review_option": false,
"miscellaneous_milestone_action_type": "file_upload",
"miscellaneous_milestone_text_proof_label_option": "Fill the field below",
"optional_topic_post_body_template": "",
"miscellaneous_milestone_triggers_testimonial_toggle_option": null,
"miscellaneous_milestone_triggers_testimonial_text_option": "Congrats on reaching that big milestone! It's the perfect time to leave a testimonial and tell us how you did it\n",
"miscellaneous_accept_rich_text_option": null,
"miscellaneous_title_form": null,
"miscellaneous_display_type_form": "step_by_step"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- Option 1
- Option 2
1 - 255Step title. Required on creation and cannot be blank. Maximum 255 characters.
1 - 255Position within the lesson, starting at 1. Defaults to the end on creation or when moving to another lesson. Moving a step shifts the other steps.
x >= 1Rich text content. Send null to clear it. Scripts, embedded content and signed attachment markup are not accepted.
200000Format of description, form_description and optional_topic_post_body_template. Defaults to HTML. Returned content is HTML. Quiz and form field descriptions accept HTML. For blockquotes, use HTML.
html, markdown, null 200000Quiz settings, questions and answers. Existing IDs must belong to this quiz. Omitted questions and answers stay unchanged. Send _destroy=true to delete one. Quiz editing is unavailable while question generation is in progress.
Show child attributes
Show child attributes
Fields for a form step, up to 50 per request. Existing field IDs must belong to this step and option IDs to their field. Omitted fields stay unchanged. Send _destroy=true to delete one.
50Show child attributes
Show child attributes
Rich text content. Send null to clear it. Scripts, embedded content and signed attachment markup are not accepted.
200000Whether the step is published. Defaults to false. Send true or false on update. Null is accepted only on creation.
Setting not shown in the current step editor.
x >= 0Setting not shown in the current step editor.
x >= 0Whether the step is optional. Defaults to false. Optional steps do not count toward progression. A lesson containing only optional steps does not lock the next lesson. Send true or false on update. Null is accepted only on creation.
Step type. Defaults to basic and cannot be changed after creation.
basic, input_text, textarea, link, quiz, post, topic, milestone, file_upload, form, null 200000Staff user IDs who manually validate this step. Applies to steps that support review. Send [] to use the program's default reviewers. The response lists the reviewers who apply.
1001 - 255Badge ID awarded when a member completes this milestone. Members can display the badge on their community profile. Send null to remove it.
200000Setting not shown in the current step editor.
Required HTTP(S) URL for a link step. Available variables: {{full_name}} or {{name}} {{first_name}} {{last_name}} {{email}} {{type}} (User or Member)
200000Input label for a text-line step. Defaults to the school language's standard label. Send null to restore it. An empty label is not accepted.
200000Input label for a text-paragraph step. Defaults to the school language's standard label. Send null to restore it. An empty label is not accepted.
200000Existing community post ID in this school for a reply step. Members need access to that space to complete it.
200000Existing community space/category ID in this school for a create-post step. Members need access to that space to complete it.
200000Prefilled title for the community post members create in a topic step.
200000Require members to provide proof before this milestone can be validated. Defaults to false.
Milestone proof type. Defaults to file_upload. Set miscellaneous_milestone_requires_review_option to true to require proof.
file_upload, text, none, null 200000Label for milestone text proof. Send null to restore the school language's default label.
200000Prefilled body for a community post created from this step. Send null to clear it. Scripts, embedded content and signed attachment markup are not accepted.
200000Ask for a testimonial when a member completes this milestone. Requires Smart Testimonials to be enabled.
Text of the testimonial request. Requires Smart Testimonials to be enabled. Send null to restore the school language's default text.
200000Allow formatted answers for a text-paragraph step or milestone text proof. Send null to turn it off.
Heading inside the form, separate from the step title.
200000Show form questions one at a time or all together. Defaults to step_by_step.
step_by_step, all, null 200000Response
Successful request.
basic, input_text, textarea, link, quiz, post, topic, milestone, file_upload, form Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?