Embark on a journey of dynamic check-in management with the PATCH /checkins/{checkin-uuid}/
endpoint. This feature empowers you to effortlessly update and tailor check-ins based on their unique identifiers, providing unparalleled flexibility in optimizing your team's engagement.
Understanding the Endpoint:
-
Path:
/checkins/{checkin-uuid}/
- Method: PATCH
Body Parameters:
- name: Check-in name.
- template: UUID of the template for updating the check-in.
- active: Indicates if the check-in is active.
- is_anonymous: Indicates if the check-in is anonymous.
- send_reports_one_by_one: Indicates if the check-in will be sent one by one as they get completed.
- use_user_defined_work_days: Indicates if the check-in uses user-defined workdays.
- start_on: Date (formatted YYYY-MM-dd) when the check-in will start running.
- allow_edit_permissions: Defines who can edit the check-in settings.
- can_be_edited: Indicates if the check-in could be edited.
- reporting_metadata: List of channels where the check-in will be sent.
- custom_trigger_time: Custom trigger time for the check-in, overriding users' work start time.
- reminders_max_count: Defines the total additional reminders to send for the check-in.
- reminders_trigger_condition: Mode to send additional reminders (smart_frequency or fixed_frequency).
- reminders_frequency_time: Intervals of time in minutes to send additional reminders.
- frequency: Weekly frequency to trigger automatic reminders.
- frequency_on_days: Days of the week to send automatic reminders.
- end_on: Date when the check-in will be finished.
- is_trigger_based: If active, the check-in will not receive future automatic reminders.
- custom_template_intro: Custom intro message for the check-in.
- 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
}
Comments
0 comments
Article is closed for comments.