List automation types

Responses

🟢200OK

text/plain

Automation types retrieved successfully

Body

array of:

automation_type

enum<string>

optional

Available values:

Campaign -

auto_clt_sub_signup_completed -

auto_clt_sub_signup_failed -

auto_clit_birthday -

auto_clt_sub_signup_link_generated -

auto_clt_invoice_created -

auto_clt_non_recurring_payment_received -

auto_clt_waiver_completed -

Feedback -

ClientRenewalReminder -

auto_clt_flagged_clt_at_risk -

ClientSubscriptionActivation -

auto_clt_password_reset_triggered -

RequestAccess -

ClientProspectCreation -

auto_clt_transferor_consent_request_initiated -

auto_clt_sales_return_created -

auto_clt_refund_processed -

Other -

auto_clt_tour_booked -

auto_clt_recurring_appt_booked -

auto_clt_recurring_appt_rescheduled -

auto_clt_recurring_appt_cancelled -

auto_clt_single_appt_rescheduled -

auto_clt_single_appt_booked -

auto_clt_single_appt_date -

auto_clt_single_appt_cancelled -

auto_clt_single_appt_marked_attended -

auto_clt_single_appt_marked_noshow -

auto_clt_sub_cancellation_date -

auto_clt_class_waitlist_spot_vacated -

auto_clt_trial_start_date -

auto_clt_sub_start_date -

auto_clt_sub_end_date -

auto_clt_membership_end_date -

auto_clt_membership_start_date -

auto_clt_newlead_created -

auto_clt_tour_marked_noshow -

auto_clt_sub_cancellation_requested -

auto_clt_trial_end_date -

auto_clt_trial_created -

auto_clt_abandoned_sub_signup -

auto_clt_low_risk_clt_arrived -

auto_clt_moderate_risk_clt_arrived -

auto_clt_high_risk_clt_arrived -

auto_clt_pending_cancellation_clt_arrived -

auto_clt_appointee_arrived -

auto_class_rescheduled -

auto_class_coach_substituted -

auto_class_cancelled -

auto_clt_class_booked -

auto_clt_class_session_date -

auto_clt_class_booking_cancelled -

auto_clt_recurring_payment_received -

auto_clt_recurring_payment_failed -

auto_clt_invoice_voided -

auto_clt_payment_voided -

auto_clt_sales_return_voided -

auto_clt_sub_freeze_created -

auto_clt_sub_freeze_start_date -

auto_clt_sub_freeze_end_date -

auto_clt_sub_freeze_voided -

auto_clt_sub_freeze_stopped -

auto_clt_sub_voided -

auto_clt_tour_scheduled_date -

auto_clt_repeat_enq_created -

auto_clt_class_marked_attended -

auto_clt_class_marked_noshow -

manage_clt_sub_link -

invoice_clear_balance_link -

auto_generate_and_send_member_password -

auto_clt_initiate_otp_for_saved_card -

auto_clt_non_recurring_payment_failed -

auto_sdr -

auto_clt_otp_for_login -

auto_clt_waiver_pending_reminder -

auto_clt_trial_onboarding -

Allowed values:

Campaignauto_clt_sub_signup_completedauto_clt_sub_signup_failedauto_clit_birthdayauto_clt_sub_signup_link_generatedauto_clt_invoice_createdauto_clt_non_recurring_payment_receivedauto_clt_waiver_completedFeedbackClientRenewalReminderauto_clt_flagged_clt_at_riskClientSubscriptionActivationauto_clt_password_reset_triggeredRequestAccessClientProspectCreationauto_clt_transferor_consent_request_initiatedauto_clt_sales_return_createdauto_clt_refund_processedOtherauto_clt_tour_bookedauto_clt_recurring_appt_bookedauto_clt_recurring_appt_rescheduledauto_clt_recurring_appt_cancelledauto_clt_single_appt_rescheduledauto_clt_single_appt_bookedauto_clt_single_appt_dateauto_clt_single_appt_cancelledauto_clt_single_appt_marked_attendedauto_clt_single_appt_marked_noshowauto_clt_sub_cancellation_dateauto_clt_class_waitlist_spot_vacatedauto_clt_trial_start_dateauto_clt_sub_start_dateauto_clt_sub_end_dateauto_clt_membership_end_dateauto_clt_membership_start_dateauto_clt_newlead_createdauto_clt_tour_marked_noshowauto_clt_sub_cancellation_requestedauto_clt_trial_end_dateauto_clt_trial_createdauto_clt_abandoned_sub_signupauto_clt_low_risk_clt_arrivedauto_clt_moderate_risk_clt_arrivedauto_clt_high_risk_clt_arrivedauto_clt_pending_cancellation_clt_arrivedauto_clt_appointee_arrivedauto_class_rescheduledauto_class_coach_substitutedauto_class_cancelledauto_clt_class_bookedauto_clt_class_session_dateauto_clt_class_booking_cancelledauto_clt_recurring_payment_receivedauto_clt_recurring_payment_failedauto_clt_invoice_voidedauto_clt_payment_voidedauto_clt_sales_return_voidedauto_clt_sub_freeze_createdauto_clt_sub_freeze_start_dateauto_clt_sub_freeze_end_dateauto_clt_sub_freeze_voidedauto_clt_sub_freeze_stoppedauto_clt_sub_voidedauto_clt_tour_scheduled_dateauto_clt_repeat_enq_createdauto_clt_class_marked_attendedauto_clt_class_marked_noshowmanage_clt_sub_linkinvoice_clear_balance_linkauto_generate_and_send_member_passwordauto_clt_initiate_otp_for_saved_cardauto_clt_non_recurring_payment_failedauto_sdrauto_clt_otp_for_loginauto_clt_waiver_pending_reminderauto_clt_trial_onboarding

