POST /checkins/

Welcome to the world of seamless check-in management with the POST /checkins/ endpoint. This powerful feature allows you to effortlessly create check-ins based on specific templates, tailoring them to your team's unique needs.

Understanding the Endpoint:

• Path: /checkins/
• Method: POST

Body Parameters:

1. name (required): Check-in name.
2. template (required): UUID of the template for creating the check-in.
3. active: Indicates if the check-in is active.
4. is_anonymous: Indicates if the check-in is anonymous.
5. send_reports_one_by_one: Indicates if the check-in will be sent one by one as they get completed.
6. use_user_defined_work_days: Indicates if the check-in uses user-defined workdays.
7. start_on: Date (formatted YYYY-MM-dd) when the check-in will start running.
8. allow_edit_permissions: Defines who can edit the check-in settings.
9. can_be_edited: Indicates if the check-in could be edited.
10. reporting_metadata: List of channels where the check-in will be sent.
11. custom_trigger_time: Custom trigger time for the check-in, overriding users' work start time.
12. reminders_max_count: Defines the total additional reminders to send for the check-in.
13. reminders_trigger_condition: Mode to send additional reminders (smart_frequency or fixed_frequency).
14. reminders_frequency_time: Intervals of time in minutes to send additional reminders.
15. frequency: Weekly frequency to trigger automatic reminders.
16. frequency_on_days: Days of the week to send automatic reminders.
17. end_on: Date when the check-in will be finished.
18. is_trigger_based: If active, the check-in will not receive future automatic reminders.
19. custom_template_intro: Custom intro message for the check-in.
20. custom_template_outro: Custom outro message for the check-in.

Sample Response:

{
   "id": "91b292b3-29b2-4235-8103-321ed749db8d",
   "name": "Checkin created by API",
   "template": "bf322341-1262-42fa3-942a-0341d90883f6",
   "active": true,
   "is_anonymous": false,
   "send_reports_one_by_one": true,
   "use_user_defined_work_days": false,
   "time_for_report": null,
   "start_on": "2022-01-25",
   "privacy": "managers_and_members",
   "allow_edit_permission": "admins_managers_and_team_admins",
   "can_be_edited": true,
   "reporting_metadata": [
       {
           "type": "channel",
           "id": "channel_id",
           "name": "channel_name",
       },
   ],
   "custom_trigger_time": null,
   "reminders_max_count": 0,
   "reminders_frequency_time": 15,
   "reminders_trigger_condition": "smart_frequency",
   "frequency_type": "weekly",
   "frequency": 1,
   "frequency_on_days": [1,2,3,4,5],
   "end_on": null,
   "is_trigger_based": false,
   "custom_template_intro": "new intro message" | null,
   "custom_template_outro": "new outro message" | null
}