automation_entities

array[string] | null

optional

automation_fields

array[object (FieldsInfo) {8}] | null

optional

table_name

string | null

optional

field_name

string | null

optional

column_type

string | null

optional

display_type

string | null

optional

isdefault

boolean

optional

ismandatory

boolean

optional

data_bind

array[object (GenericKeyValue) {3}] | null

optional

operators

array[object (RuleEntityOperator) {2}] | null

optional

variables_allowed

array[string] | null

optional

Allowed values:

TenantNameTenantEmailIdTenantMobileNoTenantAddressTenantUUIDClientIdClientNameClientEmailIdClientMobileNoClientMobileCountryCodeClientPromotionalNotificationChannelsAllowedClientPreferredLanguageClientRepIdClientLifeTimeValueClientStatusClientTotalOutstandingAmountClientSubStatusClientPasswordStaffNameStaffEmailIdStaffMobileNoSubscriptionIdSubscriptionUUIDSubscriptionNameSubscriptionRecurringAmountSubscriptionNextBillingDateSubscriptionStartDateSubscriptionEndDateSubscriptionMinimumCommitmentUntilSubscriptionCategoryPaymentAmountPaymentDateInvoiceAmountInvoiceBalanceAmountInvoiceSalesRepIdInvoiceUUIDInvoiceIssueDateInvoicePrefixInvoiceRetryDateInvoiceDunningStatusCurrencyClientWaiverURLProspectCreatedDateTransferShortLinkRecurringAppointmentStartDateRecurringAppointmentStartTimeRecurringAppointmentRuleRecurringAppointmentNewStartDateRecurringAppointmentNewStartTimeRecurringAppointmentOldStartDateRecurringAppointmentOldStartTimeAppointmentCoachNameAppointmentCategoryNameAppointmentOldStartDateTimeAppointmentNewStartDateTimeAppointmentStartDateTimeAppointmentAvailableSessionsAppointmentTotalSessionsCancellationScheduledDateReactivationURLPurchasePortalURLWebsiteURLClassNameClassDateClassTimeClassCoachNameClassCategoryNameClientMembershipIdClientMembershipStartDateClientMembershipEndDateClientMembershipNameProspectEffectiveIdProspectEffectiveDateShortLinkFullLinkClientsubscriptionCancelIsRevokedClientsubscriptionCancelScheduledDateClientsubscriptionCancelReasonClientsubscriptionCancelCreatedDateClientTrialStartDateClientTrialMaxTrialClassClientTrialMaxTrialApptClientTrialMaxTrialValidityClientTrialOwnerIdClientTrialOwnerNameClientTrialEndDateClientTrialURLFreezeStartdateFreezeEnddateFreezeStatusTourDateTourTimeTourPriorityTourTransactionLogDateTourTransactionOutcomeTourTransactionPriorityTourStaffIdPaymentTransactionLogFailedReasonPaymentTransactionLogRetryCountPaymentSalesRepIdRefundPaymentSalesRepIdSalesReturnSalesRepIdTaskAssignedToStaffIdAppointmentCoachIdClassCoachIdClientSubscriptionSalesRepIdClientMembershipSessionOwnerIdOTP

nature

enum<string>

optional

Available values:

Promotional -

Transactional -

Authentication -

Allowed values:

PromotionalTransactionalAuthentication

associatedStaffId

string | null

optional

automation_schedule_on

string | null

optional

automation_schedule_type

enum<string>

optional

Available values:

Day -

Hour -

Minute -

Allowed values:

DayHourMinute

automation_timings

array[string] | null

optional

Allowed values:

BeforeImmediateAfterSameDayNonAutomationBackendImmedidateBackendNonImmedidateCampaign

automation_default_view

array[string] | null

optional

Allowed values:

CalendarViewListView

clientNotificationChannelsAllowed

array[string] | null

optional

Allowed values:

NoneEmailSMSWhatsAppMobileNotificationDesktopTask

staffNotificationChannelsAllowed

array[string] | null

optional

Allowed values:

NoneEmailSMSWhatsAppMobileNotificationDesktopTask

friendly_name

string | null

optional

category

enum<string> <int32>

optional

Available values:

Sales -

Retention -

Backend_Event -

Billing_Payment -

Memberships_Subscriptions -

Appointments -

Classes -

Freeze -

Allowed values:

SalesRetentionBackend_EventBilling_PaymentMemberships_SubscriptionsAppointmentsClassesFreeze

description

string | null

optional

datasendingmode

enum<string> <int32>

optional

Available values:

Transactional -

Promotional -

Allowed values:

TransactionalPromotional

status

boolean

optional

Example

[
    {
        "automation_type": "Campaign",
        "automation_entities": [
            "string"
        ],
        "automation_fields": [
            {
                "table_name": "string",
                "field_name": "string",
                "column_type": "string",
                "display_type": "string",
                "isdefault": true,
                "ismandatory": true,
                "data_bind": [
                    {
                        "id": "string",
                        "primaryName": "string",
                        "secondaryName": "string"
                    }
                ],
                "operators": [
                    {
                        "value": "string",
                        "key": "string"
                    }
                ]
            }
        ],
        "variables_allowed": [
            "TenantName"
        ],
        "nature": "Promotional",
        "associatedStaffId": "string",
        "automation_schedule_on": "string",
        "automation_schedule_type": "Day",
        "automation_timings": [
            "Before"
        ],
        "automation_default_view": [
            "CalendarView"
        ],
        "clientNotificationChannelsAllowed": [
            "None"
        ],
        "staffNotificationChannelsAllowed": [
            "None"
        ],
        "friendly_name": "string",
        "category": "Sales",
        "description": "string",
        "datasendingmode": "Transactional",
        "status": true
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request

Request samples

Responses