Payments

Get payments

Returns a list of payments that match the specified filters, including only the requested fields.

get/api/v1/purchase-payment

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/purchase-payment
  • Auth: API key in header Authorization

Query parameters

idstring

ID

excludeIdstring

Excluded ID

orderIdstring

::API.Modules.UserNotifications.UserNotification.OrderId::

orderStudentIdstring

ID of the contact who placed the order

additionalPaymentDatastring

Additional payment data

externalIdstring

::API.Modules.Imports.ExternalImportEntity.ExternalId::

refundPaymentIdstring

Refund payment ID

gatewayIdstring

Gateway ID

hasAdminboolean

Has admin

hasFeeboolean

Has fee

orderDeletedboolean

Order soft-deleted

hasPaymentDateboolean

Has payment date

hasUpdatedDateboolean

Has update date

isTestboolean

::API.Modules.SystemEmails.SystemEmailMessage.IsTest::

isPartnershipboolean

Affiliate program

isAutoPaymentboolean

Automatic payment

isBonusPaymentboolean

::API.Modules.Products.ProductPurchaseOrderPaymentFilter.IsBonusPayment::

subscriptionAction'trial' | 'trialUpgrade' | 'fullPurchase' | 'fullPurchaseUpdate'

Subscription action

dateFromstring date-time

::API.Modules.Advertising.AdSpendEntry.DateFrom::

dateTostring date-time

::API.Modules.Advertising.AdSpendEntry.DateTo::

amountFromnumber double

Amount from

amountTonumber double

Amount to

createdDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Creation date condition

createdDateFromstring date-time

Creation date from

createdDateTostring date-time

Creation date to

paymentDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Payment date condition

paymentDateFromstring date-time

Payment date from

paymentDateTostring date-time

Payment date to

type'money' | 'bonus'

::API.Modules.CustomDataFields.CustomDataField.Type::

status'pending' | 'waitingForCapture' | 'success' | 'canceled' | 'fail' | 'refund'

::API.Modules.Live.LiveRun.Status::

gatewayType'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay'

Gateway type

statusesstring[]

Statuses

productIdsstring[]

Product IDs

paymentGatewayIdsstring[]

Payment gateway IDs

paymentMethodCardDigitsstring

::API.Modules.Products.ProductPurchaseOrderPaymentFilter.PaymentMethodCardDigits::

needCurrencyExchangeboolean

Requires currency exchange

orderFilter.idstring

ID

orderFilter.excludeIdstring

Excluded ID

orderFilter.siteIdstring

Website ID

orderFilter.widgetIdstring

Widget ID

orderFilter.studentIdstring

Contact ID

orderFilter.siteGuestIdstring

Website visitor ID

orderFilter.siteSessionIdstring

Website session ID

orderFilter.sitePageIdstring

Website page ID

orderFilter.sitePageVariationTestIdstring

::API.Modules.Products.ProductPurchaseOrderFilter.SitePageVariationTestId::

orderFilter.sitePageVariationIdstring

::API.Modules.Products.ProductPurchaseOrderFilter.SitePageVariationId::

orderFilter.responsibleIdstring

Owner ID

orderFilter.parentIdstring

Parent order ID

orderFilter.renewalLicenseIdstring

Renewed license ID

orderFilter.containsProductIdstring

Contains product ID

orderFilter.pipelineItemIdstring

Deal ID

orderFilter.partnerIdstring

Affiliate ID

orderFilter.adminIdstring

Admin ID

orderFilter.numberinteger

Order number

orderFilter.fullyPaidboolean

Fully paid

orderFilter.hasAdminIdboolean

Has admin ID

orderFilter.completedboolean

Completed

orderFilter.isQuickboolean

Quick order

orderFilter.isPartnershipboolean

Affiliate order

orderFilter.hasRenewalLicenseIdboolean

Has renewal license ID

orderFilter.subscriptionAction'trial' | 'trialUpgrade' | 'fullPurchase' | 'fullPurchaseUpdate'

Subscription action

orderFilter.hasStudentIdboolean

Has contact ID

orderFilter.hasPaymentsboolean

Has payments

orderFilter.hasSuccessOrRefundPaymentsboolean

Has a successful or refunded payment

orderFilter.needCurrencyExchangeboolean

Requires currency conversion

orderFilter.forStudentInSchoolboolean

For Student Portal users

orderFilter.offSessionboolean

Off-session

orderFilter.hasOffSessionPaymentsboolean

Has off-session payments

orderFilter.studentOrSiteGuestboolean

Contact or website visitor

orderFilter.statusesstring[]

Statuses

orderFilter.productIdsstring[]

Product IDs

orderFilter.requiredProductIdsstring[]

Required product IDs

orderFilter.libraryIdsstring[]

Library IDs

orderFilter.courseIdsstring[]

Course IDs

orderFilter.coursePlanIdsstring[]

Course plan IDs

orderFilter.productPackageIdsstring[]

Product package IDs

orderFilter.flowIdsstring[]

Cohort IDs

orderFilter.tagIdsstring[]

Tag IDs

orderFilter.promocodeIdsstring[]

Promo code IDs

orderFilter.productCategoryIdsstring[]

Product category IDs

orderFilter.paymentGatewayIdsstring[]

Payment gateway IDs

orderFilter.responsibleIdsstring[]

Owner IDs

orderFilter.studentIdsstring[]

Contact IDs

orderFilter.partnerIdsstring[]

Affiliate IDs

orderFilter.adminIdsstring[]

Admin IDs

orderFilter.uTMCampaignstring[]

Ad campaign

orderFilter.uTMContentstring[]

Content

orderFilter.uTMMediumstring[]

Medium

orderFilter.uTMSourcestring[]

Traffic source

orderFilter.uTMTermstring[]

Keyword

orderFilter.createdDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Creation date condition

orderFilter.createdDateFromstring date-time

Date created from

orderFilter.createdDateTostring date-time

Date created to

orderFilter.purchasedDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Purchase date condition

orderFilter.purchasedDateFromstring date-time

Purchase date from

orderFilter.purchasedDateTostring date-time

Purchase date to

orderFilter.fullPurchasedDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Full payment date condition

orderFilter.fullPurchasedDateFromstring date-time

Full payment date from

orderFilter.fullPurchasedDateTostring date-time

Full payment date to

orderFilter.expirationDateCondition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

::API.Modules.Products.ProductPurchaseOrderFilter.ExpirationDateCondition::

orderFilter.expirationDateFromstring date-time

::API.Modules.Products.ProductPurchaseOrderFilter.ExpirationDateFrom::

orderFilter.expirationDateTostring date-time

::API.Modules.Products.ProductPurchaseOrderFilter.ExpirationDateTo::

orderFilter.createdDateMoreThanstring date-time

Created after

orderFilter.createdDateLessThanstring date-time

Created before

orderFilter.deletedDateLessThanstring date-time

Deleted before

orderFilter.amountFromnumber double

Minimum amount

orderFilter.amountTonumber double

Maximum amount

orderFilter.paidAmountFromnumber double

Minimum paid amount

orderFilter.paidAmountTonumber double

Maximum paid amount

orderFilter.paymentMethodCardDigitsstring

::API.Modules.Products.ProductPurchaseOrderFilter.PaymentMethodCardDigits::

orderFilter.hasUtmTag'source' | 'medium' | 'campaign' | 'term' | 'content'

Has UTM parameters

orderFilter.currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

orderFilter.excludeStatus'created' | 'checkoutData' | 'payment' | 'partiallyPaid' | 'paid' | 'preparingShipment' | 'shipped' | 'fulfilled' | 'canceled' | 'refund'

Exclude status

orderFilter.expiredboolean

Expired

orderFilter.hasPartnerIdboolean

Has affiliate ID

orderFilter.isDeletableboolean

Can be deleted

orderFilter.sortCustomField.idstring

ID

orderFilter.sortCustomField.type'text' | 'textArea' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date'

Sort type

idstring nullable

Unique ID

valuestring nullable

Value

condition'equals' | 'notEquals' | 'lessThan' | 'moreThan' | 'contains' | 'notContains' | 'specified' | 'notSpecified' | 'range' | 'today' | 'yesterday' | 'beforeCurrentDate' | 'afterCurrentDate' | 'lastWeek' | 'week' | 'nextWeek' | 'lastMonth' | 'month' | 'nextMonth' | 'tomorrow' | 'moreThanDaysAgo' | 'lessThanDaysAgo' | 'daysAgo' | 'moreThanDaysAhead' | 'lessThanDaysAhead' | 'daysAhead'

Condition

type'text' | 'textArea' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date'

Type

Custom fields

orderFilter.hasCustomFieldsboolean

Has custom fields

orderFilter.hasTagIdsboolean

Has tag IDs

orderFilter.extendedFilterstring

Advanced filter

orderFilter.extendedFilterIdstring

Advanced filter ID

cloudKeystring nullable

Cloud storage key

namestring nullable

Name

descriptionstring nullable

Description

originalNamestring nullable

Original file name

mimeTypestring nullable

MIME type

thumbnailUrlstring nullable

Thumbnail URL

type'other' | 'image' | 'video' | 'audio' | 'doc' | 'pdf' | 'ppt' | 'xls' | 'zip' | 'csv' | 'json'

Type

additionalDatastring nullable

Additional data

extensionstring nullable

Extension

sizeinteger

Size

completedboolean

Completed

isPublicboolean

Public

isVoiceboolean

Voice message

state'uploading' | 'completed' | 'aborted' | 'failure'

State

source'amazon' | 'yandex' | 'external' | 'axl'

Source

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

emailMessageIdstring nullable

Email message ID

externalUrlstring nullable

External URL

hasNameboolean

Has name

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

providerstring required

::API.Modules.AccelFiles.AccelFileAiProviderData.Provider::

metadataJsonstring nullable

::API.Modules.AccelFiles.AccelFileAiProviderData.MetadataJson::

fileIdstring required

::API.Modules.AccelFiles.AccelFileAiProviderData.FileId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

fileIdstring required

File ID

scenarioNodeIdstring nullable

Automation step ID

messageTemplateIdstring nullable

Message template ID

courseItemTestQuestionIdstring nullable

Course test question ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

type'pdfToImages'

Type

status'pending' | 'inProgress' | 'success' | 'error'

Status

dataJsonstring nullable

JSON data

progressnumber float

Progress

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

sizeinteger

Size

durationinteger

Duration

type'directory' | 'file'

Type

sectionType'fileSystem' | 'videos'

Section type

folderCountinteger

Number of folders

itemCountinteger

Number of items

fileIdstring nullable

File ID

videoIdstring nullable

Video ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

::API.Modules.AccelFiles.AccelFileManagerItem.SitePageId::

parentIdstring nullable

Parent folder ID

parentAccelModelProjectModulesAccelFilesAccelFileManagerItem circular
softDeletedByAdminIdstring nullable

ID of the admin who deleted the item

createdDatestring date-time

Creation date

createdByAdminIdstring required

ID of the admin who created the item

updatedDatestring date-time nullable

Date the record was last updated.

updatedByAdminIdstring nullable

ID of the admin who last updated the item

childrenAccelModelProjectModulesAccelFilesAccelFileManagerItem[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminCreatorIdstring nullable

ID of the admin who created the event

studentCreatorIdstring nullable

ID of the contact who created the event

scenarioCreatorIdstring nullable

ID of the automation that created the event

applicationCreatorIdstring nullable

::API.Modules.HistoryEvents.HistoryEvent.ApplicationCreatorId::

adminSchoolIdstring nullable

Team member ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

courseRequiredIdstring nullable

Required course ID

courseCategoryIdstring nullable

Course category ID

adminFileIdstring nullable

Admin file ID

productPackageIdstring nullable

Product package ID

coursePlanIdstring nullable

Course plan ID

courseItemIdstring nullable

Course item ID

schoolContentItemCommentIdstring nullable

Membership portal content item comment ID

courseItemTaskIdstring nullable

Course item assignment ID

courseItemTestIdstring nullable

Course item test ID

courseItemTestQuestionIdstring nullable

Course item test question ID

courseItemTestAnswerIdstring nullable

Course item test answer ID

studentIdstring nullable

Contact ID

studentGroupIdstring nullable

Contact group ID

studentCourseAccessIdstring nullable

ID of the contact's course access

studentLicenseSuspensionIdstring nullable

ID of the contact's license suspension

studentCourseIdstring nullable

ID of the contact's course enrollment

studentCourseItemProgressIdstring nullable

ID of the contact's lesson progress

studentCourseItemTaskAnswerIdstring nullable

ID of the contact's assignment answer

schoolContentItemProgressRatingIdstring nullable

Membership portal content item progress rating ID

studentCourseItemTaskAnswerCommentIdstring nullable

ID of the comment on the contact's assignment answer

schoolStudentProfileSettingsIdstring nullable

Membership portal user profile settings ID

dateFlowIdstring nullable

Cohort period ID

tagIdstring nullable

Tag ID

userInviteIdstring nullable

Team member invite ID

fileManagerItemIdstring nullable

File manager item ID

importSessionIdstring nullable

Import session ID

externalImportIdstring nullable

External import ID

policyIdstring nullable

Permission policy ID

schoolCallAccountIdstring nullable

Telephony account ID

schoolCallSessionIdstring nullable

Call session ID

schoolCallSIPRegistrationIdstring nullable

SIP registration ID

schoolCallIncomingLinkIdstring nullable

Incoming number assignment ID

adminTaskIdstring nullable

Task ID

emailTemplateIdstring nullable

Email template ID

broadcastIdstring nullable

Broadcast ID

broadcastListIdstring nullable

Mailing list ID

forumThreadIdstring nullable

Forum thread ID

forumThreadModeratorIdstring nullable

Forum thread moderator ID

forumTopicIdstring nullable

Forum topic ID

forumTopicCommentIdstring nullable

Forum topic comment ID

forumReactionIdstring nullable

Forum reaction ID

forumSubscriptionIdstring nullable

Forum subscription ID

forumBanIdstring nullable

Forum ban ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

siteDomainIdstring nullable

Website domain ID

siteFunnelIdstring nullable

Website funnel ID

siteGuestIdstring nullable

Website visitor ID

siteSessionViewIdstring nullable

ID of the page view in a website session

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library item ID

productIdstring nullable

Product ID

paymentGatewayIdstring nullable

Payment gateway ID

purchaseOrderIdstring nullable

Order ID

purchaseOrderPaymentIdstring nullable

Order payment ID

videoIdstring nullable

Video ID

videoStreamIdstring nullable

Video stream ID

videoDomainIdstring nullable

Video domain ID

loginSessionIdstring nullable

Sign-in session ID

webinarIdstring nullable

Webinar ID

widgetIdstring nullable

Widget ID

chatChannelIdstring nullable

Chat channel ID

quizIdstring nullable

Quiz ID

quizAnswerIdstring nullable

Quiz answer ID

chatBotIdstring nullable

Chatbot ID

chatChannelMessageTemplateIdstring nullable

Chat channel message template ID

applicationIdstring nullable

App ID

telegramGroupIdstring nullable

Telegram group ID

pipelineStageIdstring nullable

Pipeline stage ID

phoneNumberIdstring nullable

::API.Modules.HistoryEvents.HistoryEvent.PhoneNumberId::

pipelineItemIdstring nullable

Deal ID

scenarioIdstring nullable

Automation ID

scenarioNodeIdstring nullable

Automation step ID

partnershipIdstring nullable

Affiliate program ID

partnershipOfferIdstring nullable

Affiliate offer ID

partnershipTransactionIdstring nullable

Affiliate transaction ID

studentBonusTransactionIdstring nullable

ID of the contact's bonus transaction

partnershipTransactionRequestIdstring nullable

Affiliate transaction request ID

certIdstring nullable

Certificate ID

studentCertIdstring nullable

ID of the contact's certificate

gamificationIdstring nullable

Gamification ID

gamificationAchievementIdstring nullable

Gamification achievement ID

gamificationProductIdstring nullable

Gamification product ID

gamificationTransactionIdstring nullable

Gamification transaction ID

studentAchievementIdstring nullable

ID of the contact's achievement

managerCreatorIdstring nullable

ID of the AXL manager who created the event

billingPlanIdstring nullable

Subscription plan ID

schoolBillingIdstring nullable

Account billing ID

createdDatestring date-time

Creation date

additionalDatastring nullable

Additional data

type'courseCreated' | 'courseUpdated' | 'courseCategoryCreated' | 'courseCategoryUpdated' | 'courseCategoryDeleted' | 'coursePackageCreated' | 'coursePackageUpdated' | 'coursePackageDeleted' | 'coursePackageLinkCreated' | 'coursePackageLinkDeleted' | 'courseImageCreated' | 'courseImageUpdated' | 'courseImageDeleted' | 'coursePlanCreated' | 'coursePlanUpdated' | 'coursePlanDeleted' | 'coursePlanCopied' | 'courseCategoryLinkCreated' | 'courseCategoryLinkUpdated' | 'courseCategoryLinkDeleted' | 'courseRequirementCreated' | 'courseRequirementDeleted' | 'courseItemCommentCreated' | 'courseItemCommentUpdated' | 'courseItemCommentDeleted' | 'courseItemCreated' | 'courseItemUpdated' | 'courseItemDeleted' | 'courseItemTaskCreated' | 'courseItemTaskUpdated' | 'courseItemTaskDeleted' | 'courseItemTestCreated' | 'courseItemTestUpdated' | 'courseItemTestDeleted' | 'courseItemTestQuestionCreated' | 'courseItemTestQuestionUpdated' | 'courseItemTestQuestionDeleted' | 'courseItemTestAnswerCreated' | 'courseItemTestAnswerUpdated' | 'courseItemTestAnswerDeleted' | 'courseItemPlanCreated' | 'courseItemPlanDeleted' | 'courseItemRestored' | 'courseItemCopied' | 'courseItemTaskCopied' | 'courseItemTestCopied' | 'courseItemTestQuestionCopied' | 'courseItemTaskFileCreated' | 'courseItemTaskFileDeleted' | 'courseItemTaskFileUpdated' | 'courseItemTestFileCreated' | 'courseItemTestFileDeleted' | 'courseItemTestFileUpdated' | 'courseItemFormSubmitted' | 'courseItemTaskFieldCreated' | 'courseItemTaskFieldUpdated' | 'courseItemTaskFieldDeleted' | 'accelFileCreated' | 'accelFileUpdated' | 'accelFileDeleted' | 'accelFileRefreshed' | 'schoolCreated' | 'schoolUpdated' | 'schoolDeleted' | 'schoolProfileSettingsUpdated' | 'schoolJsCodeUpdated' | 'schoolSettingsUpdated' | 'schoolRegisterFormSubmitted' | 'schoolOwnerChanged' | 'adminCreated' | 'adminInviteCreated' | 'adminUpdated' | 'adminLogin' | 'adminResetPassword' | 'adminRegister' | 'adminForgotPassword' | 'adminConfirmEmail' | 'adminSchoolCreated' | 'adminSchoolUpdated' | 'adminSchoolDeleted' | 'adminSchoolRestored' | 'adminResponsibleCreated' | 'adminResponsibleUpdated' | 'adminResponsibleDeleted' | 'adminStepCourseOpened' | 'adminStepCourseClosed' | 'adminStepCourseCompleted' | 'adminStepCourseUncompleted' | 'allAdminResponsibleUpdated' | 'tagCreated' | 'tagUpdated' | 'tagDeleted' | 'tagMerged' | 'fileManagerItemCreated' | 'fileManagerItemUpdated' | 'fileManagerItemDeleted' | 'studentCreated' | 'studentLogin' | 'studentResetPassword' | 'studentRegister' | 'studentForgotPassword' | 'studentConfirmEmail' | 'studentUpdated' | 'studentCourseCreated' | 'studentCourseStarted' | 'studentCourseCompleted' | 'studentLicenseCreated' | 'studentLicenseUpdated' | 'studentLicenseDeleted' | 'studentCourseFeedbackCreated' | 'studentCourseItemStarted' | 'studentCourseItemCompleted' | 'studentCourseItemTheoryCompleted' | 'studentCourseItemTestsCompleted' | 'studentCourseItemTasksCompleted' | 'studentCourseItemTaskAnswerStatusUpdated' | 'studentConfirmInvite' | 'studentInviteCreated' | 'studentSelfRemoved' | 'studentMergedSource' | 'studentMergedTarget' | 'studentUpdatedLimited' | 'studentRestored' | 'studentProductSubscriptionUpdated' | 'studentCourseItemRatingCreated' | 'studentCourseItemRatingUpdated' | 'studentLibraryItemRatingCreated' | 'studentLibraryItemRatingUpdated' | 'studentGroupCreated' | 'studentGroupUpdated' | 'studentGroupDeleted' | 'studentBonusTransactionCreated' | 'studentBonusTransactionDeleted' | 'studentLicenseSuspensionCreated' | 'studentLicenseSuspensionDeleted' | 'importLeadUpdated' | 'importLeadCreated' | 'leadNoteCreated' | 'leadDeleted' | 'leadDeletedByMerge' | 'leadBanned' | 'leadUnbanned' | 'leadCommentsBanned' | 'leadCommentsUnbanned' | 'leadToBroadcastListAdded' | 'leadFromBroadcastListDeleted' | 'leadTagsUpdated' | 'leadGroupsUpdated' | 'leadGroupCreated' | 'leadGroupUpdated' | 'leadGroupDeleted' | 'leadAddCartProduct' | 'leadDeleteCartProduct' | 'leadVisitCheckout' | 'leadVisitCheckoutSuccess' | 'leadWebinarRegistration' | 'leadWebinarVisit' | 'leadAttributeCreated' | 'leadAttributeUpdated' | 'leadAttributeDeleted' | 'leadAttributeRestored' | 'leadChatChannelStarted' | 'leadChatBotStarted' | 'leadChatChannelScenarioStarted' | 'leadPriorityAssigned' | 'policyCreated' | 'policyUpdated' | 'policyDeleted' | 'forumThreadCreated' | 'forumThreadUpdated' | 'forumThreadDeleted' | 'forumThreadRestored' | 'forumThreadModeratorCreated' | 'forumThreadModeratorDeleted' | 'forumThreadMemberCreated' | 'forumThreadMemberDeleted' | 'forumBanCreated' | 'forumBanDeleted' | 'emailSent' | 'emailUnsubscribed' | 'emailPermanentFail' | 'emailComplained' | 'emailClicked' | 'emailOpened' | 'emailDelivered' | 'emailSuppressed' | 'emailSubscribed' | 'emailTemplateCreated' | 'emailTemplateUpdated' | 'emailTemplateDeleted' | 'emailTemplateCopied' | 'broadcastCreated' | 'broadcastUpdated' | 'broadcastDeleted' | 'broadcastStatusUpdated' | 'schoolCallSessionCompleted' | 'schoolCallSessionStarted' | 'schoolCallSIPRegistrationCreated' | 'schoolCallSIPRegistrationUpdated' | 'schoolCallSIPRegistrationDeleted' | 'schoolCallSIPRegistrationLinkCreated' | 'schoolCallSIPRegistrationLinkDeleted' | 'schoolCallIncomingLinkCreated' | 'schoolCallIncomingLinkUpdated' | 'schoolCallIncomingLinkDeleted' | 'schoolCallAccountCreated' | 'schoolCallAccountUpdated' | 'schoolCallAccountDeleted' | 'adminTaskCreated' | 'adminTaskUpdated' | 'adminTaskDeleted' | 'adminTaskCompleted' | 'adminTaskResetStatus' | 'adminTaskReportUpdated' | 'libraryCreated' | 'libraryUpdated' | 'libraryDeleted' | 'libraryCategoriesUpdated' | 'libraryImageCreated' | 'libraryImageUpdated' | 'libraryImageDeleted' | 'libraryItemCreated' | 'libraryItemUpdated' | 'libraryItemDeleted' | 'libraryItemRestored' | 'libraryItemViewed' | 'libraryItemFormSubmitted' | 'productPackageCreated' | 'productPackageUpdated' | 'productPackageDeleted' | 'productPackageCourseLinkCreated' | 'productPackageCourseLinkDeleted' | 'productPackageCourseLinkUpdated' | 'productPackageLibraryAccessLinkCreated' | 'productPackageLibraryAccessLinkDeleted' | 'productPackageLibraryAccessLinkUpdated' | 'siteCreated' | 'siteUpdated' | 'siteDeleted' | 'sitePageCreated' | 'sitePageUpdated' | 'sitePageDeleted' | 'siteDomainCreated' | 'siteDomainUpdated' | 'siteDomainDeleted' | 'siteMenuItemCreated' | 'siteMenuItemUpdated' | 'siteMenuItemDeleted' | 'siteViewed' | 'siteFunnelCreated' | 'siteFunnelUpdated' | 'siteFunnelDeleted' | 'siteFormSubmitted' | 'sitePageVariationCreated' | 'sitePageVariationUpdated' | 'sitePageVariationDeleted' | 'sitePageVariationTestCreated' | 'sitePageVariationTestUpdated' | 'sitePageVariationTestDeleted' | 'scenarioCreated' | 'scenarioUpdated' | 'scenarioDeleted' | 'scenarioNodeCreated' | 'scenarioNodeUpdated' | 'scenarioNodeDeleted' | 'productCreated' | 'productUpdated' | 'productDeleted' | 'productRestored' | 'productImageCreated' | 'productImageDeleted' | 'paymentGatewayCreated' | 'paymentGatewayUpdated' | 'paymentGatewayDeleted' | 'purchaseOrderCreated' | 'purchaseOrderUpdated' | 'purchaseOrderDeleted' | 'purchaseOrderCompleted' | 'purchaseOrderCanceled' | 'purchaseOrderUnCompleted' | 'purchaseOrderPaid' | 'purchaseOrderRestored' | 'purchaseOrderPaymentCreated' | 'purchaseOrderPaymentUpdated' | 'purchaseOrderPaymentDeleted' | 'purchaseOrderPaymentRefunded' | 'purchaseOrderContentCreated' | 'purchaseOrderContentUpdated' | 'purchaseOrderContentDeleted' | 'videoCreated' | 'videoUpdated' | 'videoDeleted' | 'videoKinescopeDeleted' | 'videoStreamCreated' | 'videoStreamUpdated' | 'videoStreamDeleted' | 'videoStreamMakeCurrent' | 'videoStreamAborted' | 'videoStreamImageCreated' | 'videoStreamImageDeleted' | 'videoDomainCreated' | 'videoDomainUpdated' | 'videoDomainDeleted' | 'videoAccessCreated' | 'videoAccessUpdated' | 'videoAccessDeleted' | 'videoAccessDomainUpdated' | 'widgetViewed' | 'widgetFormSubmitted' | 'webhookSent' | 'quizStarted' | 'quizSubmitted' | 'quizViewed' | 'pipelineDealCreated' | 'pipelineDealUpdated' | 'pipelineDealDeleted' | 'pipelineDealTaskAdded' | 'pipelineDealTaskDeleted' | 'pipelineDealOrderAdded' | 'pipelineDealOrderDeleted' | 'pipelineDealStageChanged' | 'pipelineDealArchived' | 'pipelineDealRestored' | 'pipelineDealCompleted' | 'pipelineStageCreated' | 'pipelineStageUpdated' | 'pipelineStageDeleted' | 'pipelineTagMerged' | 'glossaryCreated' | 'glossaryUpdated' | 'glossaryDeleted' | 'glossaryRestored' | 'glossaryLinkCreated' | 'glossaryLinkDeleted' | 'applicationSchoolLinkCreated' | 'applicationSchoolLinkUpdated' | 'applicationSchoolLinkDeleted' | 'applicationSchoolLinkRestored' | 'telegramGroupCreated' | 'telegramGroupUpdated' | 'telegramGroupDeleted' | 'telegramGroupRestored' | 'telegramGroupUserUpdated' | 'telegramGroupUserInvited' | 'telegramGroupUserBanned' | 'telegramGroupUserApproved' | 'telegramGroupUserRejected' | 'telegramGroupUserDeleted' | 'telegramGroupUserLeft' | 'telegramGroupUserRequested' | 'applicationUpdated' | 'facebookFormCreated' | 'facebookFormUpdated' | 'facebookFormDeleted' | 'facebookFormRestored' | 'facebookFormLeadAdded' | 'facebookFormLeadUpdated' | 'facebookFormLeadDeleted' | 'partnershipCreated' | 'partnershipUpdated' | 'partnershipOfferCreated' | 'partnershipOfferUpdated' | 'partnershipOfferDeleted' | 'partnershipTransactionRequestCreated' | 'partnershipTransactionRequestUpdated' | 'partnershipTransactionRequestDeleted' | 'partnershipTransactionCreated' | 'partnershipTransactionDeleted' | 'certCreated' | 'certUpdated' | 'certDeleted' | 'gamificationCreated' | 'gamificationUpdated' | 'gamificationAchievementCreated' | 'gamificationAchievementUpdated' | 'gamificationAchievementDeleted' | 'gamificationProductCreated' | 'gamificationProductUpdated' | 'gamificationProductDeleted' | 'gamificationProductRestored' | 'gamificationTransactionCreated' | 'chatChannelMessageTemplateUpdated' | 'billingPlanCreated' | 'billingPlanUpdated' | 'billingPlanDeleted' | 'billingPlanRestored' | 'schoolBillingUpdated' | 'teamDepartmentCreated' | 'teamDepartmentUpdated' | 'teamDepartmentDeleted' | 'teamDepartmentMemberCreated' | 'teamDepartmentMemberUpdated' | 'teamDepartmentMemberDeleted' | 'dashboardCreated' | 'dashboardUpdated' | 'dashboardDeleted' | 'dashboardItemCreated' | 'dashboardItemUpdated' | 'dashboardItemDeleted' | 'dashboardDataSourceCreated' | 'dashboardDataSourceUpdated' | 'dashboardDataSourceDeleted' | 'dashboardDataSourceFieldCreated' | 'dashboardDataSourceFieldUpdated' | 'dashboardDataSourceFieldDeleted' | 'eventCalendarEventCreated' | 'eventCalendarEventUpdated' | 'eventCalendarEventDeleted' | 'communityCreated' | 'communityUpdated' | 'communitySpaceCreated' | 'communitySpaceUpdated' | 'communitySpaceDeleted' | 'communityMemberCreated' | 'communityMemberUpdated' | 'communityMemberDeleted' | 'communityPostCreated' | 'communityPostUpdated' | 'communityPostDeleted' | 'communityPostApproved' | 'communityPostRejected' | 'communityPostPending' | 'communityBadgeCreated' | 'communityBadgeUpdated' | 'communityBadgeDeleted' | 'communityPostCommentCreated' | 'communityPostCommentUpdated' | 'communityPostCommentDeleted' | 'communityPostCommentApproved' | 'communityPostCommentRejected' | 'communityPostCommentPending' | 'communityReportCreated' | 'communityReportUpdated' | 'communityReportDeleted' | 'chatConversationMarkedAsRead' | 'chatConversationLeaved' | 'chatConversationClosed' | 'meetingCreated' | 'meetingUpdated' | 'meetingDeleted' | 'meetingViewed' | 'meetingBookingCreated' | 'meetingBookingUpdated' | 'meetingBookingConfirmed' | 'meetingBookingCancelled' | 'meetingBookingCompleted' | 'meetingBookingNoShow' | 'aiDialogCreated' | 'aiDialogDeleted' | 'telephonyNumberUpdated' | 'socialConnectionCreated' | 'socialConnectionDeleted' | 'socialConnectionReauthRequired' | 'socialConnectionMessagingLinked' | 'socialConnectionMessagingUnlinked' | 'socialPostCreated' | 'socialPostUpdated' | 'socialPostDeleted' | 'socialPostScheduled' | 'socialPublicationPublished' | 'socialPublicationFailed' | 'adConnectionCreated' | 'adConnectionDeleted' | 'adCampaignCreated' | 'adCampaignLaunched' | 'adCampaignPaused' | 'adCampaignBudgetChanged' | 'adCampaignRejected'

Type

globalType'system' | 'study' | 'crm' | 'contentEdit' | 'forum' | 'email' | 'communication' | 'library' | 'siteContent' | 'site' | 'scenario' | 'call' | 'product' | 'video' | 'webinar' | 'application' | 'partnership' | 'cert' | 'gamification' | 'billing' | 'dashboard' | 'eventCalendar' | 'chat' | 'community' | 'social' | 'advertising' | 'aiDialog' | 'meeting'

Event category

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

historyEventIdstring required

History event ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

tokenstring nullable

Token

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

expiredDatestring date-time nullable

Expiration date

completedDatestring date-time nullable

Date the session ended

ipstring nullable

IP address

countrystring nullable

Country

citystring nullable

City

userAgentstring nullable

User agent

browserstring nullable

Browser

devicestring nullable

Device

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

studentCommunicationIdstring nullable

Contact method ID

managerIdstring nullable

AXL staff member ID

isInitedboolean

Whether the session is initialized

isManagerAsAdminboolean

Whether an AXL staff member is signed in as the admin

isAdminAsStudentboolean

Whether an admin is signed in as the contact

isActiveboolean

Whether the session is active

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

tokenstring nullable

::API.Modules.Users.UserWebPushToken.Token::

userAgentstring nullable

::API.Modules.Users.UserWebPushToken.UserAgent::

type'fcm' | 'expo'

::API.Modules.Users.UserWebPushToken.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

sessionIdstring required

::API.Modules.Users.UserWebPushToken.SessionId::

adminIdstring nullable

::API.Modules.Users.UserWebPushToken.AdminId::

studentIdstring nullable

::API.Modules.Users.UserWebPushToken.StudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

lastNamestring nullable

Last name

phonestring nullable

Phone

type'simple' | 'api' | 'thirdParty'

Type

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

gender'male' | 'female' | 'other' nullable

Gender

birthdaystring date-time nullable

Birthday

timezoneMode'local' | 'school'

Time zone mode

externalIdstring nullable

External ID

isEmailConfirmedboolean

Email address verified

isPhoneConfirmedboolean

Phone verified

isSystemboolean

Whether this is a system user

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastSeenDatestring date-time nullable

Date of the last visit

agreeWithTermsDatestring date-time nullable

Date the terms were accepted

emailConfirmationSentDatestring date-time nullable

Date the confirmation email was sent

avatarIdstring nullable

Avatar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

codestring required

::API.Modules.Users.AdminPartnerLink.Code::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Users.AdminPartnerLink.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.AdminPartnerTariff.Name::

mainServicePercentnumber float

::API.Modules.Users.AdminPartnerTariff.MainServicePercent::

additionalServicePercentnumber float

::API.Modules.Users.AdminPartnerTariff.AdditionalServicePercent::

networkPercentnumber double

::API.Modules.Users.AdminPartnerTariff.NetworkPercent::

initialPartnerBonusAmountnumber double

::API.Modules.Users.AdminPartnerTariff.InitialPartnerBonusAmount::

initialReferralBonusAmountnumber double

::API.Modules.Users.AdminPartnerTariff.InitialReferralBonusAmount::

referralSpendThresholdnumber double

::API.Modules.Users.AdminPartnerTariff.ReferralSpendThreshold::

adminIdstring required

::API.Modules.Users.AdminPartnerTariff.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

mainServiceAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.MainServiceAmount::

additionalServiceAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.AdditionalServiceAmount::

totalAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.TotalAmount::

createdDatestring date-time

Creation date

type'general' | 'initialBonus' | 'referralFee' | 'networkFee'

::API.Modules.Users.AdminPartnerTransaction.Type::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Users.AdminPartnerTransaction.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Users.AdminPartnerTransaction.ExchangeRate::

billingInvoiceIdstring nullable

::API.Modules.Users.AdminPartnerTransaction.BillingInvoiceId::

commentstring nullable

::API.Modules.Users.AdminPartnerTransaction.Comment::

adminIdstring required

::API.Modules.Users.AdminPartnerTransaction.AdminId::

fromAdminIdstring nullable

::API.Modules.Users.AdminPartnerTransaction.FromAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

studentCommunicationIdstring nullable

Contact method ID

userEmailTemplateIdstring nullable

User email template ID

tokenstring nullable

Token

createdDatestring date-time

Creation date

confirmedDatestring date-time nullable

Date the invite was accepted

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

Admin ID

studentIdstring required

Contact ID

poststring nullable

Job title

trackPurchaseOrderboolean

Track orders

trackChatboolean

Track chat

assignCoursesboolean

::API.Modules.Users.AdminResponsibleStudentLink.AssignCourses::

assignedCourseIdsJsonstring nullable

::API.Modules.Users.AdminResponsibleStudentLink.AssignedCourseIdsJson::

assignedCourseIdsstring[] nullable

::API.Modules.Users.AdminResponsibleStudentLink.AssignedCourseIds::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.AdminViewSetting.Name::

type'crm' | 'order' | 'chatMessageTesting' | 'orderPayment'

::API.Modules.Users.AdminViewSetting.Type::

columnsJsonstring nullable

::API.Modules.Users.AdminViewSetting.ColumnsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring required

::API.Modules.Users.AdminViewSetting.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

partnerEmailstring nullable

::API.Modules.Users.AdminMetadata.PartnerEmail::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

codestring required

::API.Modules.Users.AdminSupportCode.Code::

managerIdstring nullable

::API.Modules.Users.AdminSupportCode.ManagerId::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Users.AdminSupportCode.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

isPrimaryboolean

::API.Modules.Users.AdminDashboardLink.IsPrimary::

adminIdstring required

::API.Modules.Users.AdminDashboardLink.AdminId::

dashboardIdstring required

::API.Modules.Users.AdminDashboardLink.DashboardId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.SmsAssistant.SmsAssistantSession.PhoneE164::

adminIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.AdminId::

schoolIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.SchoolId::

dialogIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.DialogId::

state'onboarding' | 'ready' | 'linking'

::API.Modules.SmsAssistant.SmsAssistantSession.State::

channel'sms' | 'whatsApp' | 'telegram'

::API.Modules.SmsAssistant.SmsAssistantSession.Channel::

onboardingJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.OnboardingJson::

pendingInboundJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.PendingInboundJson::

magicLinkTokenstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.MagicLinkToken::

magicLinkExpiresstring date-time nullable

::API.Modules.SmsAssistant.SmsAssistantSession.MagicLinkExpires::

optedOutDatestring date-time nullable

::API.Modules.SmsAssistant.SmsAssistantSession.OptedOutDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.SmsAssistant.SmsAssistantMessage.PhoneE164::

direction'inbound' | 'outbound'

::API.Modules.SmsAssistant.SmsAssistantMessage.Direction::

channel'sms' | 'whatsApp' | 'telegram'

::API.Modules.SmsAssistant.SmsAssistantMessage.Channel::

bodystring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.Body::

mediaUrlsJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.MediaUrlsJson::

twilioSidstring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.TwilioSid::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

schoolIdstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.SchoolId::

adminIdstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.AdminId::

emailstring required

::API.Modules.SystemEmails.SystemEmailMessage.Email::

kindstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Kind::

subjectstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Subject::

status'sent' | 'exceedLimit' | 'error'

::API.Modules.SystemEmails.SystemEmailMessage.Status::

errorstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Error::

fromstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.From::

isTestboolean

::API.Modules.SystemEmails.SystemEmailMessage.IsTest::

deliveryStatus'none' | 'delivered' | 'bounced' | 'complained' | 'unsubscribed'

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryStatus::

deliveryDatestring date-time nullable

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryDate::

deliveryErrorstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryError::

openedDatestring date-time nullable

::API.Modules.SystemEmails.SystemEmailMessage.OpenedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

::API.Modules.SmsAssistant.AdminWhatsAppAccount.AdminId::

phoneE164string nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.PhoneE164::

connectTokenstring nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.ConnectToken::

verificationCodestring nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.VerificationCode::

state'pending' | 'codeSent' | 'verified'

::API.Modules.SmsAssistant.AdminWhatsAppAccount.State::

expiresAtstring date-time nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.ExpiresAt::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

isActivePendingboolean

::API.Modules.SmsAssistant.AdminWhatsAppAccount.IsActivePending::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

schoolIdstring required

::API.Modules.AI.Memory.AiAssistantMemory.SchoolId::

kind'fact' | 'preference' | 'entity' | 'profile'

::API.Modules.AI.Memory.AiAssistantMemory.Kind::

contentstring required

::API.Modules.AI.Memory.AiAssistantMemory.Content::

importanceinteger

::API.Modules.AI.Memory.AiAssistantMemory.Importance::

entityTypestring nullable

::API.Modules.AI.Memory.AiAssistantMemory.EntityType::

entityIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.EntityId::

sourceDialogIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.SourceDialogId::

createdByAdminIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.CreatedByAdminId::

createdDatestring date-time

Creation date

lastUsedDatestring date-time nullable

::API.Modules.AI.Memory.AiAssistantMemory.LastUsedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

subjectstring nullable

Subject

bodystring nullable

Email body

plainTextstring nullable

Plain text

preheaderstring nullable

Preheader

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

subtype'adminResetPassword' | 'adminInvite' | 'studentEmailConfirmation' | 'studentInvite' | 'studentResetPassword' | 'studentPurchase' | 'webinarRegistration' | 'webinarUpcomingReminder' | 'webinarStartReminder' | 'adminInvoice' | 'productRenewalPaymentSucceeded' | 'productRenewalPaymentFailed' | 'adminConfirmCode' | 'adminEmailConfirmation' | 'studentCert' | 'meetingRegistration' | 'meetingConfirmation' | 'meetingStartReminder' nullable

Subtype

type'system' | 'custom'

Type

purpose'marketing' | 'transactional'

::API.Modules.Emails.EmailTemplate.Purpose::

purposeSource'default' | 'author' | 'check'

::API.Modules.Emails.EmailTemplate.PurposeSource::

systemTemplateIdstring nullable

System template ID

systemTemplateAccelModelProjectModulesEmailsEmailTemplate circular
sentCountinteger

Number of emails sent

openCountinteger

Total opens

clickCountinteger

Total clicks

openUniqueCountinteger

Unique opens

clickUniqueCountinteger

Unique clicks

unsubscribeCountinteger

Total unsubscribes

lastSendDatestring date-time nullable

Date the template was last sent

purchaseCountinteger nullable

Number of purchases

purchaseAmountnumber double nullable

Total purchase amount

openRatenumber double

Open rate

clickRatenumber double

Click-to-open rate

unsubscribeRatenumber double

Unsubscribe rate

emailProfileIdstring nullable

Email profile ID

creatorIdstring nullable

Creator ID

aiDialogIdstring nullable

::API.Modules.Emails.EmailTemplate.AiDialogId::

brandStyleIdstring nullable

::API.Modules.Emails.EmailTemplate.BrandStyleId::

hasBodyboolean

Whether the template has a body

hasSubjectboolean

Whether the template has a subject line

hasPreheaderboolean

Whether the template has a preheader

canOverrideboolean

Whether the account can override this template with its own copy

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

dateCreatedstring date-time

Date created

isSendedboolean

Whether the email was sent

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

templateIdstring required

Template ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'accel' | 'custom'

Type

namestring nullable

Name

descriptionstring nullable

Description

fromEmailstring nullable

From address

replyToEmailstring nullable

Reply-to address

senderNamestring nullable

Sender name

additionalTextstring nullable

Additional text

isPrimaryboolean

Whether this is the primary email profile

hasUnsubscribeLinkboolean

Whether emails include an unsubscribe link

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

emailDomainIdstring nullable

Email domain ID

sentCountinteger

Number of emails sent

smtpUrlstring nullable

SMTP URL

smtpLoginstring nullable

SMTP username

smtpPasswordstring nullable

SMTP password

smtpPortinteger

SMTP port

smtpUseSSLboolean

Whether SMTP uses SSL

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

type'system' | 'custom'

Type

inboundEnabledboolean

Whether inbound email is enabled

isCustomboolean

Whether this is a custom domain

isSystemboolean

Whether this is a system domain

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Emails.EmailResponsible.Name::

emailstring nullable

::API.Modules.Emails.EmailResponsible.Email::

fromstring nullable

::API.Modules.Emails.EmailResponsible.From::

catchAllboolean

::API.Modules.Emails.EmailResponsible.CatchAll::

inboundCountinteger

::API.Modules.Emails.EmailResponsible.InboundCount::

spamCountinteger

::API.Modules.Emails.EmailResponsible.SpamCount::

createdDatestring date-time

Creation date

domainIdstring nullable

::API.Modules.Emails.EmailResponsible.DomainId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

responsibleIdstring required

::API.Modules.Emails.EmailResponsibleAdminLink.ResponsibleId::

adminIdstring required

::API.Modules.Emails.EmailResponsibleAdminLink.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

reason'complained' | 'permanentFail' | 'custom' | 'providerStopList'

Reason

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

apiKeystring nullable

API key

settingJsonstring nullable

Settings in JSON format

type'elasticEmail' | 'mailgun'

Type

status'ready' | 'expired'

Status

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

status'created' | 'registered' | 'dnsRecordsRegistered' | 'verified'

Status

dnsRecordsJsonstring nullable

DNS records in JSON format

inboundDnsRecordsJsonstring nullable

Inbound email DNS records in JSON format

webhooksRegisteredboolean

Whether webhooks are registered

inboundVerifiedboolean

Whether inbound email is verified

inboundWebhookRegisteredboolean

Whether the inbound email webhook is registered

verifyUntilDatestring date-time nullable

Verification end date

inboundVerifyUntilDatestring date-time nullable

Inbound email verification end date

trackingWebhooksRegisteredboolean

::API.Modules.Emails.EmailDomainIntegration.TrackingWebhooksRegistered::

webhooksSignedboolean

::API.Modules.Emails.EmailDomainIntegration.WebhooksSigned::

inboundWebhookSignedboolean

::API.Modules.Emails.EmailDomainIntegration.InboundWebhookSigned::

trackingRequiredboolean

::API.Modules.Emails.EmailDomainIntegration.TrackingRequired::

trackingStatus'none' | 'recordMissing' | 'caaBlocked' | 'recordFound' | 'certificatePending' | 'verified' | 'httpOnly' | 'failed'

::API.Modules.Emails.EmailDomainIntegration.TrackingStatus::

trackingRequestedDatestring date-time nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingRequestedDate::

trackingCheckedDatestring date-time nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingCheckedDate::

trackingErrorstring nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingError::

integrationIdstring required

Integration ID

domainIdstring required

Domain ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

addressstring nullable

::API.Modules.Emails.EmailSpamAddress.Address::

type'email' | 'domain'

::API.Modules.Emails.EmailSpamAddress.Type::

isSpamboolean

::API.Modules.Emails.EmailSpamAddress.IsSpam::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

contentHashstring required

::API.Modules.Emails.ContentCheck.EmailContentCheck.ContentHash::

policyVersioninteger

::API.Modules.Emails.ContentCheck.EmailContentCheck.PolicyVersion::

depth'rules' | 'full'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Depth::

mode'shadow' | 'advise' | 'enforce'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Mode::

verdict'ok' | 'advice' | 'block'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Verdict::

aiStatus'none' | 'done' | 'failed' | 'skipped'

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiStatus::

issuesJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.IssuesJson::

categoriesJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.CategoriesJson::

purposeJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.PurposeJson::

summarystring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Summary::

snapshotJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.SnapshotJson::

subjectstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Subject::

langstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Lang::

aiModelstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiModel::

aiPriceUsdnumber double nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiPriceUsd::

subjectType'template' | 'broadcast' | 'inline' | 'test' | 'thirdParty' | 'system'

::API.Modules.Emails.ContentCheck.EmailContentCheck.SubjectType::

emailTemplateIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.EmailTemplateId::

broadcastIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.BroadcastId::

createdByAdminIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

reviewStatus'none' | 'pending' | 'approved' | 'rejected'

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewStatus::

reviewReason'none' | 'aiBlock' | 'aiDoubt' | 'schoolRequest' | 'purposeChanged'

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewReason::

reviewRequestedDatestring date-time nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestedDate::

reviewRequestedByAdminIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestedByAdminId::

reviewRequestCommentstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestComment::

reviewedByManagerIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewedByManagerId::

reviewDatestring date-time nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewDate::

reviewCommentstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewComment::

isApprovedboolean

::API.Modules.Emails.ContentCheck.EmailContentCheck.IsApproved::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

source'auto' | 'manager'

::API.Modules.Emails.Engine.EmailAccountPause.Source::

enforcedboolean

::API.Modules.Emails.Engine.EmailAccountPause.Enforced::

reasonsstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.Reasons::

countsJsonstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.CountsJson::

commentstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.Comment::

createdByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.CreatedByManagerId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

endedDatestring date-time nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndedDate::

endedByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndedByManagerId::

endCommentstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndComment::

isOpenboolean

::API.Modules.Emails.Engine.EmailAccountPause.IsOpen::

stopsMarketingboolean

::API.Modules.Emails.Engine.EmailAccountPause.StopsMarketing::

reasonListstring[] nullable

::API.Modules.Emails.Engine.EmailAccountPause.ReasonList::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

datestring date-time

::API.Modules.Emails.Engine.EmailAccountDailyStat.Date::

acceptedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Accepted::

deliveredinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Delivered::

hardBouncedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.HardBounced::

providerStopListinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.ProviderStopList::

spamBlockedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.SpamBlocked::

complainedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Complained::

unsubscribedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Unsubscribed::

acceptedMonthinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.AcceptedMonth::

scoreinteger nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.Score::

providerReputationnumber double nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.ProviderReputation::

trustLevel'new' | 'verified' | 'restricted'

::API.Modules.Emails.Engine.EmailAccountDailyStat.TrustLevel::

trustReasonstring nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.TrustReason::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

kind'trustLevel' | 'hourlyCeiling'

::API.Modules.Emails.Engine.EmailAccountOverride.Kind::

valuestring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.Value::

commentstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.Comment::

createdByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.CreatedByManagerId::

createdDatestring date-time

Creation date

endedDatestring date-time nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndedDate::

endedByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndedByManagerId::

endCommentstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndComment::

isOpenboolean

::API.Modules.Emails.Engine.EmailAccountOverride.IsOpen::

trustLevel'new' | 'verified' | 'restricted' nullable

::API.Modules.Emails.Engine.EmailAccountOverride.TrustLevel::

hourlyCeilinginteger nullable

::API.Modules.Emails.Engine.EmailAccountOverride.HourlyCeiling::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

sentDatestring date-time nullable

Sent date

scheduledSendDatestring date-time nullable

Scheduled send date

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sendImmediatelyboolean

Send immediately

alwaysSendEmailboolean

Always send email

useEmailMessageboolean nullable

Use email message

useChatMessageboolean nullable

Use chat message

textstring nullable

Text

buttonsJsonstring nullable

Chat message buttons as JSON

chatChannelsJsonstring nullable

Chat channels as JSON

chatChannelsSettingsJsonstring nullable

Chat channel settings as JSON

sessionPreparedCountinteger

Number of recipients prepared for sending

sessionProcessedCountinteger

Number of recipients processed

sessionSentErrorCountinteger

Number of recipients the broadcast failed to send to

totalProcessedCountinteger

Total number of messages processed

totalSentErrorCountinteger

Total number of send errors

totalSentCountinteger

Total number of messages sent

sessionSentCountinteger

Number of recipients the broadcast was sent to

totalEmailSentCountinteger

Total number of emails sent

totalEmailErrorCountinteger

Total number of email errors

totalEmailProcessedCountinteger

Total number of emails processed

totalChatSentCountinteger

Total number of chat messages sent

totalChatErrorCountinteger

Total number of chat errors

totalChatProcessedCountinteger

Total number of chat messages processed

openCountinteger

Number of opens

openUniqCountinteger

Number of unique opens

clickCountinteger

Number of clicks

clickUniqCountinteger

Number of unique clicks

chatButtonClickCountinteger

Number of clicks on chat message buttons

chatButtonClickUniqCountinteger

Number of unique clicks on chat message buttons

unsubscribeCountinteger

Number of unsubscribes

openRatenumber double

Open rate

clickRatenumber double

Click rate

chatButtonClickRatenumber double

Click rate on chat message buttons

unsubscribeRatenumber double

Unsubscribe rate

totalClickUniqCountinteger

Total number of unique clicks

totalClickCountinteger

Total number of clicks

totalClickRatenumber double

Overall click rate

progressnumber float

Progress

status'scheduled' | 'preparing' | 'sending' | 'sent' | 'paused' | 'aborted' | 'startError' | 'contentBlocked'

Status

version'v1' | 'v2'

Version

errorstring nullable

Error

purchaseCountinteger nullable

Number of purchases

purchaseAmountnumber double nullable

Purchase amount

broadcastListIdstring nullable

ID of the mailing list

listMode'external' | 'internal'

::API.Modules.Broadcasts.Broadcast.ListMode::

extendedFilterJsonstring nullable

::API.Modules.Broadcasts.Broadcast.ExtendedFilterJson::

createdByAdminIdstring nullable

ID of the admin who created the broadcast

softDeletedByAdminIdstring nullable

ID of the admin who deleted the broadcast

emailTemplateIdstring nullable

ID of the email template

emailTemplateMode'existing' | 'new'

Email template mode

customEmailTemplateJsonstring nullable

Custom email template as JSON

abortedByAdminIdstring nullable

ID of the admin who canceled the broadcast

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

type'manual' | 'dynamic'

Type

extendedFilterJsonstring nullable

Advanced filter as JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

broadcastIdstring required

ID of the broadcast

fileIdstring required

ID of the file

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Schools.School.Name::

descriptionstring nullable

::API.Modules.Schools.School.Description::

numberinteger

::API.Modules.Schools.School.Number::

domainstring required

::API.Modules.Schools.School.Domain::

techDomainPostfixstring nullable

::API.Modules.Schools.School.TechDomainPostfix::

maxEmailsPerHourinteger

::API.Modules.Schools.School.MaxEmailsPerHour::

emailReputationnumber double

::API.Modules.Schools.School.EmailReputation::

emailThrottlingEnabledboolean

::API.Modules.Schools.School.EmailThrottlingEnabled::

customDomainstring nullable

::API.Modules.Schools.School.CustomDomain::

customDomainDnsTarget'unknown' | 'current' | 'legacy' | 'external' | 'none'

::API.Modules.Schools.School.CustomDomainDnsTarget::

customDomainDnsCheckedDatestring date-time nullable

::API.Modules.Schools.School.CustomDomainDnsCheckedDate::

timezoneIdstring nullable

::API.Modules.Schools.School.TimezoneId::

timezoneOffsetstring nullable

::API.Modules.Schools.School.TimezoneOffset::

countryIdstring nullable

::API.Modules.Schools.School.CountryId::

disableOpenRegistrationboolean

::API.Modules.Schools.School.DisableOpenRegistration::

showUnavailableStartedCoursesboolean

::API.Modules.Schools.School.ShowUnavailableStartedCourses::

isForumAvailableboolean

::API.Modules.Schools.School.IsForumAvailable::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

statisticsUpdatedDatestring date-time nullable

::API.Modules.Schools.School.StatisticsUpdatedDate::

jsHeadCodestring nullable

::API.Modules.Schools.School.JsHeadCode::

jsBodyCodestring nullable

::API.Modules.Schools.School.JsBodyCode::

customCodeAllowedboolean

::API.Modules.Schools.School.CustomCodeAllowed::

customCodeEnabledboolean

::API.Modules.Schools.School.CustomCodeEnabled::

leadScoringEnabledboolean

::API.Modules.Schools.School.LeadScoringEnabled::

customCodeFileIdstring nullable

::API.Modules.Schools.School.CustomCodeFileId::

defaultBrandStyleIdstring nullable

::API.Modules.Schools.School.DefaultBrandStyleId::

supportChatEnabledboolean

::API.Modules.Schools.School.SupportChatEnabled::

supportConversationTitlestring nullable

::API.Modules.Schools.School.SupportConversationTitle::

recordInternalCallsboolean

::API.Modules.Schools.School.RecordInternalCalls::

recordCRMCallsboolean

::API.Modules.Schools.School.RecordCRMCalls::

migrationStatus'default' | 'pending' | 'inProgress' | 'completed' | 'aborted' | 'error'

::API.Modules.Schools.School.MigrationStatus::

scheduledDeletingDatestring date-time nullable

::API.Modules.Schools.School.ScheduledDeletingDate::

deletionStatus'default' | 'pending' | 'messageHasBeenSent' | 'completed' | 'error'

::API.Modules.Schools.School.DeletionStatus::

externalIdstring nullable

::API.Modules.Schools.School.ExternalId::

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

::API.Modules.Schools.School.Lang::

type'simple' | 'thirdParty'

::API.Modules.Schools.School.Type::

featuresstring[] nullable

::API.Modules.Schools.School.Features::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Schools.School.Currency::

logoIdstring nullable

::API.Modules.Schools.School.LogoId::

faviconIdstring nullable

::API.Modules.Schools.School.FaviconId::

ownerIdstring nullable

::API.Modules.Schools.School.OwnerId::

studentProfileSettingsIdstring nullable

::API.Modules.Schools.School.StudentProfileSettingsId::

mainSiteDomainIdstring nullable

::API.Modules.Schools.School.MainSiteDomainId::

organizationIdstring nullable

::API.Modules.Schools.School.OrganizationId::

schoolStatisticsIdstring nullable

::API.Modules.Schools.School.SchoolStatisticsId::

currentDomainstring nullable

::API.Modules.Schools.School.CurrentDomain::

isExternalboolean

::API.Modules.Schools.School.IsExternal::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

defaultVideoProvider'cloudVideo' | 'museVideo' | 'custom' | 'kinescope' | 'axl' nullable

::API.Modules.Schools.SchoolMetadata.DefaultVideoProvider::

organisationActivity'existingOnlineSchool' | 'creatingOnlineSchool' | 'studying' | 'technicalSpecialist' | 'other'

::API.Modules.Schools.SchoolMetadata.OrganisationActivity::

organisationActivityOtherstring nullable

::API.Modules.Schools.SchoolMetadata.OrganisationActivityOther::

howDidYouHearAboutUs'internet' | 'wordOfMouth' | 'socialMedia' | 'other'

::API.Modules.Schools.SchoolMetadata.HowDidYouHearAboutUs::

howDidYouHearAboutUsOtherstring nullable

::API.Modules.Schools.SchoolMetadata.HowDidYouHearAboutUsOther::

employeesNumber'lessThan10' | 'from10To25' | 'from50To100' | 'moreThan100'

::API.Modules.Schools.SchoolMetadata.EmployeesNumber::

leadsNumber'lessThan1k' | 'from1kTo5k' | 'from5kTo10k' | 'from10kTo50k' | 'from50kTo100k' | 'moreThan100k'

::API.Modules.Schools.SchoolMetadata.LeadsNumber::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

partnerEmailstring nullable

::API.Modules.Schools.SchoolMetadata.PartnerEmail::

partnerBonusAmountnumber double

::API.Modules.Schools.SchoolMetadata.PartnerBonusAmount::

partnerBonusTransactionIdstring nullable

::API.Modules.Schools.SchoolMetadata.PartnerBonusTransactionId::

billingPromoCodeIdstring nullable

::API.Modules.Schools.SchoolMetadata.BillingPromoCodeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

Admin ID

poststring nullable

Job title

isConfirmedboolean

Confirmed

updatedDatestring date-time

Date the record was last updated.

createdDatestring date-time

Creation date

lastActivityDatestring date-time nullable

Last activity date

emailUnsubscribedboolean

Unsubscribed from emails

emailUnsubscribedDatestring date-time nullable

Email unsubscribe date

softDeletedByAdminIdstring nullable

ID of the admin who soft-deleted the record

chatUserIdstring nullable

Chat user ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailboolean

Email

emailNeedConfirmboolean

Email confirmation required

blockAccessIfEmailUnconfirmedboolean

Block access until email is confirmed

blockEmailChangeboolean

Block email changes

phoneboolean

Phone

phoneRequiredboolean

Phone required

phoneNeedConfirmboolean

Phone confirmation required

blockAccessIfPhoneUnconfirmedboolean

Block access until phone is confirmed

firstNameboolean

First name

firstNameRequiredboolean

First name required

lastNameboolean

Last name

lastNameRequiredboolean

Last name required

middleNameboolean

Middle name

middleNameRequiredboolean

Middle name required

birthdayboolean

Birthday

birthdayRequiredboolean

Birthday required

genderboolean

Gender

genderRequiredboolean

Gender required

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'month' | 'total'

::API.Modules.Schools.SchoolStatistics.Type::

contactsCountinteger

::API.Modules.Schools.SchoolStatistics.ContactsCount::

importedContactsCountinteger

::API.Modules.Schools.SchoolStatistics.ImportedContactsCount::

studentsCountinteger

::API.Modules.Schools.SchoolStatistics.StudentsCount::

activeStudentsCountinteger

::API.Modules.Schools.SchoolStatistics.ActiveStudentsCount::

adminsCountinteger

::API.Modules.Schools.SchoolStatistics.AdminsCount::

sentEmailMessagesCountinteger

::API.Modules.Schools.SchoolStatistics.SentEmailMessagesCount::

chatMessagesCountinteger

::API.Modules.Schools.SchoolStatistics.ChatMessagesCount::

webinarUsersCountinteger

::API.Modules.Schools.SchoolStatistics.WebinarUsersCount::

coursesCountinteger

::API.Modules.Schools.SchoolStatistics.CoursesCount::

sitesCountinteger

::API.Modules.Schools.SchoolStatistics.SitesCount::

siteVisitsCountinteger

::API.Modules.Schools.SchoolStatistics.SiteVisitsCount::

convertedVideoDurationnumber double

::API.Modules.Schools.SchoolStatistics.ConvertedVideoDuration::

videoViewsCountinteger

::API.Modules.Schools.SchoolStatistics.VideoViewsCount::

videoViewsDurationnumber double

::API.Modules.Schools.SchoolStatistics.VideoViewsDuration::

activityDayCountinteger

::API.Modules.Schools.SchoolStatistics.ActivityDayCount::

paymentsAmountnumber double

::API.Modules.Schools.SchoolStatistics.PaymentsAmount::

usedFilesSpaceAmountinteger

::API.Modules.Schools.SchoolStatistics.UsedFilesSpaceAmount::

usedConvertedVideoSpaceAmountinteger

::API.Modules.Schools.SchoolStatistics.UsedConvertedVideoSpaceAmount::

aiTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiTokensAmount::

aiCuratorActiveDaysAmountinteger

::API.Modules.Schools.SchoolStatistics.AiCuratorActiveDaysAmount::

aiAssistantActiveDaysAmountinteger

::API.Modules.Schools.SchoolStatistics.AiAssistantActiveDaysAmount::

aiFunctionTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiFunctionTokensAmount::

aiCuratorTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiCuratorTokensAmount::

aiAssistantTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiAssistantTokensAmount::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

currentIdstring nullable

::API.Modules.Schools.SchoolStatistics.CurrentId::

currentAccelModelProjectModulesSchoolsSchoolStatistics circular
totalAccelModelProjectModulesSchoolsSchoolStatistics circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

balancenumber double

Balance

bonusBalancenumber double

Bonus balance

creditnumber double

Credit

agreedBillingPlanboolean

Agreed billing plan

trialDaysCountinteger

Number of trial days

discountOnMainServicesnumber double

Discount on main services

discountOnExtraServicesnumber double

Discount on extra services

aiSpendCapUsdnumber double nullable

::API.Modules.Schools.SchoolBilling.AiSpendCapUsd::

aiSpendCapsJsonstring nullable

::API.Modules.Schools.SchoolBilling.AiSpendCapsJson::

aiBonusSpentUsdnumber double

::API.Modules.Schools.SchoolBilling.AiBonusSpentUsd::

telephonySpendCapUsdnumber double nullable

::API.Modules.Schools.SchoolBilling.TelephonySpendCapUsd::

stripeCustomerIdstring nullable

::API.Modules.Schools.SchoolBilling.StripeCustomerId::

stripeSubscriptionIdstring nullable

::API.Modules.Schools.SchoolBilling.StripeSubscriptionId::

stripeSubscriptionStatusstring nullable

::API.Modules.Schools.SchoolBilling.StripeSubscriptionStatus::

billingAnchorDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.BillingAnchorDate::

scheduledBillingPlanIdstring nullable

::API.Modules.Schools.SchoolBilling.ScheduledBillingPlanId::

scheduledPlanChangeDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.ScheduledPlanChangeDate::

hasScheduledPlanChangeboolean

::API.Modules.Schools.SchoolBilling.HasScheduledPlanChange::

trialReminderSentDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialReminderSentDate::

trialEndedNoticeSentDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialEndedNoticeSentDate::

autoRechargeboolean

Auto-recharge

autoRechargeAmountnumber double

Auto-recharge amount

autoRechargeBalancenumber double

Auto-recharge balance

createdDatestring date-time

Creation date

recalculateFromDatestring date-time nullable

Recalculate from date

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

billingPlanIdstring required

Billing plan ID

autoRechargePaymentMethodIdstring nullable

Auto-recharge payment method ID

trialCompletedDatestring date-time nullable

Trial end date

totalBalancenumber double

Total balance

totalBalanceWithCreditnumber double

Total balance with credit

trialEndExclusiveDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialEndExclusiveDate::

isAwaitingSubscriptionboolean

::API.Modules.Schools.SchoolBilling.IsAwaitingSubscription::

isLockedboolean

Locked

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isRegistrationAgreementEnabledboolean

::API.Modules.Schools.SchoolSettings.IsRegistrationAgreementEnabled::

registrationAgreementTextstring nullable

::API.Modules.Schools.SchoolSettings.RegistrationAgreementText::

isCookieNotificationEnabledboolean

::API.Modules.Schools.SchoolSettings.IsCookieNotificationEnabled::

cookieNotificationTextstring nullable

::API.Modules.Schools.SchoolSettings.CookieNotificationText::

isPageFooterEnabledboolean

::API.Modules.Schools.SchoolSettings.IsPageFooterEnabled::

footerTextstring nullable

::API.Modules.Schools.SchoolSettings.FooterText::

isLearnPageFooterEnabledboolean

::API.Modules.Schools.SchoolSettings.IsLearnPageFooterEnabled::

userSessionCountLimitEnabledboolean

::API.Modules.Schools.SchoolSettings.UserSessionCountLimitEnabled::

userSessionCountLimitinteger

::API.Modules.Schools.SchoolSettings.UserSessionCountLimit::

deductionEnabledboolean

::API.Modules.Schools.SchoolSettings.DeductionEnabled::

deductionnumber double

::API.Modules.Schools.SchoolSettings.Deduction::

outboundCallCountryMode'all' | 'allowList' | 'denyList'

::API.Modules.Schools.SchoolSettings.OutboundCallCountryMode::

outboundCallCountriesstring nullable

::API.Modules.Schools.SchoolSettings.OutboundCallCountries::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

currentStepstring nullable

::API.Modules.Schools.SchoolMigration.CurrentStep::

totalCountinteger

::API.Modules.Schools.SchoolMigration.TotalCount::

processedCountinteger

::API.Modules.Schools.SchoolMigration.ProcessedCount::

errorstring nullable

::API.Modules.Schools.SchoolMigration.Error::

settingsJsonstring nullable

::API.Modules.Schools.SchoolMigration.SettingsJson::

additionalDataJsonstring nullable

::API.Modules.Schools.SchoolMigration.AdditionalDataJson::

source'postgreSql' | 'warehousePostgreSql' | 's3' | 'webhook' | 'kinescope' | 'emails'

::API.Modules.Schools.SchoolMigration.Source::

status'default' | 'pending' | 'inProgress' | 'completed' | 'aborted' | 'error'

::API.Modules.Schools.SchoolMigration.Status::

scheduledDatestring date-time

::API.Modules.Schools.SchoolMigration.ScheduledDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time nullable

::API.Modules.Schools.SchoolMigration.BeginDate::

endDatestring date-time nullable

::API.Modules.Schools.SchoolMigration.EndDate::

durationInMinutesinteger

::API.Modules.Schools.SchoolMigration.DurationInMinutes::

progressnumber float

::API.Modules.Schools.SchoolMigration.Progress::

sourceProgressnumber float

::API.Modules.Schools.SchoolMigration.SourceProgress::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.AdminId::

stepsJsonstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.StepsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.CompletedDate::

pausedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.PausedDate::

pauseCountinteger

::API.Modules.Schools.SchoolImplementationOnboarding.PauseCount::

feedbackRatinginteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackRating::

feedbackCommentstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackComment::

feedbackSubmittedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackSubmittedDate::

feedbackSubmittedByAdminIdstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackSubmittedByAdminId::

progressPercentinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressPercent::

progressStepsHandledinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressStepsHandled::

progressStepsTotalinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressStepsTotal::

progressUpdatedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressUpdatedDate::

isCompletedboolean

::API.Modules.Schools.SchoolImplementationOnboarding.IsCompleted::

isPausedboolean

::API.Modules.Schools.SchoolImplementationOnboarding.IsPaused::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

middleNamestring nullable

Middle name

lastNamestring nullable

Last name

phonestring nullable

Phone

phoneE164string nullable

Phone in E.164 format

commentstring nullable

Comment

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

gender'male' | 'female' | 'other' nullable

Gender

birthdaystring date-time nullable

Birthday

emailConfirmationSentDatestring date-time nullable

Date the email confirmation was sent

phoneConfirmationSentDatestring date-time nullable

Date the phone confirmation was sent

registrationDatestring date-time nullable

Registration date

lastActivityDatestring date-time nullable

Last activity date

updatedDatestring date-time nullable

Date the record was last updated.

lastSeenDatestring date-time nullable

Last seen date

createdDatestring date-time

Creation date

emailLastClickDatestring date-time nullable

Date of the last click in an email

emailLastOpenDatestring date-time nullable

Date an email was last opened

concurrencyStampstring nullable

Concurrency stamp

isSchoolEmailConfirmedboolean

Email address verified in the Student Portal

isEmailConfirmedboolean

Email address verified

isPhoneConfirmedboolean

Phone number verified

isTemporaryboolean

Temporary

isRegistrationAgreementAcceptedboolean nullable

Registration agreement accepted

needChangePasswordboolean

Password change required

mergingboolean nullable

Merging

bannedboolean nullable

Banned

commentsBannedboolean nullable

::API.Modules.Students.Student.CommentsBanned::

emailUnsubscribedboolean

Unsubscribed from emails

emailUnsubscribedDatestring date-time nullable

Date unsubscribed from emails

doNotCallboolean

::API.Modules.Students.Student.DoNotCall::

doNotCallDatestring date-time nullable

::API.Modules.Students.Student.DoNotCallDate::

leadPriorityinteger nullable

::API.Modules.Students.Student.LeadPriority::

leadPriorityTier'none' | 'cold' | 'warm' | 'hot'

::API.Modules.Students.Student.LeadPriorityTier::

leadPriorityProbabilitynumber double nullable

::API.Modules.Students.Student.LeadPriorityProbability::

leadPriorityLiftnumber double nullable

::API.Modules.Students.Student.LeadPriorityLift::

leadPriorityReasonsJsonstring nullable

::API.Modules.Students.Student.LeadPriorityReasonsJson::

leadPriorityDatestring date-time nullable

::API.Modules.Students.Student.LeadPriorityDate::

countrystring nullable

Country

citystring nullable

City

regionstring nullable

Region

ipstring nullable

IP address

timezoneIdstring nullable

Time zone ID

timezoneJsonstring nullable

Time zone (JSON)

webinarCountinteger

Number of webinars

paymentsAmountnumber double

Total payment amount

paymentsAmountUsdnumber double nullable

Total payment amount in USD

paymentsCountnumber double

Number of payments

bonusBalancenumber double

Bonus balance

enterUTMSourcestring nullable

First UTM source

enterUTMMediumstring nullable

First UTM medium

enterUTMCampaignstring nullable

First UTM campaign

enterUTMTermstring nullable

First UTM term

enterUTMContentstring nullable

First UTM content

exitUTMSourcestring nullable

Last UTM source

exitUTMMediumstring nullable

Last UTM medium

exitUTMCampaignstring nullable

Last UTM campaign

exitUTMTermstring nullable

Last UTM term

exitUTMContentstring nullable

Last UTM content

normalizedCommunicationsstring nullable

Normalized contact channels

onlineStatus'offline' | 'online'

Online status

avatarIdstring nullable

Avatar ID

chatUserIdstring nullable

Chat user ID

partnerIdstring nullable

Affiliate ID

partnerExpireDatestring date-time nullable

Affiliate expiration date

externalIdstring nullable

External ID

tagsstring[] nullable

Tags

groupsstring[] nullable

Groups

hasFirstNameboolean

Has first name

hasLastNameboolean

Has last name

hasEmailboolean

Has email

hasPhoneboolean

Has phone

hasPhoneE164boolean

Has E.164 phone number

hasAvatarIdboolean

Has avatar ID

hasBirthdayboolean

Has birthday

hasGenderboolean

Has gender

hasPaymentsboolean

Has payments

hasConcurrencyStampboolean

Has concurrency stamp

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

repetitiveboolean

Whether the license is a renewal

type'course' | 'coursePlan' | 'productPackage' | 'flowDate' | 'library' | 'product' | 'allCourses' | 'allLibraries' nullable

Type

state'active' | 'paused'

State

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

creditEndDatestring date-time nullable

Grace period end date

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expirationEventTriggeredboolean

Expiration event triggered

suspendedPeriodInSecinteger

Suspension period, in seconds

renewalCountLimitEnabledboolean

Renewal limit enabled

renewalCountLimitinteger nullable

Renewal limit

studentIdstring required

Contact ID

productPackageIdstring nullable

Product package ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Plan ID

libraryAccessIdstring nullable

Library access ID

dateFlowIdstring nullable

Cohort dates ID

productIdstring nullable

Product ID

purchaseOrderIdstring nullable

Order ID

currentRenewalIdstring nullable

Current renewal ID

currentSuspensionIdstring nullable

Current suspension ID

paymentMethodIdstring nullable

Payment method ID

gamificationProductIdstring nullable

Gamification product ID

hasOrderIdboolean

Has an order ID

isCourseboolean

Course

isLibraryboolean

Library

isFlowDateboolean

Cohort dates

isProductboolean

Product

isAllCousesboolean

All courses

isAllLibrariesboolean

All libraries

relevance'past' | 'present' | 'future'

Validity status

hasCourseIdboolean

Has a course ID

hasCoursePlanIdboolean

Has a plan ID

hasFlowDateIdboolean

Has a cohort dates ID

hasProductIdboolean

Has a product ID

hasLibraryItemIdsboolean

Has library step IDs

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.StudentRole.Name::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.Users.StudentRoleLink.StudentId::

studentRoleIdstring required

::API.Modules.Users.StudentRoleLink.StudentRoleId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

beginDatestring date-time nullable

Start date

endDatestring date-time nullable

End date

lastActivityDatestring date-time nullable

Last activity date

state'notStarted' | 'inProgress' | 'ended'

State

progressnumber float

Progress

scoreinteger

Score

feedbackstring nullable

Feedback

studentIdstring required

Contact ID

courseIdstring required

Course ID

currentCourseItemIdstring nullable

Current course step ID

hasFeedbackboolean

Has feedback

flowBeginDatestring date-time nullable

Cohort start date

accessBeginDatestring date-time nullable

Access start date

accessEndDatestring date-time nullable

Access end date

isSubscriptionboolean

Subscription

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.Students.StudentApplicationSchoolLink.StudentId::

applicationSchoolLinkIdstring required

::API.Modules.Students.StudentApplicationSchoolLink.ApplicationSchoolLinkId::

settingsJsonstring nullable

::API.Modules.Students.StudentApplicationSchoolLink.SettingsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time

Start date

completeDatestring date-time nullable

Completion date

precompleteDatestring date-time nullable

Preliminary completion date

theoryStatusboolean nullable

Theory status

testStatusboolean nullable

Test status

taskStatus'default' | 'started' | 'pending' | 'completed' nullable

Assignment status

status'default' | 'opened'

Status

numberUncheckedTasksinteger

Number of assignments not yet reviewed

numberCorrectTasksinteger

Number of assignments answered correctly

numberIncorrectTasksinteger

Number of assignments answered incorrectly

scoreinteger

Score

courseItemIdstring required

Step ID

ratingIdstring nullable

Rating ID

studentCourseIdstring required

ID of the contact's course enrollment

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

status'default' | 'pending' | 'incorrect' | 'correct' | 'incomplete' | 'editing'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastStudentCommentDatestring date-time nullable

Last contact comment date

lastAdminCommentDatestring date-time nullable

Last admin comment date

lastStudentCommentSeenByAdminDatestring date-time nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.LastStudentCommentSeenByAdminDate::

studentIdstring nullable

Contact ID

courseItemTaskIdstring required

Assignment ID

applicationSchoolLinkIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.ApplicationSchoolLinkId::

aiCuratorTaskReviewIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.AiCuratorTaskReviewId::

studentCourseItemProgressIdstring required

ID of the contact's progress on the course step

courseIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.CourseId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

stringValuestring nullable

String

booleanValueboolean nullable

Boolean value

listValuestring nullable

List

listLabelValuestring nullable

List of labels

multiListValuestring nullable

Multi-select list

multiListLabelValuestring nullable

Multi-select list labels

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fieldIdstring nullable

Field ID

answerIdstring required

Answer ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isRightboolean

Is correct

studentIdstring required

Contact ID

courseItemTestIdstring required

Test ID

studentCourseItemProgressIdstring required

ID of the contact's progress on the course step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

commentstring nullable

Comment

studentCourseItemTaskAnswerIdstring required

Answer ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

schoolLinkIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswerComment.SchoolLinkId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

commentstring nullable

Comment

ratinginteger

Rating

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sectionType'course' | 'library'

Section type

studentIdstring required

Contact ID

courseItemIdstring nullable

Course step ID

libraryItemIdstring nullable

Library step ID

studentCourseItemProgressIdstring nullable

ID of the contact's progress on the course step

studentLibraryItemProgressIdstring nullable

ID of the contact's progress on the library step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

groupIdstring required

Group ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

studentIdstring required

::API.Modules.Students.StudentProduct.StudentId::

productIdstring required

::API.Modules.Students.StudentProduct.ProductId::

orderIdstring nullable

::API.Modules.Students.StudentProduct.OrderId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

completedDatestring date-time nullable

Completion date

blockingNodePayloadJsonstring nullable

Payload JSON of the step the run is waiting on

scenarioIdstring required

Automation ID

studentIdstring required

Contact ID

initialNodeIdstring required

Starting step ID

lastExecutedNodeIdstring nullable

Last executed step ID

blockingNodeIdstring nullable

ID of the step the run is waiting on

completedByAdminIdstring nullable

ID of the admin who completed the run

chatConversationIdstring nullable

Chat conversation ID

webinarIdstring nullable

Webinar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

broadcastListIdstring required

Mailing list ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

webinarIdstring required

Webinar ID

webinarUserIdstring required

Webinar attendee ID

presenceDurationInSecinteger

Time spent in the webinar, in seconds

presenceMinutesinteger[] nullable

::API.Modules.Users.StudentWebinarLink.PresenceMinutes::

presenceMinutesCountinteger

::API.Modules.Users.StudentWebinarLink.PresenceMinutesCount::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

cardFirstSixDigitsstring nullable

First six digits of the card

cardLastFourDigitsstring nullable

Last four digits of the card

cardExpMonthinteger nullable

Card expiration month

cardExpYearinteger nullable

Card expiration year

externalIdstring nullable

External ID

settingsJsonstring nullable

Settings JSON

gatewayIdstring required

Payment gateway ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

attemptinteger

Attempts

errorstring nullable

Error

status'process' | 'success' | 'fail' | 'cancel'

Status

tryDatestring date-time nullable

Attempt date

durationInDaysnumber double

Duration in days

trialboolean nullable

Trial

licenseIdstring required

License ID

orderIdstring nullable

Order ID

paymentIdstring nullable

Payment ID

paymentMethodIdstring nullable

Payment method ID

gamificationProductIdstring nullable

Gamification product ID

originalProductIdstring nullable

Original product ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

Start date

endDatestring date-time

End date

licenseIdstring required

License ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

externalNamestring nullable

External nickname

externalFirstNamestring nullable

External first name

externalLastNamestring nullable

External last name

type'email' | 'vk' | 'tg' | 'vb' | 'fb' | 'wa' | 'ig' | 'line' | 'phone' | 'threads'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

unsubscribedboolean nullable

Unsubscribed

unsubscribedDatestring date-time nullable

Unsubscribe date

confirmedboolean nullable

Confirmed

confirmationTokenstring nullable

Confirmation token

confirmationTokenSentDatestring date-time nullable

Date the confirmation token was sent

confirmationAttemptsLeftinteger

Confirmation attempts left

confirmationType'tgGateway' | 'sms'

Confirmation type

blockedUntilstring date-time nullable

Blocked until

sendingsLeftinteger

Messages left to send

studentIdstring nullable

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sourceIdstring required

::API.Modules.Students.StudentDuplicateLink.SourceId::

targetIdstring required

::API.Modules.Students.StudentDuplicateLink.TargetId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

amountnumber double

Amount

commentstring nullable

Comment

validUntilDatestring date-time nullable

Valid until

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

studentCreatorIdstring nullable

ID of the contact who created the transaction

orderIdstring nullable

Order ID

transactionIdstring nullable

Affiliate program transaction ID

scenarioNodeIdstring nullable

Automation step ID

burnedTransactionIdstring nullable

Expired transaction ID

burnedTransactionAccelModelProjectModulesStudentsStudentBonusTransaction circular
type'deposit' | 'withdrawal'

Type

burnedAmountnumber double nullable

Expired amount

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

lastStudyDatestring date-time nullable

Last study date

continuousStudyStartDatestring date-time nullable

Learning streak start date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Course title

shortDescriptionstring nullable

Brief description of the course

desingStyleHTMLPublishedstring nullable

Published HTML code of the course design style

showOnSiteboolean

Show the course on the website

showInSchoolboolean

Show the course in the Student Portal

showOnlyForWhoHaveAccessboolean

Show course only to users with access

freeAccessboolean

Available for free

isPublishedboolean

Published

dontAskFeedbackboolean

Disable feedback requests

gamificationEnabledboolean

Gamification enabled

isCompleteAnyCourseRequirementboolean

Completing any one of the required courses is enough to start this course

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentCountinteger

Number of students

showIfNoAccessboolean

::API.Modules.Courses.Course.ShowIfNoAccess::

paymentUrlstring nullable

::API.Modules.Courses.Course.PaymentUrl::

appearanceSettingsJsonstring nullable

::API.Modules.Courses.Course.AppearanceSettingsJson::

primaryImageIdstring nullable

Primary image ID

certIdstring nullable

Certificate ID

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

courseIdstring required

Course ID

categoryIdstring required

Category ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

disableTimeLimitsboolean

Disable time limits

isPopularboolean

Popular

courseIdstring required

Course ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

status'processing' | 'correct' | 'incorrect' | 'incomplete' | 'manualReviewRequired' | 'error'

::API.Modules.AI.AiCuratorTaskReview.Status::

commentstring nullable

::API.Modules.AI.AiCuratorTaskReview.Comment::

confidencePercentageinteger

::API.Modules.AI.AiCuratorTaskReview.ConfidencePercentage::

tokensinteger

::API.Modules.AI.AiCuratorTaskReview.Tokens::

errorMessagestring nullable

::API.Modules.AI.AiCuratorTaskReview.ErrorMessage::

internalReasoningstring nullable

::API.Modules.AI.AiCuratorTaskReview.InternalReasoning::

additionalDatastring nullable

::API.Modules.AI.AiCuratorTaskReview.AdditionalData::

studentCourseItemTaskAnswerIdstring required

::API.Modules.AI.AiCuratorTaskReview.StudentCourseItemTaskAnswerId::

schoolLinkIdstring required

::API.Modules.AI.AiCuratorTaskReview.SchoolLinkId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

commentCountinteger

Comment count

allowCommentsboolean

Allow comments

showCommentsboolean

Show comments

disableCommentModerationboolean

Disable comment moderation

blockCourseUntilTasksApprovedboolean

Lock the course until assignments are approved

theoryVisibleboolean

Show theory

tasksVisibleboolean

Show assignments

testsVisibleboolean

Show tests

commentstring nullable

Comment for editors and tutors

type'step' | 'section'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

avgRatingnumber float

Average rating

titlestring nullable

Title

positioninteger

Position

scoreinteger

Score

isOptionalboolean

Optional

isDraftboolean

Draft

availableOnAllPlansboolean

Available on all plans

showRegardlessPlanboolean

Show regardless of plan

ratingEnabledboolean

Enable rating

ratingRequiredboolean

Rating required

ratingCommentRequiredboolean

Comment required with a rating

availability'previousStepCompleted' | 'allPreviousStepsCompleted' | 'regardlessOfPreviousSteps'

Availability

regularTimeDelayActiveboolean

Time delay enabled for a regular purchase or manual course addition

regularTimeDelayinteger nullable

Time delay for regular purchase or manual course addition

regularTimeDelayCondition'previousStep' | 'courseStart' | 'accessStart' | 'previousSectionStarted' | 'previousSectionCompleted' nullable

Time delay conditions for regular purchase or manual addition of a course

regularTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Time delay unit for a regular purchase or manual course addition

regularWaitUntilTimeActiveboolean

Wait-until-time rule enabled

regularWaitUntilTimestring date-time nullable

Wait until a specific time

regularWaitUntilTimeDaysOfWeekActiveboolean

Days-of-week rule enabled

regularWaitUntilDaysOfWeekstring[] nullable

Only on certain days of the week

flowTimeDelayActiveboolean

Time delay enabled when the course is taken in a cohort

flowTimeDelayinteger nullable

Time delay when the course is taken in a cohort

flowTimeDelayCondition'previousStep' | 'flowStart' | 'courseStart' | 'previousSectionStarted' | 'previousSectionCompleted' nullable

Time delay conditions when the course is taken in a cohort

flowTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Time delay unit when the course is taken in a cohort

flowWaitUntilTimeActiveboolean

Wait-until-time rule enabled when the course is taken in a cohort

flowWaitUntilTimestring date-time nullable

Wait until a specific time when the course is taken in a cohort

flowWaitUntilTimeDaysOfWeekActiveboolean

Days-of-week rule enabled when the course is taken in a cohort

flowWaitUntilDaysOfWeekstring[] nullable

Only on specific days of the week when the course is taken in a cohort

dateDelayActiveboolean

Specific-date availability enabled

dateDelaystring date-time nullable

Available after a specific date

preventCopingAndSelectingTextboolean

Prevent text copying and selection

numberNestedStepsinteger

Number of nested steps

layoutType'legacy' | 'custom'

::API.Modules.Courses.CourseItem.LayoutType::

customTheoryHtmlstring nullable

::API.Modules.Courses.CourseItem.CustomTheoryHtml::

brandStyleIdstring nullable

::API.Modules.Courses.CourseItem.BrandStyleId::

parentItemIdstring nullable

Parent item ID

needCheckRegularTimeDelayboolean

Time delay must be checked

needCheckFlowTimeDelayboolean

Time delay must be checked when the course is taken in a cohort

needCheckDateDelayboolean

Specific-date availability must be checked

needCheckRegularWaitUntilTimeDelayboolean

Wait-until-time rule must be checked

needCheckRegularWaitUntilTimeDaysOfWeekboolean

Days-of-week rule must be checked

needCheckFlowWaitUntilTimeDelayboolean

Wait-until-time rule must be checked when the course is taken in a cohort

needCheckFlowWaitUntilTimeDaysOfWeekboolean

Days-of-week rule must be checked when the course is taken in a cohort

needCheckRatingCommentboolean

Rating comment must be checked

isStepboolean

Is a step

numberCompletedStepsinteger

Number of completed steps

hasAccessboolean

Has access

disableTimeLimitsboolean

Time limits disabled

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

courseItemIdstring required

Step ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

courseItemIdstring required

Step ID

coursePlanIdstring required

Plan ID

attachedDatestring date-time

Date attached

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

state'moderation' | 'published' | 'notPublished'

State

sectionType'course' | 'library'

Section type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring nullable

Course step ID

libraryItemIdstring nullable

Library step ID

parentIdstring nullable

Parent comment ID

parentAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment circular
replyIdstring nullable

Reply ID

replyAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment circular
studentIdstring nullable

Contact ID

toStudentIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItemComment.ToStudentId::

schoolContentItemProgressRatingIdstring nullable

Rating ID

adminIdstring nullable

Admin ID

childrenAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment[] circular
repliesAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

descriptionstring nullable

Description

questionstring nullable

Question

correctAnswerstring nullable

Correct answer

disableVerificationboolean

Disable review

disableAiCuratorReviewboolean

::API.Modules.Courses.CourseItemTask.DisableAiCuratorReview::

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

placeholderstring nullable

Placeholder

descriptionstring nullable

Description

requiredboolean

Required

positioninteger

Position

additionalDatastring nullable

Additional data

type'textField' | 'textArea' | 'checkbox' | 'multiSelect' | 'monoSelect'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

taskIdstring required

Assignment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

descriptionstring nullable

Description

minPercentageCompletioninteger

Minimum passing percentage

minScoreCompletioninteger

Minimum passing score

type'simple'

Type

countingMethod'percent' | 'score'

Scoring method

positioninteger

Position

shuffleboolean

Shuffle

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

answerstring nullable

Answer

isCorrectboolean

Correct

positioninteger

Position

courseItemTestQuestionIdstring required

Question ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

questionstring nullable

Question

positioninteger

Position

scoreinteger

Score

multiAnswerboolean

Multiple answers

shuffleboolean

Shuffle

answersJsonstring nullable

Answers in JSON

type'simple' | 'correlation' | 'order' | 'missingWords' | 'choosingCorrectOption'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemTestIdstring required

Test ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'session' | 'rightsChanged' | 'bulkActionSession' | 'externalImport' | 'fileManager' | 'gamificationAchievement' | 'resetGamification' | 'aiCurator' | 'aiAssistant'

::API.Modules.Notifications.NotificationTemplate.Type::

headerstring nullable

::API.Modules.Notifications.NotificationTemplate.Header::

bodystring nullable

::API.Modules.Notifications.NotificationTemplate.Body::

requiredSendEmailboolean

::API.Modules.Notifications.NotificationTemplate.RequiredSendEmail::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

denyAccessContentAfterEndboolean

Block access to content after the cohort ends

denyAccessContentBeforeStartboolean

Block access to content before the cohort starts

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

namestring nullable

Name

beginDatestring date-time

Start date

endDatestring date-time

End date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

courseIdstring required

Course ID

coursePlanIdstring nullable

Course plan ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

flowIdstring required

Cohort ID

forumThreadIdstring required

Forum thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

libraryAccessIdstring required

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

colorstring nullable

Color

positioninteger

Position

type'contact' | 'order' | 'messageTemplate'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type0 | 100 | 150 | 155 | 200 | 205 | 210 | 215 | 300 | 305 | 400 | 405 | 500 | 505 | 600 | 605 | 650 | 655 | 656 | 680 | 685 | 700 | 800 | 805 | 900 | 905 | 910 | 1000 | 1005 | 1100 | 1105 | 1110 | 1115 | 1150 | 1155 | 1500 | 1600 | 1650 | 1700 | 1750 | 1770 | 1775 | 1785 | 1800 | 1801 | 1850 | 1900 | 1950 | 1955 | 1960 | 1965 | 1970 | 1975 | 1980 | 1985 | 1990 | 1995 | 2000 | 2100 | 2200 | 2300 | 2400 | 2500 | 2600 | 2700 | 2800 | 2840 | 2850 | 2855 | 2900 | 2950 | 3000 | 3050 | 3100 | 3300 | 3400 | 3500 | 3600 | 3650 | 3700 | 3800 | 3900 | 4000 | 4100 | 4200 | 4300 | 4400 | 4500 | 4600 | 4700 | 4800 | 4900 | 5000 | 5100 | 5200 | 5300 | 5301 | 5302 | 5350 | 5400 | 5401 | 5402 | 5500 | 6000 | 6100 | 7001 | 8000 | 8100 | 8200 | 9100 | 10000 | 10100 | 10101 | 10200 | 10201 | 10300 | 10301 | 10302 | 10303 | 10304 | 11005 | 11010 | 11015 | 12001 | 13001 | 14001 | 15001 | 16001 | 16005 | 16010 | 17001 | 18001 | 18002 | 18003 | 19001 | 19002 | 20001 | 20002 | 21001 | 22001 | 22002 | 23001 | 23002 | 24001 | 25001 | 25002 | 26001 | 27001 | 28001 | 28002 | 28100 | 29001 | 30001 | 30002 | 31001 | 31002 | 32001 | 32002 | 33001 | 33002 | 33021 | 33022 | 34001 | 34002 | 35001 | 35002 | 35003 | 35005 | 36001 | 36002 | 37001 | 37002

Type

parentType0 | 100 | 150 | 155 | 200 | 205 | 210 | 215 | 300 | 305 | 400 | 405 | 500 | 505 | 600 | 605 | 650 | 655 | 656 | 680 | 685 | 700 | 800 | 805 | 900 | 905 | 910 | 1000 | 1005 | 1100 | 1105 | 1110 | 1115 | 1150 | 1155 | 1500 | 1600 | 1650 | 1700 | 1750 | 1770 | 1775 | 1785 | 1800 | 1801 | 1850 | 1900 | 1950 | 1955 | 1960 | 1965 | 1970 | 1975 | 1980 | 1985 | 1990 | 1995 | 2000 | 2100 | 2200 | 2300 | 2400 | 2500 | 2600 | 2700 | 2800 | 2840 | 2850 | 2855 | 2900 | 2950 | 3000 | 3050 | 3100 | 3300 | 3400 | 3500 | 3600 | 3650 | 3700 | 3800 | 3900 | 4000 | 4100 | 4200 | 4300 | 4400 | 4500 | 4600 | 4700 | 4800 | 4900 | 5000 | 5100 | 5200 | 5300 | 5301 | 5302 | 5350 | 5400 | 5401 | 5402 | 5500 | 6000 | 6100 | 7001 | 8000 | 8100 | 8200 | 9100 | 10000 | 10100 | 10101 | 10200 | 10201 | 10300 | 10301 | 10302 | 10303 | 10304 | 11005 | 11010 | 11015 | 12001 | 13001 | 14001 | 15001 | 16001 | 16005 | 16010 | 17001 | 18001 | 18002 | 18003 | 19001 | 19002 | 20001 | 20002 | 21001 | 22001 | 22002 | 23001 | 23002 | 24001 | 25001 | 25002 | 26001 | 27001 | 28001 | 28002 | 28100 | 29001 | 30001 | 30002 | 31001 | 31002 | 32001 | 32002 | 33001 | 33002 | 33021 | 33022 | 34001 | 34002 | 35001 | 35002 | 35003 | 35005 | 36001 | 36002 | 37001 | 37002 nullable

Parent permission type

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminSchoolIdstring required

Team member ID

rightIdstring required

Permission ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

policyIdstring required

Policy ID

parentIdstring required

Parent policy ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

policyIdstring required

Policy ID

rightIdstring required

Permission ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminSchoolIdstring required

Team member ID

policyIdstring required

Policy ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

filterIdstring required

Filter ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

siteIdstring nullable

Website ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

entityType'lead' | 'purchaseOrder' | 'purchaseOrderPayment' | 'chatUser' | 'quizAnswer' | 'webinarChatMessage' | 'courseItemRating' | 'webinarEvent' | 'webinarUser' | 'courseItemComment' | 'courseFeedback'

Entity type

type'export' | 'import'

Type

state'idle' | 'active' | 'finished' | 'error'

State

exportFormat'xlsx' | 'csv' | 'json' nullable

Export format

createdDatestring date-time

Creation date

endDatestring date-time nullable

End date

countinteger

Count

processedCountinteger

Processed count

percentnumber float

Percent

errorstring nullable

Error

namestring nullable

Name

qualityReportJsonstring nullable

::API.Modules.Imports.ImportExportSession.QualityReportJson::

addedCountinteger

Added count

updatedCountinteger

Updated count

skippedCountinteger

Skipped count

isCanceledboolean

Canceled

filterstring nullable

Filter

fieldsstring nullable

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the response body for the full list of fields.

adminIdstring required

Admin ID

fileIdstring nullable

File ID

chatChannelIdstring nullable

Chat channel ID

hasChatChannelIdboolean

Has chat channel ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sessionIdstring required

::API.Modules.Imports.ImportExportSessionEntityLink.SessionId::

studentIdstring nullable

::API.Modules.Imports.ImportExportSessionEntityLink.StudentId::

chatUserIdstring nullable

::API.Modules.Imports.ImportExportSessionEntityLink.ChatUserId::

actionType'none' | 'created' | 'updated'

::API.Modules.Imports.ImportExportSessionEntityLink.ActionType::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

keyNamestring nullable

Key name

additionalDatastring nullable

Additional data

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

positioninteger

Position

limitedAccessboolean

Limited access

hideInViewboolean

Hide from the contact card

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String

valueNumericnumber double nullable

Number

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time

valueDatestring date-time nullable

Date

valueListstring nullable

List

valueMultiListstring nullable

Multi-select list

additionalDatastring nullable

Additional data

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

leadIdstring required

Contact ID

leadAttributeIdstring required

Attribute ID

hasValueListboolean

Contains a list of values

hasValueMultiListboolean

Contains a multi-select list of values

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

isDraftboolean

Whether the conversation is a draft

memberCountinteger

Number of members

externalIdstring nullable

External ID

creatorUnsubscribedboolean

Creator unsubscribed

creatorUnsubscribedReasonstring nullable

Reason the creator unsubscribed

createdDatestring date-time

Creation date

lastActivityDatestring date-time nullable

Last activity date

creatorLastActivityDatestring date-time nullable

Date of the creator's last activity

type'support' | 'normal' | 'group'

Type

state'new' | 'opened' | 'closed' | 'aiAssistant'

State

creatorUserIdstring nullable

ID of the user who created the conversation

creatorMemberIdstring nullable

ID of the member who created the conversation

channelIdstring nullable

ID of the channel

lastMessageFromMemberIdstring nullable

ID of the member who sent the last message

currentStudentScenarioIdstring nullable

ID of the contact's current automation run

aiAssistantIdstring nullable

::API.Modules.Chats.ChatConversation.AiAssistantId::

lastMessageIdstring nullable

ID of the last message

lastMessageTextstring nullable

Last message text

lastMessageIndexinteger

Last message index

lastDeliveredMessageIndexinteger

Last delivered message index

aiAssistantState'thinking' | 'callHuman' | 'spam' nullable

::API.Modules.Chats.ChatConversation.AiAssistantState::

aiAssistantSpamBlockUntilDatestring date-time nullable

::API.Modules.Chats.ChatConversation.AiAssistantSpamBlockUntilDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Whether the member is active

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncedDatestring date-time nullable

Last sync date

lastSeenMessageIndexinteger nullable

Last seen message index

conversationIdstring nullable

ID of the conversation

userIdstring nullable

ID of the user

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

lastNamestring nullable

Last name

userNamestring nullable

Username

phonestring nullable

Phone

externalIdstring nullable

External ID

metadatastring nullable

Metadata

isSystemboolean

Whether the user is a system user

createdDatestring date-time nullable

Creation date

syncDatestring date-time nullable

Last sync date

lastSeenDatestring date-time nullable

Last seen date

channelType'accel' | 'vk' | 'tg' | 'vb' | 'fb' | 'wazzup24' | 'wa' | 'ig' | 'line' | 'smsc' | 'twilio' | 'ringCentral' | 'axlPhone' | 'site'

Channel type

adminIdstring nullable

ID of the admin

studentIdstring nullable

Contact ID

callUserIdstring nullable

ID of the telephony user

aiAssistantIdstring nullable

::API.Modules.Chats.ChatUser.AiAssistantId::

avatarJsonstring nullable

Avatar as JSON

type'guest' | 'student' | 'admin' | 'school' | 'aiAssistant'

Type

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

settingsJsonstring nullable

Channel settings as JSON

webhookIdstring nullable

Webhook ID

externalIdstring nullable

External ID

privateIdstring nullable

::API.Modules.Chats.ChatChannel.PrivateId::

type'accel' | 'vk' | 'tg' | 'vb' | 'fb' | 'wazzup24' | 'wa' | 'ig' | 'line' | 'smsc' | 'twilio' | 'ringCentral' | 'axlPhone' | 'site'

Type

userCountinteger

Number of users

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

broadcastDisabledboolean

Broadcasts disabled

disabledboolean

Disabled

disabledReasonstring nullable

Reason the channel was disabled

numberinteger

Number

colorstring nullable

Color

defaultChatBotIdstring nullable

ID of the default chatbot

oAuthTokenIdstring nullable

::API.Modules.Chats.ChatChannel.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

type'simple' | 'webinar'

Type

numberinteger

Number

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phrasestring required

Phrase

executionTimesinteger

Number of times the phrase was triggered

createdDatestring date-time

Creation date

chatBotIdstring required

ID of the chatbot

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

namestring required

Name

externalIdstring required

External ID

languagestring nullable

Language

sourceJsonstring nullable

Source JSON

targetJsonstring nullable

Target JSON

errorstring nullable

Error

status'approved' | 'inAppeal' | 'pending' | 'rejected' | 'pendingDeletion' | 'deleted' | 'disabled' | 'paused' | 'limitExceeded' | 'flagged' | 'unflagged' | 'reinstated' | 'deferred' | 'unknown'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

channelIdstring required

ID of the channel

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

canStudentCreateTopicsboolean

Whether users can create topics

isPublishedboolean

Whether the thread is published

isLimitedAccessboolean

Whether access is limited

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

Last activity date

topicCountinteger

Topic count

commentCountinteger

Comment count

parentThreadIdstring nullable

Parent thread ID

parentThreadAccelModelProjectModulesForumForumThread circular
updatedByAdminIdstring nullable

ID of the admin who last updated the thread

childrenAccelModelProjectModulesForumForumThread[] circular
designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring required

Thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring required

Thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

Last activity date

commentCountinteger

Comment count

likeCountinteger

Like count

dislikeCountinteger

Dislike count

threadIdstring required

Thread ID

studentIdstring required

Contact ID

lastCommentIdstring nullable

Last comment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sequenceNumberinteger

Sequence number

likeCountinteger

Like count

dislikeCountinteger

Dislike count

replyToCommentIdstring nullable

ID of the comment being replied to

replyToCommentAccelModelProjectModulesForumForumTopicComment circular
topicIdstring required

Topic ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'like' | 'dislike'

Type

studentIdstring required

Contact ID

topicIdstring nullable

Topic ID

commentIdstring nullable

Comment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring nullable

Thread ID

topicIdstring nullable

Topic ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

reasonstring nullable

Reason

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

commentIdstring nullable

Comment ID

topicIdstring nullable

Topic ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.Name::

filterJsonstring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.FilterJson::

type'personal' | 'global'

::API.Modules.ExtendedFilters.ExtendedFilter.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'voximplant' | 'zadarma' | 'onlinePbx' | 'novofon' | 'mangoOffice' | 'ringCentral' | 'kcell' | 'twilio' | 'retell' | 'axlTelephony'

Type

settingsJsonstring nullable

Settings as JSON

externalIdstring nullable

External ID

saveCallRecordsboolean

Save call recordings

transcribeCallsboolean

::API.Modules.Calls.SchoolCallAccount.TranscribeCalls::

analyzeCallsboolean

::API.Modules.Calls.SchoolCallAccount.AnalyzeCalls::

activeboolean

Active

identifierinteger

Identifier

namestring nullable

Name

emailstring nullable

Email

apiKeystring nullable

API key

passwordstring nullable

Password

sessionIdstring nullable

Session ID

parentIdstring nullable

ID of the parent account

parentAccelModelProjectModulesCallsSchoolCallAccount circular
currentCallApplicationIdstring nullable

ID of the current call application

callSubUserIdstring nullable

ID of the call account sub-user

oAuthTokenIdstring nullable

::API.Modules.Calls.SchoolCallAccount.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

namestring nullable

Name

secureRecordStorageboolean

Secure recording storage

callAccountIdstring nullable

ID of the call account

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'voximplant' | 'zadarma' | 'onlinePbx' | 'novofon' | 'mangoOffice' | 'ringCentral' | 'kcell' | 'twilio' | 'retell' | 'axlTelephony'

Type

settingsJsonstring nullable

Settings in JSON format

externalIdstring nullable

External ID

numberstring nullable

Number

activeboolean

Active

namestring nullable

Name

displayNamestring nullable

Display name

passwordstring nullable

Password

identifierinteger

Identifier

schoolCallAccountIdstring nullable

Telephony account ID

callApplicationIdstring nullable

Call application ID

chatUserIdstring nullable

Chat user ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

isIncomingboolean

Incoming call

durationInSecnumber double

Duration in seconds

orderPaymentAmountnumber double

Order payment amount

providerCallCostnumber double

Provider call cost

platformCallCostnumber double

Platform call cost

providerRecordCostnumber double

Provider recording cost

platformRecordCostnumber double

Platform recording cost

providerResourseCostnumber double

Provider resource cost

platformResourseCostnumber double

Platform resource cost

totalProviderCostnumber double

Total provider cost

totalPlatformCostnumber double

Total platform cost

costBreakdownstring nullable

::API.Modules.Calls.SchoolCallSession.CostBreakdown::

providerSessionIdstring nullable

::API.Modules.Calls.SchoolCallSession.ProviderSessionId::

costReconciledDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.CostReconciledDate::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

descriptionstring nullable

Description

startDatestring date-time nullable

Start date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

Completion date

state'inProgress' | 'completed' | 'failed' | 'waitingForCompletion' | 'answered' | 'rejected' | 'canceled' | 'busy' | 'timeExpired' | 'disabled' | 'unprocessedType' | 'voicemail' | 'notAvailable' | 'notAllowed' | 'missed'

State

analysisState'none' | 'skipped' | 'pending' | 'completed' | 'failed'

::API.Modules.Calls.SchoolCallSession.AnalysisState::

source'unknown' | 'inbound' | 'softphone' | 'scenario' | 'manual' | 'batch' | 'campaign' | 'assistant'

::API.Modules.Calls.SchoolCallSession.Source::

sourceScenarioIdstring nullable

::API.Modules.Calls.SchoolCallSession.SourceScenarioId::

transcriptstring nullable

::API.Modules.Calls.SchoolCallSession.Transcript::

summarystring nullable

::API.Modules.Calls.SchoolCallSession.Summary::

aiInterest'low' | 'medium' | 'high' nullable

::API.Modules.Calls.SchoolCallSession.AiInterest::

aiObjection'none' | 'price' | 'time' | 'notAFit' | 'trust' | 'other' nullable

::API.Modules.Calls.SchoolCallSession.AiObjection::

aiAgreedstring nullable

::API.Modules.Calls.SchoolCallSession.AiAgreed::

aiCallbackTextstring nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackText::

aiCallbackLocalstring nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackLocal::

aiCallbackDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackDate::

analysisErrorstring nullable

::API.Modules.Calls.SchoolCallSession.AnalysisError::

analyzedDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.AnalyzedDate::

aiPriceTokensnumber double

::API.Modules.Calls.SchoolCallSession.AiPriceTokens::

aiCostUsdnumber double

::API.Modules.Calls.SchoolCallSession.AiCostUsd::

hangupCause'unallocatedNumber' | 'noRouteTransitNet' | 'noRouteDestination' | 'channelUnacceptable' | 'normalClearing' | 'userBusy' | 'noUserResponse' | 'noAnswer' | 'subscriberAbsent' | 'callRejected' | 'numberChanged' | 'redirectionToNewDestination' | 'exchangeRoutingError' | 'destinationOutOfOrder' | 'invalidNumberFormat' | 'facilityRejected' | 'normalUnspecified' | 'normalCircuitCongestion' | 'networkOutOfOrder' | 'normalTemporaryFailure' | 'switchCongestion' | 'accessInfoDiscarded' | 'requestedChanUnAvail' | 'facilityNotSubscribed' | 'outgoingCallBarred' | 'incomingCallBarred' | 'serviceUnavailable' | 'bearerCapabilityNotImpl' | 'chanNotImplemented' | 'facilityNotImplemented' | 'serviceNotImplemented' | 'invalidCallReference' | 'incompatibleDestination' | 'invalidMsgUnspecified' | 'mandatoryIeMissing' | 'messageTypeNonExist' | 'wrongMessage' | 'ieNonExist' | 'invalidIeContents' | 'wrongCallState' | 'recoveryOnTimerExpire' | 'mandatoryIeLengthError' | 'protocolError' | 'interWorking' | 'originatorCancel' | 'crash' | 'systemShutdown' | 'loseRace' | 'managerRequest' | 'blindTransfer' | 'attendedTransfer' | 'allottedTimeout' | 'userChallenge' | 'mediaTimeout' | 'pickedOff' | 'userNotRegistered' | 'progressTimeout' | 'gatewayDown' | 'invalidGateway' | 'pickup' | 'supervising' | 'takeOver' | 'timeout' | 'rccTransfer' | 'callerInputRedirect' | 'callFlip' | 'parkLocation' | 'dtmfTransfer' | 'agentAnswered' | 'agentDropped' | 'rejected' | 'cancelled' | 'internalError' | 'targetBusy' | 'invalidNumber' | 'internationalDisabled' | 'destinationBlocked' | 'notEnoughFunds' | 'noSuchUser' | 'callRedirected' | 'callReplied' | 'callFinished' | 'callDropped' | 'clientCalledBack' | 'calledBack' | 'didntCallBack' | 'couldntGetThrough' nullable

Reason the call ended

missReasonstring nullable

::API.Modules.Calls.SchoolCallSession.MissReason::

outcomeIdstring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeId::

outcomeNotestring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeNote::

outcomeByAdminIdstring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeByAdminId::

outcomeDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.OutcomeDate::

fromUserIdstring nullable

ID of the caller

toUserIdstring nullable

ID of the call recipient

sipRegistrationIdstring nullable

ID of the SIP registration

chatConversationIdstring nullable

ID of the chat conversation

callAccountIdstring nullable

ID of the call account

phoneNumberIdstring nullable

::API.Modules.Calls.SchoolCallSession.PhoneNumberId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

incomingboolean nullable

Incoming call

successfulboolean

Successful

durationInSecnumber double

Duration in seconds

providerCostnumber double

Provider cost

platformCostnumber double

Platform cost

startDatestring date-time nullable

Start date

providerTransactionIdinteger nullable

Provider transaction ID

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

descriptionstring nullable

Description

fromNumberstring nullable

Phone number the call was made from

toNumberstring nullable

Phone number the call was made to

identifierinteger

Identifier

fromUserIdstring nullable

ID of the caller

toUserIdstring nullable

ID of the call recipient

sipRegistrationIdstring nullable

ID of the SIP registration

sessionIdstring required

ID of the call session

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

startDatestring date-time nullable

Start date

durationInSecnumber double

Duration in seconds

providerCostnumber double

Provider cost

platformCostnumber double

Platform cost

namestring nullable

Name

urlstring nullable

URL

providerTransactionIdinteger nullable

Provider transaction ID

state'awaitingDownload' | 'downloading' | 'downloadingFailed' | 'uploading' | 'uploadingFailed' | 'deleting' | 'deletingFailed' | 'completed'

State

sessionIdstring required

ID of the call session

fileIdstring nullable

ID of the file

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Calls.SchoolCallOutcome.Name::

kind'neutral' | 'positive' | 'negative'

::API.Modules.Calls.SchoolCallOutcome.Kind::

positioninteger

::API.Modules.Calls.SchoolCallOutcome.Position::

isSeededboolean

::API.Modules.Calls.SchoolCallOutcome.IsSeeded::

suggestsFollowUpboolean

::API.Modules.Calls.SchoolCallOutcome.SuggestsFollowUp::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

identifierinteger

Identifier

externalIdstring nullable

External ID

domainstring required

Domain

loginstring required

Username

passwordstring nullable

Password

lastErrorMessagestring nullable

Last error message

providerCostnumber double

Provider cost

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

purchaseDatestring date-time nullable

Purchase date

nextSubscriptionRenewalDatestring date-time nullable

Next subscription renewal date

status'none' | 'inProgress' | 'verified' | 'diactivated' | 'error'

Status

callAccountIdstring required

ID of the call account

oAuthTokenIdstring nullable

::API.Modules.Calls.SchoolCallSIPRegistration.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sipRegistrationIdstring required

ID of the SIP registration

schoolAdminIdstring required

ID of the account admin

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

namestring nullable

Name

passwordstring nullable

Password

callAccountIdstring required

ID of the call account

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'retell' | 'axl'

::API.Modules.Voice.VoiceCall.Provider::

externalIdstring nullable

::API.Modules.Voice.VoiceCall.ExternalId::

agentIdstring nullable

::API.Modules.Voice.VoiceCall.AgentId::

agentNamestring nullable

::API.Modules.Voice.VoiceCall.AgentName::

fromNumberstring nullable

::API.Modules.Voice.VoiceCall.FromNumber::

toNumberstring nullable

::API.Modules.Voice.VoiceCall.ToNumber::

incomingboolean

::API.Modules.Voice.VoiceCall.Incoming::

status'unknown' | 'registered' | 'ongoing' | 'completed' | 'notAnswered' | 'busy' | 'failed' | 'voicemail'

::API.Modules.Voice.VoiceCall.Status::

disconnectionReasonstring nullable

::API.Modules.Voice.VoiceCall.DisconnectionReason::

durationInSecnumber double

::API.Modules.Voice.VoiceCall.DurationInSec::

startDatestring date-time nullable

::API.Modules.Voice.VoiceCall.StartDate::

endDatestring date-time nullable

::API.Modules.Voice.VoiceCall.EndDate::

createdDatestring date-time

Creation date

providerCostUsdnumber double

::API.Modules.Voice.VoiceCall.ProviderCostUsd::

aiPriceTokensnumber double

::API.Modules.Voice.VoiceCall.AiPriceTokens::

aiCostUsdnumber double

::API.Modules.Voice.VoiceCall.AiCostUsd::

recordingUrlstring nullable

::API.Modules.Voice.VoiceCall.RecordingUrl::

transcriptstring nullable

::API.Modules.Voice.VoiceCall.Transcript::

summarystring nullable

::API.Modules.Voice.VoiceCall.Summary::

outcomeKeystring nullable

::API.Modules.Voice.VoiceCall.OutcomeKey::

outcomeTitlestring nullable

::API.Modules.Voice.VoiceCall.OutcomeTitle::

outcomeReasonstring nullable

::API.Modules.Voice.VoiceCall.OutcomeReason::

extractedVariablesJsonstring nullable

::API.Modules.Voice.VoiceCall.ExtractedVariablesJson::

sourcestring nullable

::API.Modules.Voice.VoiceCall.Source::

requestedOutcomesJsonstring nullable

::API.Modules.Voice.VoiceCall.RequestedOutcomesJson::

requestedVariablesJsonstring nullable

::API.Modules.Voice.VoiceCall.RequestedVariablesJson::

studentIdstring nullable

::API.Modules.Voice.VoiceCall.StudentId::

scenarioNodeIdstring nullable

::API.Modules.Voice.VoiceCall.ScenarioNodeId::

studentScenarioIdstring nullable

::API.Modules.Voice.VoiceCall.StudentScenarioId::

adminIdstring nullable

::API.Modules.Voice.VoiceCall.AdminId::

instructionsstring nullable

::API.Modules.Voice.VoiceCall.Instructions::

campaignIdstring nullable

::API.Modules.Voice.VoiceCall.CampaignId::

quizIdstring nullable

::API.Modules.Voice.VoiceCall.QuizId::

quizSnapshotIdstring nullable

::API.Modules.Voice.VoiceCall.QuizSnapshotId::

quizAnswerIdstring nullable

::API.Modules.Voice.VoiceCall.QuizAnswerId::

quizFilledboolean nullable

::API.Modules.Voice.VoiceCall.QuizFilled::

orderIdstring nullable

::API.Modules.Voice.VoiceCall.OrderId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

kind'campaign' | 'single'

::API.Modules.Voice.Campaigns.VoiceCampaign.Kind::

namestring required

::API.Modules.Voice.Campaigns.VoiceCampaign.Name::

agentIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.AgentId::

scenarioIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.ScenarioId::

callNodeIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.CallNodeId::

filterJsonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FilterJson::

status'draft' | 'running' | 'paused' | 'finished' | 'cancelled' | 'scheduled'

::API.Modules.Voice.Campaigns.VoiceCampaign.Status::

concurrencyinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.Concurrency::

callWindowEnabledboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowEnabled::

callWindowFromMinutesinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowFromMinutes::

callWindowToMinutesinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowToMinutes::

timezoneIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.TimezoneId::

createdByAdminIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.CreatedByAdminId::

assistantDialogIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.AssistantDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

scheduledStartDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.ScheduledStartDate::

startedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.StartedDate::

finishedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FinishedDate::

finishReasonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FinishReason::

totalCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.TotalCount::

queuedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.QueuedCount::

runningCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.RunningCount::

doneCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.DoneCount::

answeredCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.AnsweredCount::

notAnsweredCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.NotAnsweredCount::

voicemailCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.VoicemailCount::

failedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.FailedCount::

skippedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.SkippedCount::

isActiveboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.IsActive::

isOverboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.IsOver::

hasFilterboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.HasFilter::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

campaignIdstring required

::API.Modules.Voice.Campaigns.VoiceCampaignContact.CampaignId::

studentIdstring required

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StudentId::

phoneE164string nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.PhoneE164::

recipientTimezonesstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.RecipientTimezones::

status'queued' | 'running' | 'done' | 'skipped'

::API.Modules.Voice.Campaigns.VoiceCampaignContact.Status::

skipReasonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.SkipReason::

studentScenarioIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StudentScenarioId::

attemptsinteger

::API.Modules.Voice.Campaigns.VoiceCampaignContact.Attempts::

lastCallIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.LastCallId::

lastCallStatus'unknown' | 'registered' | 'ongoing' | 'completed' | 'notAnswered' | 'busy' | 'failed' | 'voicemail' nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.LastCallStatus::

outcomeKeystring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.OutcomeKey::

outcomeTitlestring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.OutcomeTitle::

createdDatestring date-time

Creation date

startedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StartedDate::

finishedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.FinishedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolTelephonyAccount.ProviderType::

subAccountSidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SubAccountSid::

authTokenstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.AuthToken::

isAuthTokenEncryptedboolean

::API.Modules.Telephony.SchoolTelephonyAccount.IsAuthTokenEncrypted::

softphoneApiKeySidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneApiKeySid::

softphoneApiKeySecretstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneApiKeySecret::

isSoftphoneApiKeySecretEncryptedboolean

::API.Modules.Telephony.SchoolTelephonyAccount.IsSoftphoneApiKeySecretEncrypted::

softphoneAppSidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneAppSid::

status'notConnected' | 'active' | 'suspended' | 'closed'

::API.Modules.Telephony.SchoolTelephonyAccount.Status::

statusReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.StatusReason::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

connectedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.ConnectedDate::

suspendedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SuspendedDate::

closedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.ClosedDate::

callAccountIdstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.CallAccountId::

hasSoftphoneboolean

::API.Modules.Telephony.SchoolTelephonyAccount.HasSoftphone::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

telephonyAccountIdstring required

::API.Modules.Telephony.SchoolPhoneNumber.TelephonyAccountId::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolPhoneNumber.ProviderType::

providerSidstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderSid::

phoneE164string required

::API.Modules.Telephony.SchoolPhoneNumber.PhoneE164::

friendlyNamestring nullable

::API.Modules.Telephony.SchoolPhoneNumber.FriendlyName::

countrystring nullable

::API.Modules.Telephony.SchoolPhoneNumber.Country::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.SchoolPhoneNumber.Kind::

capabilities'none' | 'voice' | 'sms' | 'mms'

::API.Modules.Telephony.SchoolPhoneNumber.Capabilities::

voiceEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.VoiceEnabled::

smsEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.SmsEnabled::

mmsEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.MmsEnabled::

recordCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.RecordCalls::

transcribeCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.TranscribeCalls::

analyzeCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.AnalyzeCalls::

announceRecordingboolean

::API.Modules.Telephony.SchoolPhoneNumber.AnnounceRecording::

recordingNoticeMode'everyone' | 'requiredStatesOnly' | 'never'

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeMode::

recordingNoticeAcceptedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeAcceptedDate::

recordingNoticeAcceptedByAdminIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeAcceptedByAdminId::

outboundCountryMode'all' | 'allowList' | 'denyList'

::API.Modules.Telephony.SchoolPhoneNumber.OutboundCountryMode::

outboundCountriesstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.OutboundCountries::

useForCheaperOutboundboolean

::API.Modules.Telephony.SchoolPhoneNumber.UseForCheaperOutbound::

inboundRouteType'none' | 'softphone' | 'forwardExternal' | 'voicemail' | 'scenario' | 'aiAgent'

::API.Modules.Telephony.SchoolPhoneNumber.InboundRouteType::

inboundRouteTargetstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundRouteTarget::

inboundAgentIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentId::

inboundRingSecondsinteger nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundRingSeconds::

inboundVoicemailOnMissboolean

::API.Modules.Telephony.SchoolPhoneNumber.InboundVoicemailOnMiss::

inboundAgentFallback'none' | 'team' | 'admins'

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentFallback::

inboundAgentFallbackAdminIdsstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentFallbackAdminIds::

chatChannelIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ChatChannelId::

complianceIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ComplianceId::

status'active' | 'restricted' | 'pendingRelease' | 'released' | 'pendingActivation'

::API.Modules.Telephony.SchoolPhoneNumber.Status::

providerMonthlyCostUsdnumber double

::API.Modules.Telephony.SchoolPhoneNumber.ProviderMonthlyCostUsd::

monthlyPriceUsdnumber double

::API.Modules.Telephony.SchoolPhoneNumber.MonthlyPriceUsd::

purchasedDatestring date-time

::API.Modules.Telephony.SchoolPhoneNumber.PurchasedDate::

nextChargeDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.NextChargeDate::

lastChargedPeriodstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.LastChargedPeriod::

scheduledReleaseDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ScheduledReleaseDate::

releasedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ReleasedDate::

updatedDatestring date-time nullable

Date the record was last updated.

providerOrderIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderOrderId::

providerSubOrderIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderSubOrderId::

regulatoryProfileIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryProfileId::

regulatoryStatusstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryStatus::

regulatoryRejectionstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryRejection::

activatedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ActivatedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneNumberIdstring required

::API.Modules.Telephony.SchoolPhoneNumberAdmin.PhoneNumberId::

adminIdstring required

::API.Modules.Telephony.SchoolPhoneNumberAdmin.AdminId::

canCallboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.CanCall::

canSendSmsboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.CanSendSms::

isPrimaryboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.IsPrimary::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

telephonyAccountIdstring required

::API.Modules.Telephony.SchoolTelephonyCompliance.TelephonyAccountId::

kind'smsBrandCampaign' | 'regulatoryBundle' | 'internationalSms'

::API.Modules.Telephony.SchoolTelephonyCompliance.Kind::

status'none' | 'draft' | 'submitted' | 'approved' | 'rejected' | 'cancelled'

::API.Modules.Telephony.SchoolTelephonyCompliance.Status::

providerBrandSidstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ProviderBrandSid::

providerCampaignSidstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ProviderCampaignSid::

applicationJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ApplicationJson::

aiFilledFieldsJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.AiFilledFieldsJson::

rejectionReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.RejectionReason::

submissionFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.SubmissionFeeUsd::

monthlyFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.MonthlyFeeUsd::

feeChargedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.FeeChargedDate::

vettingRequestedboolean

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingRequested::

vettingFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingFeeUsd::

vettingStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingStatus::

vettingScoreinteger nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingScore::

vettingOrderedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingOrderedDate::

nextChargeDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.NextChargeDate::

lastChargedPeriodstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.LastChargedPeriod::

createdDatestring date-time

Creation date

submittedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.SubmittedDate::

decisionDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.DecisionDate::

cancelledDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.CancelledDate::

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

countrystring required

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Country::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Kind::

status'draft' | 'submitted' | 'approved' | 'declined'

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Status::

valuesJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ValuesJson::

providerGroupIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ProviderGroupId::

providerGroupStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ProviderGroupStatus::

declineReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.DeclineReason::

confirmedByAdminIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ConfirmedByAdminId::

confirmedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ConfirmedDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

profileIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProfileId::

requirementIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.RequirementId::

fileIdstring required

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.FileId::

fileNamestring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.FileName::

contentTypestring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ContentType::

sizeinteger

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.Size::

sha256string nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.Sha256::

providerDocumentIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProviderDocumentId::

providerStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProviderStatus::

uploadedByAdminIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.UploadedByAdminId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

chargeType'outboundCallMinutes' | 'inboundCallMinutes' | 'outboundSmsSegments' | 'inboundSmsSegments' | 'numberMonthlyRent' | 'numberPurchase' | 'complianceApplication' | 'complianceMonthlyFee' | 'callRecording' | 'brandVetting' | 'campaignUpfront' | 'callWebRtcMinutes' | 'callControlMinutes' | 'callMediaMinutes'

::API.Modules.Telephony.SchoolTelephonyCharge.ChargeType::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderType::

quantitynumber double

::API.Modules.Telephony.SchoolTelephonyCharge.Quantity::

providerCostUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderCostUsd::

priceUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCharge.PriceUsd::

occurredDatestring date-time

::API.Modules.Telephony.SchoolTelephonyCharge.OccurredDate::

periodstring required

::API.Modules.Telephony.SchoolTelephonyCharge.Period::

phoneNumberIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.PhoneNumberId::

sourceEntityIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.SourceEntityId::

providerReferencestring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderReference::

idempotencyKeystring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.IdempotencyKey::

invoiceIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.InvoiceId::

descriptionstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.Description::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.Telephony.PlatformPhoneNumber.PhoneE164::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.PlatformPhoneNumber.ProviderType::

providerSidstring nullable

::API.Modules.Telephony.PlatformPhoneNumber.ProviderSid::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.PlatformPhoneNumber.Kind::

purpose'none' | 'assistant' | 'opsAlerts'

::API.Modules.Telephony.PlatformPhoneNumber.Purpose::

messagingProfileIdstring nullable

::API.Modules.Telephony.PlatformPhoneNumber.MessagingProfileId::

notestring nullable

::API.Modules.Telephony.PlatformPhoneNumber.Note::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Domains.AccountDomain.Name::

unicodeNamestring nullable

::API.Modules.Domains.AccountDomain.UnicodeName::

tldstring nullable

::API.Modules.Domains.AccountDomain.Tld::

origin'purchased' | 'transferredIn' | 'connected'

::API.Modules.Domains.AccountDomain.Origin::

status'pending' | 'active' | 'failed' | 'transferPending' | 'expired' | 'redemption' | 'transferredOut' | 'released' | 'awaitingVerification' | 'awaitingDelegation'

::API.Modules.Domains.AccountDomain.Status::

dnsMode'axl' | 'custom' | 'external'

::API.Modules.Domains.AccountDomain.DnsMode::

zoneIdstring nullable

::API.Modules.Domains.AccountDomain.ZoneId::

zoneStatus'none' | 'active' | 'deleting' | 'deleted' | 'error'

::API.Modules.Domains.AccountDomain.ZoneStatus::

zoneDeleteAfterstring date-time nullable

::API.Modules.Domains.AccountDomain.ZoneDeleteAfter::

nameServersJsonstring nullable

::API.Modules.Domains.AccountDomain.NameServersJson::

delegationVerifiedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.DelegationVerifiedDate::

dnsMoveJsonstring nullable

::API.Modules.Domains.AccountDomain.DnsMoveJson::

delegationCheckedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.DelegationCheckedDate::

ownershipTokenstring nullable

::API.Modules.Domains.AccountDomain.OwnershipToken::

ownershipVerifiedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.OwnershipVerifiedDate::

registrar'none' | 'nameCom'

::API.Modules.Domains.AccountDomain.Registrar::

registeredDatestring date-time nullable

::API.Modules.Domains.AccountDomain.RegisteredDate::

expiresDatestring date-time nullable

::API.Modules.Domains.AccountDomain.ExpiresDate::

autoRenewboolean

::API.Modules.Domains.AccountDomain.AutoRenew::

privacyEnabledboolean

::API.Modules.Domains.AccountDomain.PrivacyEnabled::

transferLockedboolean

::API.Modules.Domains.AccountDomain.TransferLocked::

transferLockUntilstring date-time nullable

::API.Modules.Domains.AccountDomain.TransferLockUntil::

contactVerification'unknown' | 'pending' | 'verified' | 'suspended'

::API.Modules.Domains.AccountDomain.ContactVerification::

renewalPriceUsdnumber double nullable

::API.Modules.Domains.AccountDomain.RenewalPriceUsd::

renewalCostUsdnumber double nullable

::API.Modules.Domains.AccountDomain.RenewalCostUsd::

registrarSyncedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.RegistrarSyncedDate::

freeFirstYearboolean

::API.Modules.Domains.AccountDomain.FreeFirstYear::

contactIdstring nullable

::API.Modules.Domains.AccountDomain.ContactId::

dnsMonthlyPriceUsdnumber double

::API.Modules.Domains.AccountDomain.DnsMonthlyPriceUsd::

nextDnsChargeDatestring date-time nullable

::API.Modules.Domains.AccountDomain.NextDnsChargeDate::

expiryNoticeStageinteger

::API.Modules.Domains.AccountDomain.ExpiryNoticeStage::

provisioningJsonstring nullable

::API.Modules.Domains.AccountDomain.ProvisioningJson::

provisioningStep'none' | 'charged' | 'zoneCreated' | 'registered' | 'recordsApplied' | 'usagesAttached' | 'completed'

::API.Modules.Domains.AccountDomain.ProvisioningStep::

lastErrorstring nullable

::API.Modules.Domains.AccountDomain.LastError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

::API.Modules.Domains.AccountDomain.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainIdstring required

::API.Modules.Domains.DomainDnsRecord.DomainId::

namestring required

::API.Modules.Domains.DomainDnsRecord.Name::

type'a' | 'aaaa' | 'cname' | 'mx' | 'txt' | 'srv' | 'caa' | 'ns' | 'alias'

::API.Modules.Domains.DomainDnsRecord.Type::

valuestring required

::API.Modules.Domains.DomainDnsRecord.Value::

priorityinteger nullable

::API.Modules.Domains.DomainDnsRecord.Priority::

weightinteger nullable

::API.Modules.Domains.DomainDnsRecord.Weight::

portinteger nullable

::API.Modules.Domains.DomainDnsRecord.Port::

ttlinteger

::API.Modules.Domains.DomainDnsRecord.Ttl::

source'user' | 'system' | 'imported'

::API.Modules.Domains.DomainDnsRecord.Source::

purpose'none' | 'site' | 'siteWww' | 'lms' | 'siteHost' | 'emailSpf' | 'emailDkim' | 'emailDmarc' | 'emailBounces' | 'emailTracking' | 'emailMx' | 'verification'

::API.Modules.Domains.DomainDnsRecord.Purpose::

syncStatus'pending' | 'synced' | 'error'

::API.Modules.Domains.DomainDnsRecord.SyncStatus::

syncErrorstring nullable

::API.Modules.Domains.DomainDnsRecord.SyncError::

commentstring nullable

::API.Modules.Domains.DomainDnsRecord.Comment::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

updatedByAdminIdstring nullable

::API.Modules.Domains.DomainDnsRecord.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

firstNamestring nullable

::API.Modules.Domains.DomainContact.FirstName::

lastNamestring nullable

::API.Modules.Domains.DomainContact.LastName::

companyNamestring nullable

::API.Modules.Domains.DomainContact.CompanyName::

emailstring nullable

::API.Modules.Domains.DomainContact.Email::

phonestring nullable

::API.Modules.Domains.DomainContact.Phone::

address1string nullable

::API.Modules.Domains.DomainContact.Address1::

address2string nullable

::API.Modules.Domains.DomainContact.Address2::

citystring nullable

::API.Modules.Domains.DomainContact.City::

statestring nullable

::API.Modules.Domains.DomainContact.State::

zipstring nullable

::API.Modules.Domains.DomainContact.Zip::

countrystring nullable

::API.Modules.Domains.DomainContact.Country::

isDefaultboolean

::API.Modules.Domains.DomainContact.IsDefault::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainIdstring required

::API.Modules.Domains.DomainOperation.DomainId::

type'register' | 'renew' | 'transferIn' | 'restore' | 'dnsHosting' | 'setNameservers' | 'lock' | 'unlock' | 'privacyOn' | 'privacyOff' | 'autoRenewOn' | 'autoRenewOff' | 'contactUpdated' | 'authCodeIssued' | 'glueChanged' | 'verificationEmailResent' | 'zoneCreated' | 'zoneDeleted' | 'recordsChanged' | 'recordsImported' | 'attached' | 'detached' | 'ownershipVerified' | 'delegated' | 'transferredOut' | 'movedToAccount' | 'error'

::API.Modules.Domains.DomainOperation.Type::

status'pending' | 'succeeded' | 'failed' | 'cancelled'

::API.Modules.Domains.DomainOperation.Status::

priceUsdnumber double

::API.Modules.Domains.DomainOperation.PriceUsd::

providerCostUsdnumber double

::API.Modules.Domains.DomainOperation.ProviderCostUsd::

yearsinteger nullable

::API.Modules.Domains.DomainOperation.Years::

billingTransactionIdstring nullable

::API.Modules.Domains.DomainOperation.BillingTransactionId::

providerOrderIdstring nullable

::API.Modules.Domains.DomainOperation.ProviderOrderId::

idempotencyKeystring nullable

::API.Modules.Domains.DomainOperation.IdempotencyKey::

periodstring nullable

::API.Modules.Domains.DomainOperation.Period::

detailsJsonstring nullable

::API.Modules.Domains.DomainOperation.DetailsJson::

errorstring nullable

::API.Modules.Domains.DomainOperation.Error::

adminIdstring nullable

::API.Modules.Domains.DomainOperation.AdminId::

createdDatestring date-time

Creation date

completedDatestring date-time nullable

::API.Modules.Domains.DomainOperation.CompletedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainNamestring required

::API.Modules.Domains.DomainAgreementAcceptance.DomainName::

domainIdstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.DomainId::

kind'register' | 'transferIn'

::API.Modules.Domains.DomainAgreementAcceptance.Kind::

adminIdstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AdminId::

adminEmailstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AdminEmail::

ipstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.Ip::

agreementVersionstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AgreementVersion::

documentsJsonstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.DocumentsJson::

yearsinteger

::API.Modules.Domains.DomainAgreementAcceptance.Years::

acceptedDatestring date-time

::API.Modules.Domains.DomainAgreementAcceptance.AcceptedDate::

retainUntilDatestring date-time nullable

::API.Modules.Domains.DomainAgreementAcceptance.RetainUntilDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

registrar'none' | 'nameCom'

::API.Modules.Domains.DomainRegistrarEvent.Registrar::

eventNamestring required

::API.Modules.Domains.DomainRegistrarEvent.EventName::

domainNamestring nullable

::API.Modules.Domains.DomainRegistrarEvent.DomainName::

domainIdstring nullable

::API.Modules.Domains.DomainRegistrarEvent.DomainId::

fingerprintstring required

::API.Modules.Domains.DomainRegistrarEvent.Fingerprint::

payloadJsonstring nullable

::API.Modules.Domains.DomainRegistrarEvent.PayloadJson::

status'pending' | 'applied' | 'ignored' | 'failed'

::API.Modules.Domains.DomainRegistrarEvent.Status::

attemptsinteger

::API.Modules.Domains.DomainRegistrarEvent.Attempts::

errorstring nullable

::API.Modules.Domains.DomainRegistrarEvent.Error::

receivedDatestring date-time

::API.Modules.Domains.DomainRegistrarEvent.ReceivedDate::

processedDatestring date-time nullable

::API.Modules.Domains.DomainRegistrarEvent.ProcessedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialConnection.Provider::

mode'direct' | 'viaFacebookPage'

::API.Modules.Social.SocialConnection.Mode::

providerAccountIdstring required

::API.Modules.Social.SocialConnection.ProviderAccountId::

accountNamestring nullable

::API.Modules.Social.SocialConnection.AccountName::

usernamestring nullable

::API.Modules.Social.SocialConnection.Username::

avatarUrlstring nullable

::API.Modules.Social.SocialConnection.AvatarUrl::

profileUrlstring nullable

::API.Modules.Social.SocialConnection.ProfileUrl::

parentAccountIdstring nullable

::API.Modules.Social.SocialConnection.ParentAccountId::

oAuthTokenIdstring nullable

::API.Modules.Social.SocialConnection.OAuthTokenId::

chatChannelIdstring nullable

::API.Modules.Social.SocialConnection.ChatChannelId::

permissionsJsonstring nullable

::API.Modules.Social.SocialConnection.PermissionsJson::

metadataJsonstring nullable

::API.Modules.Social.SocialConnection.MetadataJson::

status'active' | 'reauthRequired' | 'disabled' | 'error'

::API.Modules.Social.SocialConnection.Status::

followersCountinteger nullable

::API.Modules.Social.SocialConnection.FollowersCount::

mediaCountinteger nullable

::API.Modules.Social.SocialConnection.MediaCount::

lastSyncDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastSyncDate::

lastMetricsDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastMetricsDate::

lastCheckDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastCheckDate::

lastErrorstring nullable

::API.Modules.Social.SocialConnection.LastError::

createdByAdminIdstring nullable

::API.Modules.Social.SocialConnection.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Social.SocialPost.Title::

textstring nullable

::API.Modules.Social.SocialPost.Text::

linkUrlstring nullable

::API.Modules.Social.SocialPost.LinkUrl::

mediaJsonstring nullable

::API.Modules.Social.SocialPost.MediaJson::

firstCommentEnabledboolean

::API.Modules.Social.SocialPost.FirstCommentEnabled::

firstCommentTextstring nullable

::API.Modules.Social.SocialPost.FirstCommentText::

status'draft' | 'scheduled' | 'publishing' | 'published' | 'partiallyPublished' | 'failed'

::API.Modules.Social.SocialPost.Status::

source'manual' | 'imported' | 'ai' | 'api'

::API.Modules.Social.SocialPost.Source::

scheduledDatestring date-time nullable

::API.Modules.Social.SocialPost.ScheduledDate::

publishedDatestring date-time nullable

::API.Modules.Social.SocialPost.PublishedDate::

metricsSummaryJsonstring nullable

::API.Modules.Social.SocialPost.MetricsSummaryJson::

aiDialogIdstring nullable

::API.Modules.Social.SocialPost.AiDialogId::

createdByAdminIdstring nullable

::API.Modules.Social.SocialPost.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

socialPostIdstring required

::API.Modules.Social.SocialPublication.SocialPostId::

socialConnectionIdstring required

::API.Modules.Social.SocialPublication.SocialConnectionId::

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialPublication.Provider::

kind'image' | 'carousel' | 'video' | 'reel' | 'text' | 'link'

::API.Modules.Social.SocialPublication.Kind::

providerPostIdstring nullable

::API.Modules.Social.SocialPublication.ProviderPostId::

permalinkstring nullable

::API.Modules.Social.SocialPublication.Permalink::

adaptedTextstring nullable

::API.Modules.Social.SocialPublication.AdaptedText::

adaptedMediaJsonstring nullable

::API.Modules.Social.SocialPublication.AdaptedMediaJson::

mediaOverrideJsonstring nullable

::API.Modules.Social.SocialPublication.MediaOverrideJson::

status'pending' | 'preparing' | 'publishing' | 'published' | 'failed' | 'skipped'

::API.Modules.Social.SocialPublication.Status::

scheduledDatestring date-time nullable

::API.Modules.Social.SocialPublication.ScheduledDate::

publishedDatestring date-time nullable

::API.Modules.Social.SocialPublication.PublishedDate::

providerContainerIdstring nullable

::API.Modules.Social.SocialPublication.ProviderContainerId::

containerStatusstring nullable

::API.Modules.Social.SocialPublication.ContainerStatus::

attemptinteger

::API.Modules.Social.SocialPublication.Attempt::

errorstring nullable

::API.Modules.Social.SocialPublication.Error::

errorCodestring nullable

::API.Modules.Social.SocialPublication.ErrorCode::

firstCommentTextstring nullable

::API.Modules.Social.SocialPublication.FirstCommentText::

firstCommentEnabledboolean nullable

::API.Modules.Social.SocialPublication.FirstCommentEnabled::

firstCommentStatus'none' | 'pending' | 'published' | 'failed' | 'skipped'

::API.Modules.Social.SocialPublication.FirstCommentStatus::

firstCommentProviderIdstring nullable

::API.Modules.Social.SocialPublication.FirstCommentProviderId::

firstCommentErrorstring nullable

::API.Modules.Social.SocialPublication.FirstCommentError::

isImportedboolean

::API.Modules.Social.SocialPublication.IsImported::

thumbnailFileIdstring nullable

::API.Modules.Social.SocialPublication.ThumbnailFileId::

metricsSummaryJsonstring nullable

::API.Modules.Social.SocialPublication.MetricsSummaryJson::

nextMetricsDatestring date-time nullable

::API.Modules.Social.SocialPublication.NextMetricsDate::

nextCommentsDatestring date-time nullable

::API.Modules.Social.SocialPublication.NextCommentsDate::

lastCommentsDatestring date-time nullable

::API.Modules.Social.SocialPublication.LastCommentsDate::

removedFromProviderDatestring date-time nullable

::API.Modules.Social.SocialPublication.RemovedFromProviderDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

socialPostIdstring required

::API.Modules.Social.SocialComment.SocialPostId::

socialPublicationIdstring required

::API.Modules.Social.SocialComment.SocialPublicationId::

socialConnectionIdstring required

::API.Modules.Social.SocialComment.SocialConnectionId::

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialComment.Provider::

providerCommentIdstring required

::API.Modules.Social.SocialComment.ProviderCommentId::

parentProviderCommentIdstring nullable

::API.Modules.Social.SocialComment.ParentProviderCommentId::

authorProviderIdstring nullable

::API.Modules.Social.SocialComment.AuthorProviderId::

authorNamestring nullable

::API.Modules.Social.SocialComment.AuthorName::

authorUsernamestring nullable

::API.Modules.Social.SocialComment.AuthorUsername::

textstring nullable

::API.Modules.Social.SocialComment.Text::

likeCountinteger nullable

::API.Modules.Social.SocialComment.LikeCount::

replyCountinteger nullable

::API.Modules.Social.SocialComment.ReplyCount::

isOwnboolean

::API.Modules.Social.SocialComment.IsOwn::

isHiddenboolean

::API.Modules.Social.SocialComment.IsHidden::

publishedDatestring date-time

::API.Modules.Social.SocialComment.PublishedDate::

collectedDatestring date-time

::API.Modules.Social.SocialComment.CollectedDate::

removedFromProviderDatestring date-time nullable

::API.Modules.Social.SocialComment.RemovedFromProviderDate::

privateReplyDatestring date-time nullable

::API.Modules.Social.SocialComment.PrivateReplyDate::

privateReplyConversationIdstring nullable

::API.Modules.Social.SocialComment.PrivateReplyConversationId::

rawJsonstring nullable

::API.Modules.Social.SocialComment.RawJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'metaAds' | 'googleAds' | 'tikTokAds' | 'linkedInAds' | 'pinterestAds'

::API.Modules.Advertising.AdConnection.Provider::

providerAccountIdstring required

::API.Modules.Advertising.AdConnection.ProviderAccountId::

accountNamestring nullable

::API.Modules.Advertising.AdConnection.AccountName::

currencystring nullable

::API.Modules.Advertising.AdConnection.Currency::

timezoneNamestring nullable

::API.Modules.Advertising.AdConnection.TimezoneName::

oAuthTokenIdstring nullable

::API.Modules.Advertising.AdConnection.OAuthTokenId::

pageIdstring nullable

::API.Modules.Advertising.AdConnection.PageId::

instagramUserIdstring nullable

::API.Modules.Advertising.AdConnection.InstagramUserId::

pageNamestring nullable

::API.Modules.Advertising.AdConnection.PageName::

instagramUsernamestring nullable

::API.Modules.Advertising.AdConnection.InstagramUsername::

status'active' | 'reauthRequired' | 'disabled' | 'error'

::API.Modules.Advertising.AdConnection.Status::

providerAccountStatusinteger nullable

::API.Modules.Advertising.AdConnection.ProviderAccountStatus::

disableReasoninteger nullable

::API.Modules.Advertising.AdConnection.DisableReason::

hasFundingSourceboolean

::API.Modules.Advertising.AdConnection.HasFundingSource::

defaultUtmJsonstring nullable

::API.Modules.Advertising.AdConnection.DefaultUtmJson::

dsaPayorstring nullable

::API.Modules.Advertising.AdConnection.DsaPayor::

dsaBeneficiarystring nullable

::API.Modules.Advertising.AdConnection.DsaBeneficiary::

defaultSpecialCategory'none' | 'housing' | 'employment' | 'financialProducts' | 'issues'

::API.Modules.Advertising.AdConnection.DefaultSpecialCategory::

minBudgetsJsonstring nullable

::API.Modules.Advertising.AdConnection.MinBudgetsJson::

termsAcceptedDatestring date-time nullable

::API.Modules.Advertising.AdConnection.TermsAcceptedDate::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastSyncDate::

lastInsightsDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastInsightsDate::

lastCheckDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastCheckDate::

accessExpiryNoticeForstring date-time nullable

::API.Modules.Advertising.AdConnection.AccessExpiryNoticeFor::

accessExpiresAtstring date-time nullable

::API.Modules.Advertising.AdConnection.AccessExpiresAt::

lastErrorstring nullable

::API.Modules.Advertising.AdConnection.LastError::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdConnection.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adConnectionIdstring required

::API.Modules.Advertising.AdCampaign.AdConnectionId::

providerCampaignIdstring nullable

::API.Modules.Advertising.AdCampaign.ProviderCampaignId::

namestring required

::API.Modules.Advertising.AdCampaign.Name::

objective'leads' | 'traffic' | 'engagement' | 'awareness' | 'sales'

::API.Modules.Advertising.AdCampaign.Objective::

specialCategory'none' | 'housing' | 'employment' | 'financialProducts' | 'issues'

::API.Modules.Advertising.AdCampaign.SpecialCategory::

specialCategoryCountriesJsonstring nullable

::API.Modules.Advertising.AdCampaign.SpecialCategoryCountriesJson::

status'draft' | 'scheduled' | 'pendingReview' | 'active' | 'paused' | 'completed' | 'rejected' | 'needsAction' | 'archived'

::API.Modules.Advertising.AdCampaign.Status::

providerStatusstring nullable

::API.Modules.Advertising.AdCampaign.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.AdCampaign.ProviderEffectiveStatus::

budgetKind'daily' | 'lifetime'

::API.Modules.Advertising.AdCampaign.BudgetKind::

budgetAmountnumber double nullable

::API.Modules.Advertising.AdCampaign.BudgetAmount::

currencystring nullable

::API.Modules.Advertising.AdCampaign.Currency::

startDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.EndDate::

destinationUrlstring nullable

::API.Modules.Advertising.AdCampaign.DestinationUrl::

utmCampaignstring nullable

Identifies a specific advertising campaign

launchStage'none' | 'campaignCreated' | 'adSetCreated' | 'mediaUploaded' | 'creativeCreated' | 'adCreated' | 'done'

::API.Modules.Advertising.AdCampaign.LaunchStage::

stateVersioninteger

::API.Modules.Advertising.AdCampaign.StateVersion::

providerSettingsJsonstring nullable

::API.Modules.Advertising.AdCampaign.ProviderSettingsJson::

source'wizard' | 'ai' | 'imported' | 'boostedPost'

::API.Modules.Advertising.AdCampaign.Source::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdCampaign.CreatedByAdminId::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.LastSyncDate::

metricsSummaryJsonstring nullable

::API.Modules.Advertising.AdCampaign.MetricsSummaryJson::

lastErrorstring nullable

::API.Modules.Advertising.AdCampaign.LastError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adCampaignIdstring required

::API.Modules.Advertising.AdGroup.AdCampaignId::

providerAdSetIdstring nullable

::API.Modules.Advertising.AdGroup.ProviderAdSetId::

namestring nullable

::API.Modules.Advertising.AdGroup.Name::

targetingJsonstring nullable

::API.Modules.Advertising.AdGroup.TargetingJson::

audienceSpecJsonstring nullable

::API.Modules.Advertising.AdGroup.AudienceSpecJson::

optimizationGoalstring nullable

::API.Modules.Advertising.AdGroup.OptimizationGoal::

billingEventstring nullable

::API.Modules.Advertising.AdGroup.BillingEvent::

promotedObjectJsonstring nullable

::API.Modules.Advertising.AdGroup.PromotedObjectJson::

budgetKind'daily' | 'lifetime'

::API.Modules.Advertising.AdGroup.BudgetKind::

budgetAmountnumber double nullable

::API.Modules.Advertising.AdGroup.BudgetAmount::

startDatestring date-time nullable

::API.Modules.Advertising.AdGroup.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdGroup.EndDate::

providerStatusstring nullable

::API.Modules.Advertising.AdGroup.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.AdGroup.ProviderEffectiveStatus::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdGroup.LastSyncDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adGroupIdstring required

::API.Modules.Advertising.Ad.AdGroupId::

providerAdIdstring nullable

::API.Modules.Advertising.Ad.ProviderAdId::

providerCreativeIdstring nullable

::API.Modules.Advertising.Ad.ProviderCreativeId::

namestring nullable

::API.Modules.Advertising.Ad.Name::

mediaJsonstring nullable

::API.Modules.Advertising.Ad.MediaJson::

primaryTextstring nullable

::API.Modules.Advertising.Ad.PrimaryText::

headlinestring nullable

::API.Modules.Advertising.Ad.Headline::

descriptionstring nullable

::API.Modules.Advertising.Ad.Description::

callToActionstring nullable

::API.Modules.Advertising.Ad.CallToAction::

linkUrlstring nullable

::API.Modules.Advertising.Ad.LinkUrl::

urlTagsstring nullable

::API.Modules.Advertising.Ad.UrlTags::

objectStoryIdstring nullable

::API.Modules.Advertising.Ad.ObjectStoryId::

sourceInstagramMediaIdstring nullable

::API.Modules.Advertising.Ad.SourceInstagramMediaId::

providerStatusstring nullable

::API.Modules.Advertising.Ad.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.Ad.ProviderEffectiveStatus::

reviewFeedbackJsonstring nullable

::API.Modules.Advertising.Ad.ReviewFeedbackJson::

issuesJsonstring nullable

::API.Modules.Advertising.Ad.IssuesJson::

metricsSummaryJsonstring nullable

::API.Modules.Advertising.Ad.MetricsSummaryJson::

qualityRankingstring nullable

::API.Modules.Advertising.Ad.QualityRanking::

engagementRateRankingstring nullable

::API.Modules.Advertising.Ad.EngagementRateRanking::

conversionRateRankingstring nullable

::API.Modules.Advertising.Ad.ConversionRateRanking::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.Ad.LastSyncDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Advertising.AdAudience.Name::

targetingJsonstring nullable

::API.Modules.Advertising.AdAudience.TargetingJson::

estimateJsonstring nullable

::API.Modules.Advertising.AdAudience.EstimateJson::

isSavedboolean

::API.Modules.Advertising.AdAudience.IsSaved::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Advertising.AdChannel.Name::

kind'manual' | 'adAccount' | 'socialPosts' | 'emailBroadcasts'

::API.Modules.Advertising.AdChannel.Kind::

orderinteger

::API.Modules.Advertising.AdChannel.Order::

adConnectionIdstring nullable

::API.Modules.Advertising.AdChannel.AdConnectionId::

autoTagEnabledboolean

::API.Modules.Advertising.AdChannel.AutoTagEnabled::

autoTagAllLinksboolean

::API.Modules.Advertising.AdChannel.AutoTagAllLinks::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdChannel.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adChannelIdstring required

::API.Modules.Advertising.AdActivity.AdChannelId::

namestring required

::API.Modules.Advertising.AdActivity.Name::

descriptionstring nullable

::API.Modules.Advertising.AdActivity.Description::

startDatestring date-time nullable

::API.Modules.Advertising.AdActivity.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdActivity.EndDate::

source'manual' | 'meta' | 'socialPost' | 'broadcast'

::API.Modules.Advertising.AdActivity.Source::

adCampaignIdstring nullable

::API.Modules.Advertising.AdActivity.AdCampaignId::

sourceEntityIdstring nullable

::API.Modules.Advertising.AdActivity.SourceEntityId::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdActivity.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adActivityIdstring required

::API.Modules.Advertising.AdUtmRule.AdActivityId::

adGroupIdstring nullable

::API.Modules.Advertising.AdUtmRule.AdGroupId::

adIdstring nullable

::API.Modules.Advertising.AdUtmRule.AdId::

sourcestring nullable

::API.Modules.Advertising.AdUtmRule.Source::

mediumstring nullable

::API.Modules.Advertising.AdUtmRule.Medium::

campaignstring nullable

::API.Modules.Advertising.AdUtmRule.Campaign::

contentstring nullable

::API.Modules.Advertising.AdUtmRule.Content::

termstring nullable

::API.Modules.Advertising.AdUtmRule.Term::

matchKeystring required

::API.Modules.Advertising.AdUtmRule.MatchKey::

isAutoboolean

::API.Modules.Advertising.AdUtmRule.IsAuto::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adActivityIdstring required

::API.Modules.Advertising.AdSpendEntry.AdActivityId::

amountnumber double

::API.Modules.Advertising.AdSpendEntry.Amount::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Advertising.AdSpendEntry.Currency::

dateFromstring date-time

::API.Modules.Advertising.AdSpendEntry.DateFrom::

dateTostring date-time

::API.Modules.Advertising.AdSpendEntry.DateTo::

commentstring nullable

::API.Modules.Advertising.AdSpendEntry.Comment::

source'manual' | 'csv'

::API.Modules.Advertising.AdSpendEntry.Source::

importIdstring nullable

::API.Modules.Advertising.AdSpendEntry.ImportId::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdSpendEntry.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

Start date

endDatestring date-time

End date

completedDatestring date-time nullable

Completion date

duration'min10' | 'min15' | 'min30' | 'hour' | 'hour2' | 'day' | 'custom'

Duration

status'scheduled' | 'done' | 'undone'

Status

reminder'none' | 'min5' | 'min30' | 'hour' nullable

Reminder

contactIdstring nullable

Contact ID

responsibleAdminIdstring nullable

Assignee ID

studentScenarioProgressIdstring nullable

Contact automation progress ID

creatorByAdminIdstring nullable

ID of the admin who created the task

pipelineItemIdstring nullable

Deal ID

hasScenarioNodeIdboolean

Has automation step ID

hasPipelineItemIdboolean

Has deal ID

outdatedboolean

Overdue

completedboolean

Completed

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminTaskIdstring required

Task ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminTaskIdstring required

Task ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

desingStyleHTMLPublishedstring nullable

Published HTML design style

freeAccessboolean

Available for free

isPublishedboolean

Published

gamificationEnabledboolean

Gamification enabled

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentCountinteger

User count

itemCountinteger

Number of steps

primaryImageIdstring nullable

Primary image ID

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

commentstring nullable

Comment

positioninteger

Position

avgRatingnumber float

Average rating

type'section' | 'step'

Type

isDraftboolean

Draft

ratingEnabledboolean

Rating enabled

ratingCommentRequiredboolean

Rating comment required

preventCopingAndSelectingTextboolean

Prevent copying and selecting text

allowCommentsboolean

Allow comments

showCommentsboolean

Show comments

disableCommentModerationboolean

Disable comment moderation

viewCountinteger

View count

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

flowTimeDelayActiveboolean

Enable delay when the library is taken in a cohort

flowTimeDelayinteger nullable

Delay when the library is taken in a cohort

flowTimeDelayCondition'flowStart' nullable

Delay condition when the library is taken in a cohort

flowTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Delay unit when the library is taken in a cohort

libraryIdstring required

Library ID

parentItemIdstring nullable

Parent item ID

parentItemAccelModelProjectModulesLibrariesLibraryItem circular
childrenAccelModelProjectModulesLibrariesLibraryItem[] circular
canContainChildrenboolean

Can contain child items

needCheckFlowTimeDelayboolean

Whether to check the delay when the library is taken in a cohort

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryItemIdstring required

Library step ID

libraryAccessIdstring required

Library access ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

categoryIdstring required

Category ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

durationnumber float

Duration

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productPackageIdstring required

Product package ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Plan ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productPackageIdstring required

Product package ID

libraryAccessIdstring required

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

nodeCountinteger

Number of steps

additionalDatastring nullable

Additional data

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedStudentScenariosCountinteger

Number of completed runs

activeStudentScenariosCountinteger

Number of active runs

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

sitePageIdstring nullable

Website page ID

flowIdstring nullable

Cohort ID

webinarIdstring nullable

Webinar ID

widgetIdstring nullable

Widget ID

productIdstring nullable

Product ID

chatBotIdstring nullable

Chatbot ID

quizIdstring nullable

Form or quiz ID

pipelineIdstring nullable

Pipeline ID

partnershipIdstring nullable

Affiliate program ID

certIdstring nullable

Certificate ID

chatChannelIdstring nullable

Chat channel ID

telegramGroupIdstring nullable

Telegram group/channel ID

facebookFormIdstring nullable

::API.Modules.Scenarios.Scenario.FacebookFormId::

gamificationIdstring nullable

Gamification ID

gamificationProductIdstring nullable

Gamification product ID

communityIdstring nullable

::API.Modules.Scenarios.Scenario.CommunityId::

meetingIdstring nullable

::API.Modules.Scenarios.Scenario.MeetingId::

socialConnectionIdstring nullable

::API.Modules.Scenarios.Scenario.SocialConnectionId::

voiceCampaignIdstring nullable

::API.Modules.Scenarios.Scenario.VoiceCampaignId::

type'course' | 'courseItem' | 'sitePage' | 'flow' | 'webinar' | 'product' | 'chatBot' | 'widget' | 'simple' | 'quiz' | 'pipeline' | 'partnership' | 'cert' | 'chatChannel' | 'gamification' | 'gamificationProduct' | 'telegramGroup' | 'community' | 'facebookForm' | 'meeting' | 'socialConnection'

Type

isActiveboolean

Active

isMainboolean

::API.Modules.Scenarios.Scenario.IsMain::

targetIdstring nullable

Target ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

settingsJsonstring nullable

JSON settings

payloadstring nullable

Payload

type'event' | 'action' | 'listener'

Type

actionTypestring nullable

Action type

executionCountinteger

Number of executions

listenerCountinteger

Number of contacts waiting at the step

useButtonsOneTimeboolean nullable

Use one-time buttons

purchaseCountinteger nullable

Purchase count

purchaseAmountnumber double nullable

Purchase amount

scenarioIdstring required

Automation ID

hasPayloadboolean

Has payload

hasSettingsJsonboolean

Has JSON settings

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'button' | 'expireButton' | 'custom' | 'aiAssistant' | 'voiceCallOutcome'

Type

payloadJsonstring nullable

Payload (JSON)

executionCountinteger

Number of executions

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

nodeIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

parentNodeIdstring required

Previous step ID

childNodeIdstring required

Next step ID

scenarioIdstring required

Automation ID

portIdstring nullable

Port ID

type'default' | 'success' | 'fail' | 'aborted' | 'repeat' | 'wait'

Type

pointsJsonstring nullable

Connector points (JSON)

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

expirationDatestring date-time nullable

::API.Modules.Scenarios.ScenarioNodeListener.ExpirationDate::

nodeIdstring required

::API.Modules.Scenarios.ScenarioNodeListener.NodeId::

studentScenarioIdstring required

::API.Modules.Scenarios.ScenarioNodeListener.StudentScenarioId::

nodePayloadJsonstring required

::API.Modules.Scenarios.ScenarioNodeListener.NodePayloadJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

executedDatestring date-time

Execution date

scenarioNodeIdstring required

Step ID

studentIdstring required

Contact ID

flowDateIdstring nullable

Cohort date ID

webinarIdstring nullable

Webinar ID

studentLicenseIdstring nullable

Contact license ID

meetingBookingIdstring nullable

::API.Modules.Scenarios.ExecutedScenarioNode.MeetingBookingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

scheduledDatestring date-time

::API.Modules.PlannedActions.PlannedAction.ScheduledDate::

payloadstring nullable

::API.Modules.PlannedActions.PlannedAction.Payload::

scenarioNodeIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodeId::

studentScenarioIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentScenarioId::

adminTaskIdstring nullable

::API.Modules.PlannedActions.PlannedAction.AdminTaskId::

scenarioNodeListenerIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodeListenerId::

scenarioNodePortIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodePortId::

studentLicenseIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentLicenseId::

studentLicenseSuspensionIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentLicenseSuspensionId::

actionNamestring nullable

::API.Modules.PlannedActions.PlannedAction.ActionName::

expiryDatestring date-time nullable

::API.Modules.PlannedActions.PlannedAction.ExpiryDate::

type'scenario' | 'common' | 'scenarioNodeListener'

::API.Modules.PlannedActions.PlannedAction.Type::

hasPayloadboolean

::API.Modules.PlannedActions.PlannedAction.HasPayload::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Brands.BrandStyle.Name::

summarystring nullable

::API.Modules.Brands.BrandStyle.Summary::

isSystemboolean

::API.Modules.Brands.BrandStyle.IsSystem::

sourceStyleIdstring nullable

::API.Modules.Brands.BrandStyle.SourceStyleId::

sourceStyleAccelModelProjectModulesBrandsBrandStyle circular
descriptionMdstring nullable

::API.Modules.Brands.BrandStyle.DescriptionMd::

tokensJsonstring nullable

::API.Modules.Brands.BrandStyle.TokensJson::

previewPageHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewPageHtml::

previewEmailHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewEmailHtml::

previewLessonHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewLessonHtml::

logoFileIdstring nullable

::API.Modules.Brands.BrandStyle.LogoFileId::

logoInverseFileIdstring nullable

::API.Modules.Brands.BrandStyle.LogoInverseFileId::

assetsJsonstring nullable

::API.Modules.Brands.BrandStyle.AssetsJson::

aiDialogIdstring nullable

::API.Modules.Brands.BrandStyle.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

creatorIdstring nullable

::API.Modules.Brands.BrandStyle.CreatorId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

subdomainstring nullable

Subdomain

domainPostfixstring nullable

::API.Modules.Sites.Site.DomainPostfix::

shortDescriptionstring nullable

Short description

enabledboolean

Enabled

headerIntegrationCodestring nullable

Integration code added to the head section of every page

bodyIntegrationCodestring nullable

Integration code added to the body of every page

robotsTxtstring nullable

Contents of the robots.txt file

llmsTxtstring nullable

::API.Modules.Sites.Site.LlmsTxt::

formTermsstring nullable

Form terms

formTermsEnabledboolean

Whether form terms are enabled

formTermsDefaultAcceptedboolean

Whether the form terms checkbox is checked by default

checkoutFormTermsstring nullable

Checkout form terms

checkoutFormTermsEnabledboolean

Whether checkout form terms are enabled

checkoutFormTermsDefaultAcceptedboolean

Whether the checkout form terms checkbox is checked by default

isCookieNotificationEnabledboolean

Whether the cookie notification is enabled

cookieNotificationTextstring nullable

Cookie notification text

mapEnabledboolean

::API.Modules.Sites.Site.MapEnabled::

chatEnabledboolean

::API.Modules.Sites.Site.ChatEnabled::

chatChannelIdstring nullable

::API.Modules.Sites.Site.ChatChannelId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

faviconIdstring nullable

Favicon ID

logoIdstring nullable

Logo ID

siteDomainIdstring nullable

Site domain ID

page404Idstring nullable

404 page ID

createdByAdminIdstring required

ID of the admin who created the site

updatedByAdminIdstring nullable

ID of the admin who last updated the site

softDeletedByAdminIdstring nullable

ID of the admin who deleted the site

canUseFormTermsboolean

Whether form terms are enabled and filled in

canUseCheckoutFormTermsboolean

Whether checkout form terms are enabled and filled in

viewStatsJsonstring nullable

::API.Modules.Sites.Site.ViewStatsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

segmentstring nullable

Segment

urlstring nullable

URL

shortDescriptionstring nullable

Short description

isPublishedboolean

Whether the page is published

redirectboolean

Whether the page redirects to another URL

positioninteger

Position

redirectUrlstring nullable

Redirect URL

redirectPermanentboolean

::API.Modules.Sites.SitePage.RedirectPermanent::

imageIdstring nullable

Image ID

hideFromSearchBotsboolean

Whether to hide the page from search engines

designHTMLstring nullable

Design HTML

designStylestring nullable

Design style

headHtmlstring nullable

Head HTML

bodyHtmlstring nullable

Body HTML

headHtmlPublishedstring nullable

::API.Modules.Sites.SitePage.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SitePage.BodyHtmlPublished::

headerIntegrationCodestring nullable

Integration code added to the head section of the page

bodyIntegrationCodestring nullable

Integration code added to the body of the page

layoutType'default' | 'custom'

Layout type

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SitePage.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SitePage.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SitePage.BrandStyleId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt' nullable

Language

customLangstring nullable

Custom language

headerIdstring nullable

Header ID

footerIdstring nullable

Footer ID

parentIdstring nullable

Parent page ID

parentAccelModelProjectModulesSitesSitePage circular
siteIdstring required

Site ID

createdByAdminIdstring required

ID of the admin who created the page

updatedByAdminIdstring nullable

ID of the admin who last updated the page

softDeletedByAdminIdstring nullable

ID of the admin who deleted the page

variationTestIdstring nullable

::API.Modules.Sites.SitePage.VariationTestId::

childrenAccelModelProjectModulesSitesSitePage[] circular
aiDialogIdstring nullable

::API.Modules.Sites.SitePage.AiDialogId::

screenshotFileIdstring nullable

::API.Modules.Sites.SitePage.ScreenshotFileId::

hasHeaderIdboolean

Whether a header is assigned to the page

hasFooterIdboolean

Whether a footer is assigned to the page

hasImageIdboolean

Whether an image is assigned to the page

viewStatsJsonstring nullable

::API.Modules.Sites.SitePage.ViewStatsJson::

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sitePageIdstring required

::API.Modules.Sites.SitePageRevision.SitePageId::

createdByAdminIdstring nullable

::API.Modules.Sites.SitePageRevision.CreatedByAdminId::

source'manual' | 'ai' | 'publish' | 'rollback'

::API.Modules.Sites.SitePageRevision.Source::

titlestring nullable

::API.Modules.Sites.SitePageRevision.Title::

commentstring nullable

::API.Modules.Sites.SitePageRevision.Comment::

headHtmlstring nullable

::API.Modules.Sites.SitePageRevision.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageRevision.BodyHtml::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Sites.SitePageVariation.Name::

shortDescriptionstring nullable

::API.Modules.Sites.SitePageVariation.ShortDescription::

headHtmlstring nullable

::API.Modules.Sites.SitePageVariation.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageVariation.BodyHtml::

headHtmlPublishedstring nullable

::API.Modules.Sites.SitePageVariation.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SitePageVariation.BodyHtmlPublished::

layoutType'default' | 'custom'

::API.Modules.Sites.SitePageVariation.LayoutType::

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SitePageVariation.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SitePageVariation.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SitePageVariation.BrandStyleId::

trafficPercentnumber double

::API.Modules.Sites.SitePageVariation.TrafficPercent::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pageIdstring required

::API.Modules.Sites.SitePageVariation.PageId::

testIdstring required

::API.Modules.Sites.SitePageVariation.TestId::

aiDialogIdstring nullable

::API.Modules.Sites.SitePageVariation.AiDialogId::

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sitePageVariationIdstring required

::API.Modules.Sites.SitePageVariationRevision.SitePageVariationId::

createdByAdminIdstring nullable

::API.Modules.Sites.SitePageVariationRevision.CreatedByAdminId::

source'manual' | 'ai' | 'publish' | 'rollback'

::API.Modules.Sites.SitePageVariationRevision.Source::

titlestring nullable

::API.Modules.Sites.SitePageVariationRevision.Title::

commentstring nullable

::API.Modules.Sites.SitePageVariationRevision.Comment::

headHtmlstring nullable

::API.Modules.Sites.SitePageVariationRevision.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageVariationRevision.BodyHtml::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time nullable

::API.Modules.Sites.SitePageVariationTest.BeginDate::

endDatestring date-time nullable

::API.Modules.Sites.SitePageVariationTest.EndDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currentVariationIdstring nullable

::API.Modules.Sites.SitePageVariationTest.CurrentVariationId::

winnedVariationIdstring nullable

::API.Modules.Sites.SitePageVariationTest.WinnedVariationId::

pageIdstring required

::API.Modules.Sites.SitePageVariationTest.PageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Domain name

redirectTostring nullable

Redirect target

movedPermanentlyboolean

Whether the redirect is permanent (301)

isSslCertIssuedboolean

Whether the SSL certificate is issued

isConfirmedboolean

Whether the domain is verified

isMainboolean

Whether this is the primary domain

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

dnsTarget'unknown' | 'current' | 'legacy' | 'external' | 'none'

::API.Modules.Sites.SiteDomain.DnsTarget::

dnsCheckedDatestring date-time nullable

::API.Modules.Sites.SiteDomain.DnsCheckedDate::

createdByAdminIdstring required

ID of the admin who created the domain

updatedByAdminIdstring nullable

ID of the admin who last updated the domain

softDeletedByAdminIdstring nullable

ID of the admin who deleted the domain

hasSiteboolean

Whether the domain is linked to a site

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

type'header' | 'footer'

Type

bodyHtmlstring nullable

::API.Modules.Sites.SiteComponent.BodyHtml::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SiteComponent.BodyHtmlPublished::

layoutType'default' | 'custom'

::API.Modules.Sites.SiteComponent.LayoutType::

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SiteComponent.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SiteComponent.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SiteComponent.BrandStyleId::

aiDialogIdstring nullable

::API.Modules.Sites.SiteComponent.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

siteIdstring required

Site ID

createdByAdminIdstring required

ID of the admin who created the component

updatedByAdminIdstring nullable

ID of the admin who last updated the component

softDeletedByAdminIdstring nullable

ID of the admin who deleted the component

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

pathstring nullable

Path

type'content' | 'file'

Type

contentstring nullable

Content

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fileIdstring nullable

File ID

siteIdstring required

Site ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

type'pageVisited' | 'conversionFormSubmitted' | 'conversionWebinarRegistration' | 'conversionProductAddedToCart' | 'conversionChatBotRegistration' | 'conversionOrderPayment' | 'conversionOrderCreated' | 'conversionContactCreated' | 'conversionOrderPaid' | 'conversionOrderPaymentRefund' | 'conversionQuizFormSubmitted' | 'conversionPipelineDealCompleted' | 'conversionPipelineDealNotCompleted' | 'conversionPartnerLinkNavigation' | 'conversionOrderSubscriptionTrial' | 'conversionMeetingBooked'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

positioninteger

Position

funnelIdstring required

Funnel ID

pageIdstring required

Page ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

paymentButtonTextstring nullable

Payment button text

externalIdstring nullable

External ID

type'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay'

Type

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

settingsstring nullable

Settings

webhookSettingsstring nullable

Webhook settings

isPrimaryboolean

Primary gateway

showOnSiteboolean

Show on website

saveCardEnabledboolean

Save card details for future payments where applicable

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

hasSettingsboolean

Has settings

isSupportSaveCardboolean

Supports saved cards

needRegisterWebhookboolean

Webhook registration required

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

descriptionstring nullable

Description

paymentOverridesJsonstring nullable

Payment overrides (JSON)

type'digital' | 'physical' | 'service' | 'material' | 'subscription' | 'cohort'

Type

freeDownloadboolean

Free download

isPublishedboolean

Published

preventSystemEmailboolean

Don't send system emails

installmentDisabledboolean

Installments disabled

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

oneTimePricenumber double nullable

One-time price

useOneTimeDisplayPriceboolean

Show price before discount

oneTimeDisplayPricenumber double

Price before discount

durationinteger nullable

Duration

durationType'day' | 'month'

Duration type

beginDatestring date-time nullable

Start date

endDatestring date-time nullable

End date

subsPricenumber double

Subscription price

subsDurationinteger

Subscription duration

subsDurationType'day' | 'month'

Subscription duration type

subsRenewalCreditDayCountinteger nullable

Days of access kept after a failed renewal payment

subsRenewalSettingsJsonstring nullable

Subscription renewal settings (JSON)

useTrialSubsboolean

Offer a trial subscription

trialSubsPricenumber double

Trial subscription price

trialSubsDurationinteger

Trial subscription duration

trialSubsDurationType'day' | 'month'

Trial subscription duration type

useBonusPaymentboolean

Allow payment with bonuses

bonusPaymentAmountnumber double

Bonus payment amount

bonusPaymentType'percent' | 'value'

Bonus payment type

orderCountinteger

Number of orders

contactCountinteger

Number of contacts

limitOrderLifetimeboolean

Limit how long orders stay valid

limitOrderLifetimeDurationinteger nullable

Order validity period

limitOrderLifetimeDatestring date-time nullable

Date until which the order is valid

limitOrderLifetimeMode'duration' | 'date'

Order validity limit mode

useDonationPaymentboolean

Use donation pricing

minDonationPaymentAmountnumber double

Minimum donation amount

primaryImageIdstring nullable

Primary image ID

imageIdstring nullable

Image ID

flowDateIdstring nullable

Cohort date ID

categoryIdstring nullable

Category ID

isSubscriptionboolean

Subscription

supportsContentboolean

Supports content

pricenumber double nullable

Price

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

sourceIdstring required

Source ID

targetIdstring required

Target ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

::API.Modules.Products.ProductRelatedProductCategoryLink.ProductId::

categoryIdstring required

::API.Modules.Products.ProductRelatedProductCategoryLink.CategoryId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

amountinteger

::API.Modules.Products.ProductShoppingCartItem.Amount::

siteGuestIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.SiteGuestId::

trialboolean nullable

::API.Modules.Products.ProductShoppingCartItem.Trial::

productIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.ProductId::

studentIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.StudentId::

siteIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.SiteId::

widgetIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.WidgetId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

type'course' | 'coursePlan' | 'library' | 'allCourses' | 'allLibraries' | 'meeting'

Type

productIdstring required

Product ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Course plan ID

libraryAccessIdstring nullable

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

Product ID

gatewayIdstring required

Payment gateway ID

type'onlineKassa' | 'paymentMethodGroups'

Type

tax'none' | 'vat0' | 'vat10' | 'vat12' | 'vat18' | 'vat20' | 'vat110' | 'vat118' | 'vat120' | 'vat5' | 'vat7' | 'vat105' | 'vat107' nullable

Tax

paymentObject'commodity' | 'excise' | 'job' | 'service' | 'gamblingBet' | 'gamblingPrize' | 'lottery' | 'lotteryPrize' | 'intellectualActivity' | 'payment' | 'agentCommission' | 'composite' | 'another' | 'propertyRight' | 'nonOperatingGain' | 'insurancePremium' | 'salesTax' | 'resortFee' | 'unknown' nullable

Payment object

paymentMethod'fullPayment' | 'partialPayment' | 'fullPrepayment' | 'partialPrepayment' | 'advance' | 'credit' | 'creditPayment' | 'unknown' nullable

Payment method

paymentMethodGroupsJsonstring nullable

Payment method groups as JSON

paymentMethodGroupsstring[] nullable

Payment method groups

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

Product ID

gatewayIdstring required

Payment gateway ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

paidDatestring date-time nullable

Payment date

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

isDigitalDeliveryboolean

Digital delivery

isQuickboolean

Quick payment

fullyPaidboolean

Fully paid

completedboolean

Completed

termsAcceptedboolean nullable

Terms accepted

offSessionboolean

Off-session payment

isPartnerByPromoCodeboolean nullable

Affiliate assigned via promo code

shippingPricenumber double nullable

Shipping cost

totalAmountnumber double

Total amount

paidAmountnumber double

Paid amount

paidBonusAmountnumber double

Amount paid with bonuses

savingsAmountnumber double

Discount amount

feeAmountnumber double

Fee amount

partnerFeeAmountnumber double

Affiliate commission amount

incomenumber double

Income

donationAmountnumber double nullable

Donation amount

deductionAmountnumber double

Deduction amount

payAmountnumber double

Amount due

hasShippingPriceboolean

Has shipping price

needShippingboolean

Requires shipping

partiallyPaidboolean

Partially paid

shippingPriceUsdnumber double nullable

Shipping cost in USD

totalAmountUsdnumber double nullable

Total amount in USD

paidAmountUsdnumber double nullable

Paid amount in USD

savingsAmountUsdnumber double nullable

Discount amount in USD

feeAmountUsdnumber double nullable

Fee amount in USD

status'created' | 'checkoutData' | 'payment' | 'partiallyPaid' | 'paid' | 'preparingShipment' | 'shipped' | 'fulfilled' | 'canceled' | 'refund'

Status

subscriptionAction'trial' | 'trialUpgrade' | 'fullPurchase' | 'fullPurchaseUpdate' nullable

Subscription action

shippingEmailstring nullable

Recipient email

shippingFirstNamestring nullable

Recipient first name

shippingLastNamestring nullable

Recipient last name

shippingPhonestring nullable

Recipient phone

shippingAddressstring nullable

Shipping address

shippingCitystring nullable

Shipping city

shippingStatestring nullable

Shipping state or region

shippingZipstring nullable

Shipping ZIP code

shippingCountrystring nullable

Shipping country

shippingCommentstring nullable

Shipping comment

shippingTrackingCodestring nullable

Tracking number

siteGuestIdstring nullable

Website visitor ID

siteSessionIdstring nullable

Website session ID

siteSessionEnterViewIdstring nullable

Website session page view ID

stepsJsonstring nullable

Steps in JSON

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

expirationDatestring date-time nullable

Expiration date

parentIdstring nullable

Parent order ID

studentIdstring nullable

Contact ID

voiceCallIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.VoiceCallId::

partnerIdstring nullable

Affiliate ID

adminIdstring nullable

Admin ID

responsibleIdstring nullable

Owner ID

paymentGatewayIdstring nullable

Payment gateway ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

sitePageVariationTestIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.SitePageVariationTestId::

sitePageVariationIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.SitePageVariationId::

widgetIdstring nullable

Widget ID

promoCodeIdstring nullable

Promo code ID

lastPaymentMethodIdstring nullable

Last payment method ID

lastPaymentIdstring nullable

Last payment ID

numberinteger

Order number

renewalLicenseIdstring nullable

Renewed license ID

pipelineItemIdstring nullable

Deal ID

emailIdstring nullable

Email ID

emailTemplateIdstring nullable

Email template ID

broadcastIdstring nullable

Broadcast ID

webinarIdstring nullable

Webinar ID

scenarioNodeIdstring nullable

Automation step ID

scenarioNodePortIdstring nullable

Automation step port ID

childOrdersAccelModelProjectModulesProductsProductPurchaseOrder[] circular
hasSiteIdboolean

Has website ID

hasSitePageIdboolean

Has website page ID

hasWidgetIdboolean

Has widget ID

hasStudentIdboolean

Has contact ID

hasShippingEmailboolean

Has shipping email

hasShippingPhoneboolean

Has shipping phone

hasShippingFirstNameboolean

Has shipping first name

hasShippingLastNameboolean

Has shipping last name

hasGatewayIdboolean

Has payment gateway ID

hasPipelineItemIdboolean

Has deal ID

hasWebinarIdboolean

Has webinar ID

hasAdminIdboolean

Has admin ID

hasLastPaymentMethodIdboolean

Has last payment method ID

hasUsdCurrencyboolean

Has USD currency

isUpSellboolean

Upsell

hasResponsibleIdboolean

Has owner ID

responsibleNamestring nullable

Owner name

promoCodeNamestring nullable

Promo code name

isSubsRenewalboolean

Subscription renewal

hasUtmTagsboolean

Has UTM parameters

hasUpsellStepboolean

Has upsell step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

keyNamestring nullable

Key name

requiredboolean

Required

positioninteger

Position

additionalDatastring nullable

Additional data

type'text' | 'textArea' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String

valueNumericnumber double nullable

Number

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time

valueDatestring date-time nullable

Date

valueListstring nullable

List

valueMultiListstring nullable

Multi-value list

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

orderIdstring required

Order ID

fieldIdstring required

Field ID

hasValueListboolean

Has value list

hasValueMultiListboolean

Has a multi-value list

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

quantityinteger

Quantity

priceEachnumber double

Price

savingsEachnumber double

Discount

finalPriceEachnumber double

Final price

createdDatestring date-time

Creation date

trialboolean nullable

Trial

productIdstring required

Product ID

purchaseOrderIdstring required

Order ID

partnershipOfferIdstring nullable

Affiliate offer ID

partnerFeenumber double nullable

Affiliate commission

totalPriceNoSavingsnumber double

Total price before discount

totalSavingsnumber double

Total discount

totalPriceFinalnumber double

Total price

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'money' | 'bonus'

Type

saveCardboolean nullable

Save card

saveCardErrorstring nullable

Error saving card

amountnumber double

Amount

feenumber double nullable

Fee

deductionnumber double

Deduction

incomenumber double

Income

amountUsdnumber double nullable

Amount in USD

feeUsdnumber double nullable

Fee in USD

status'pending' | 'waitingForCapture' | 'success' | 'canceled' | 'fail' | 'refund'

Status

installmentStatus'pending' | 'approved' | 'canceled' | 'denied' | 'success' nullable

Installment status

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

createdDatestring date-time

Creation date

paymentDatestring date-time nullable

Payment date

waitingForCaptureUntilDatestring date-time nullable

Date until which the payment awaits capture

updatedDatestring date-time nullable

Date the record was last updated.

gatewayAmountnumber double nullable

Gateway amount

gatewayCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Gateway currency

gatewayExchangeRatenumber double

Gateway exchange rate

errorMessagestring nullable

Error message

additionalPaymentDatastring nullable

Additional payment data

additionalPaymentMethodNamestring nullable

Additional payment method name

additionalPaymentMethodDatastring nullable

Additional payment method data

externalIdstring nullable

External ID

isTestboolean

Test payment

purchaseOrderIdstring required

Order ID

paymentGatewayIdstring nullable

Payment gateway ID

refundPaymentIdstring nullable

Refund payment ID

refundPaymentAccelModelProjectModulesProductsProductPurchaseOrderPayment circular
paymentMethodIdstring nullable

Payment method ID

adminIdstring nullable

Admin ID

isSuccessboolean

Successful payment

isRefundboolean

Refund

isFailboolean

Failed payment

isManualboolean

Manual payment

hasUsdCurrencyboolean

Whether the payment is in USD

offSessionboolean

Off-session payment

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

orderIdstring required

Order ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

shortNamestring nullable

Short name

descriptionstring nullable

Description

commentstring nullable

Comment

afterwordstring nullable

Closing message

streamSourcesJsonstring nullable

Stream sources as JSON

blockedIPsJsonstring nullable

Blocked IP addresses as JSON

chatChannelsJsonstring nullable

Chat channels as JSON

isTemplateboolean

Whether the webinar is a template

hasEventsboolean

Whether the webinar has events

firstEventStartDelayMsnumber double

Delay before the first event starts, in milliseconds

templateDurationMsinteger nullable

Template duration, in milliseconds

useActiveAsNearestboolean

Treat an in-progress webinar as the nearest one

afterCompletionRedirectboolean

Redirect after the webinar ends

afterCompletionRedirectUrlstring nullable

URL to redirect attendees to after the webinar ends

firstStartEventDelayMsnumber double nullable

Delay before the first start event, in milliseconds

firstStartEventDelaystring date-span

Delay before the first start event

lastCompletionEventDelayMsnumber double nullable

Delay before the last completion event, in milliseconds

lastCompletionEventDelaystring date-span

Delay before the last completion event

scheduledStartDatestring date-time nullable

Scheduled start date

scheduledCompletionDatestring date-time nullable

Scheduled completion date

useContactFilterboolean nullable

Use contact filter

contactFilterJsonstring nullable

Contact filter as JSON

initialStatestring nullable

Initial state

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

startedDatestring date-time nullable

Actual start date

precompletedDatestring date-time nullable

Pre-completion date

completedDatestring date-time nullable

Completion date

scheduledDatestring date-time

Scheduled date

scheduledTimezoneIdstring nullable

Time zone ID for the scheduled date

scheduleCronstring nullable

Schedule as a cron expression

scheduleTimezoneIdstring nullable

Schedule time zone ID

durationinteger nullable

Duration

closeRegistrationBeforeStartboolean

Close registration before the start

closeRegistrationBeforeStartInHoursinteger

Hours before the start when registration closes

templateDurationstring date-span

Template duration

currentDurationMsnumber double

Current duration, in milliseconds

numberinteger

Number

userCountinteger

User count

userTotalCountinteger

Total number of users

registrationSettingsJsonstring nullable

Registration settings as JSON

designSettingsJsonstring nullable

Design settings as JSON

roomSettingsJsonstring nullable

Room settings as JSON

integrationSettingsJsonstring nullable

Integration settings as JSON

statsJsonstring nullable

Statistics as JSON

startScenarioEventProcessedboolean

Whether the start event for automations has been processed

completeScenarioEventProcessedboolean

Whether the completion event for automations has been processed

cleanupDateTimestring date-time nullable

Cleanup date and time

siteDomainIdstring nullable

Website domain ID

sourceIdstring nullable

Source ID

sourceAccelModelProjectModulesWebinarsWebinar circular
templateIdstring nullable

Template ID

templateAccelModelProjectModulesWebinarsWebinar circular
createdByAdminIdstring nullable

ID of the admin who created the webinar

chatBotIdstring nullable

Chatbot ID

status'notStarted' | 'inProgress' | 'completed'

Status

hasAfterCompletionRedirectUrlboolean

Whether a redirect URL is set for after the webinar ends

сanRedirectAfterCompletionboolean

Whether attendees can be redirected after the webinar ends

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

Webinar ID

fileIdstring nullable

File ID

conversionIdstring nullable

Conversion ID

widgetIdstring nullable

Widget ID

videoIdstring nullable

Video ID

urlstring nullable

URL

metaJsonstring nullable

::API.Modules.Webinars.WebinarContent.MetaJson::

type'file' | 'presentation' | 'video' | 'stream' | 'widget' | 'live' | 'poll'

Type

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

::API.Modules.Webinars.WebinarPage.WebinarId::

kind'registration' | 'waiting'

::API.Modules.Webinars.WebinarPage.Kind::

fixedThemeboolean

::API.Modules.Webinars.WebinarPage.FixedTheme::

templateKeystring nullable

::API.Modules.Webinars.WebinarPage.TemplateKey::

headHtmlstring nullable

::API.Modules.Webinars.WebinarPage.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Webinars.WebinarPage.BodyHtml::

headHtmlPublishedstring nullable

::API.Modules.Webinars.WebinarPage.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Webinars.WebinarPage.BodyHtmlPublished::

previewTokenstring nullable

::API.Modules.Webinars.WebinarPage.PreviewToken::

designConcurrencyStampstring nullable

Data change indicator

brandStyleIdstring nullable

::API.Modules.Webinars.WebinarPage.BrandStyleId::

aiDialogIdstring nullable

::API.Modules.Webinars.WebinarPage.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

publishedDatestring date-time nullable

::API.Modules.Webinars.WebinarPage.PublishedDate::

createdByAdminIdstring nullable

::API.Modules.Webinars.WebinarPage.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.Webinars.WebinarPage.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

viewsCountinteger

View count

isAccessAnywhereboolean

Whether the video can be accessed from anywhere

accessJsonstring nullable

Access settings in JSON format

settingsJsonstring nullable

Video settings in JSON format

primaryImageIdstring nullable

Primary image ID

currentVideoStreamIdstring nullable

Current video stream ID

createdByAdminIdstring nullable

ID of the admin who created the video

updatedByAdminIdstring nullable

ID of the admin who last updated the video

videoAccessIdstring nullable

Video access ID

isNotCompletedStreamExistboolean

Whether the video has a stream that hasn't finished processing

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

attemptsinteger

Attempts

axlModerationStatestring nullable

::API.Modules.Videos.VideoStream.AxlModerationState::

axlPackageJsonstring nullable

::API.Modules.Videos.VideoStream.AxlPackageJson::

axlJobIdstring nullable

::API.Modules.Videos.VideoStream.AxlJobId::

state'cloudUploading' | 'cloudUploaded' | 'converting' | 'completed' | 'failure' | 'aborted' | 'deleteFailure' | 'prepareConverting' | 'providerUploading' | 'providerUploaded' | 'deleting' | 'downloading'

State

subState'default' | 'reconvert' | 'reconverting' | 'completed' | 'failure'

Substate

provider'cloudVideo' | 'museVideo' | 'custom' | 'kinescope' | 'axl'

Provider

durationinteger

Duration in seconds

widthinteger

Width

heightinteger

Height

mp4string nullable

MP4 file URL

dashstring nullable

MPEG-DASH stream URL

hlsfmp4string nullable

HLS (fMP4) stream URL

hlsstring nullable

HLS stream URL

originalSizeinteger

Original file size in bytes

progressinteger

Progress

createdDatestring date-time

Creation date

convertBeginDatestring date-time nullable

Conversion start date

convertCompleteDatestring date-time nullable

Conversion completion date

providerIdstring nullable

Video ID at the provider

providerAdditionalDatastring nullable

Additional provider data

providerAssetsSizeinteger nullable

Size of converted files at the provider, in bytes

errorMessagestring nullable

Error message

videoIdstring required

Video ID

fileIdstring nullable

File ID

storyboardIdstring nullable

Storyboard ID

createdByAdminIdstring nullable

ID of the admin who created the video stream

parentIdstring nullable

Parent stream ID

parentAccelModelProjectModulesVideosVideoStream circular
childrenAccelModelProjectModulesVideosVideoStream[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

seenThroughDatestring date-time

::API.Modules.Videos.AxlVideoModeratorInbox.SeenThroughDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

::API.Modules.Videos.AxlVideoJob.VideoStreamId::

statestring required

::API.Modules.Videos.AxlVideoJob.State::

remoteIdstring nullable

::API.Modules.Videos.AxlVideoJob.RemoteId::

stagestring nullable

::API.Modules.Videos.AxlVideoJob.Stage::

errorCodestring nullable

::API.Modules.Videos.AxlVideoJob.ErrorCode::

attemptinteger

::API.Modules.Videos.AxlVideoJob.Attempt::

progressinteger

::API.Modules.Videos.AxlVideoJob.Progress::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

leaseUntilstring date-time nullable

::API.Modules.Videos.AxlVideoJob.LeaseUntil::

retryAfterstring date-time nullable

::API.Modules.Videos.AxlVideoJob.RetryAfter::

cleanedDatestring date-time nullable

::API.Modules.Videos.AxlVideoJob.CleanedDate::

resultJsonstring nullable

::API.Modules.Videos.AxlVideoJob.ResultJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

::API.Modules.Videos.AxlVideoReview.VideoStreamId::

adminIdstring nullable

::API.Modules.Videos.AxlVideoReview.AdminId::

managerIdstring nullable

::API.Modules.Videos.AxlVideoReview.ManagerId::

loginSessionIdstring nullable

::API.Modules.Videos.AxlVideoReview.LoginSessionId::

decisionstring required

::API.Modules.Videos.AxlVideoReview.Decision::

reasonstring required

::API.Modules.Videos.AxlVideoReview.Reason::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

Video stream ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'vimeo'

::API.Modules.Videos.VideoProvider.Type::

namestring required

::API.Modules.Videos.VideoProvider.Name::

tokenstring required

::API.Modules.Videos.VideoProvider.Token::

createdDatestring date-time

Creation date

createdByAdminIdstring nullable

::API.Modules.Videos.VideoProvider.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring required

::API.Modules.Videos.VideoImport.ExternalId::

createdDatestring date-time

Creation date

state'default' | 'downloading' | 'uploading' | 'completed' | 'wrongCompleted'

::API.Modules.Videos.VideoImport.State::

errorMessagestring nullable

::API.Modules.Videos.VideoImport.ErrorMessage::

providerIdstring required

::API.Modules.Videos.VideoImport.ProviderId::

videoStreamIdstring nullable

::API.Modules.Videos.VideoImport.VideoStreamId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

coursesAccessboolean

Course access

sitesAccessboolean

Website access

linkAccessboolean

Access via link

videoIdstring required

Video ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoAccessIdstring required

Video access ID

videoDomainIdstring required

Video domain ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

publishedDatestring date-time nullable

Publication date

viewCountinteger

View count

quizIdstring nullable

Quiz ID

meetingIdstring nullable

::API.Modules.Widgets.Widget.MeetingId::

screenshotFileIdstring nullable

::API.Modules.Widgets.Widget.ScreenshotFileId::

hasHtmlboolean

Whether the widget contains HTML.

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

state'created' | 'uploaded' | 'processing' | 'completed' | 'failure' | 'aborted'

State

source'salesJet'

Source

lastImportedEntity'tag' | 'paymentGateway' | 'course' | 'courseImage' | 'courseCategory' | 'courseCategoryLink' | 'coursePlan' | 'courseItem' | 'courseItemPlanLink' | 'student' | 'studentCourse' | 'studentCourseAccess' | 'studentCourseItemProgress' | 'studentProduct' | 'studentTagLink' | 'product' | 'productPackage' | 'productPackageCourseLink' | 'productPurchaseOrder' | 'productPurchaseOrderContent' | 'productPurchaseOrderPayment' | 'productImageLink' | 'leadAttribute' | 'leadAttributeValue' | 'courseItemTest' | 'courseItemTestQuestion' | 'courseItemTestAnswer' | 'accelFile' | 'schoolContentItem' | 'courseItemFileLink' nullable

Last imported entity

totalCountinteger

Total count

processedCountinteger

Processed count

errorstring nullable

Error

fileIdstring required

File ID

createdByAdminIdstring required

ID of the admin who created it

updatedByAdminIdstring nullable

ID of the admin who updated it

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ExternalId::

source'salesJet'

::API.Modules.Imports.ExternalImportEntity.Source::

type'tag' | 'paymentGateway' | 'course' | 'courseImage' | 'courseCategory' | 'courseCategoryLink' | 'coursePlan' | 'courseItem' | 'courseItemPlanLink' | 'student' | 'studentCourse' | 'studentCourseAccess' | 'studentCourseItemProgress' | 'studentProduct' | 'studentTagLink' | 'product' | 'productPackage' | 'productPackageCourseLink' | 'productPurchaseOrder' | 'productPurchaseOrderContent' | 'productPurchaseOrderPayment' | 'productImageLink' | 'leadAttribute' | 'leadAttributeValue' | 'courseItemTest' | 'courseItemTestQuestion' | 'courseItemTestAnswer' | 'accelFile' | 'schoolContentItem' | 'courseItemFileLink'

::API.Modules.Imports.ExternalImportEntity.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

accelFileIdstring nullable

::API.Modules.Imports.ExternalImportEntity.AccelFileId::

tagIdstring nullable

::API.Modules.Imports.ExternalImportEntity.TagId::

paymentGatewayIdstring nullable

::API.Modules.Imports.ExternalImportEntity.PaymentGatewayId::

courseIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseId::

courseImageIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseImageId::

courseCategoryIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseCategoryId::

courseCategoryLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseCategoryLinkId::

coursePlanIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CoursePlanId::

courseItemIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemId::

courseItemPlanLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemPlanLinkId::

courseItemFileLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemFileLinkId::

courseItemTestIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestId::

courseItemTestAnswerIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestAnswerId::

courseItemTestQuestionIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestQuestionId::

schoolContentItemIdstring nullable

::API.Modules.Imports.ExternalImportEntity.SchoolContentItemId::

studentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentId::

studentCourseIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseId::

studentCourseAccessIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseAccessId::

studentCourseItemProgressIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseItemProgressId::

studentProductIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentProductId::

studentTagLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentTagLinkId::

productIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductId::

productPackageIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPackageId::

productPackageCourseLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPackageCourseLinkId::

productPurchaseOrderIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderId::

productPurchaseOrderContentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderContentId::

productPurchaseOrderPaymentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderPaymentId::

productImageLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductImageLinkId::

leadAttributeIdstring nullable

::API.Modules.Imports.ExternalImportEntity.LeadAttributeId::

leadAttributeValueIdstring nullable

::API.Modules.Imports.ExternalImportEntity.LeadAttributeValueId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

codestring required

Code

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

actionType'allProducts' | 'selectedProducts'

Action type

discountType'percent' | 'fixed'

Discount type

discountAmountnumber double

Discount amount

useAvailableCountboolean

Use quantity limit

availableCountinteger nullable

Available quantity

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

subsRenewalDisabledboolean

Subscription renewal disabled

ignoreCaseboolean

Ignore case

isAutoboolean

Applied automatically

mode'students' | 'filter'

Mode

extendedFilterJsonstring nullable

Extended filter JSON

partnerIdstring nullable

Affiliate ID

status'active' | 'inactive' | 'expired' | 'ended'

Status

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productIdstring required

Product ID

promoCodeIdstring required

Promo code ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

promoCodeIdstring required

Promo code ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.Title::

descriptionstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.Description::

type'folder' | 'item'

::API.Modules.SchoolContentItems.SchoolContentItem.Type::

sectionType'course' | 'library'

::API.Modules.SchoolContentItems.SchoolContentItem.SectionType::

positioninteger

::API.Modules.SchoolContentItems.SchoolContentItem.Position::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

parentIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.ParentId::

parentAccelModelProjectModulesSchoolContentItemsSchoolContentItem circular
coverIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.CoverId::

courseIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.CourseId::

libraryIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.LibraryId::

createdByAdminIdstring required

::API.Modules.SchoolContentItems.SchoolContentItem.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.UpdatedByAdminId::

softDeletedByAdminIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.SoftDeletedByAdminId::

hasCourseIdboolean

::API.Modules.SchoolContentItems.SchoolContentItem.HasCourseId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

billingPlanPriceJsonstring nullable

Plan price JSON

isPrimaryboolean

Primary

isThirdPartyboolean

Third-party

isAgreementRequiredboolean

Agreement required

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

defaultCreditAmountnumber double

Default credit amount

minimumExpensesAmountnumber double

Minimum spend

baseFeeAmountnumber double

::API.Modules.Billings.BillingPlan.BaseFeeAmount::

defaultTrialDaysCountinteger

Default trial days

fallbackPlanIdstring nullable

Fallback plan ID

fallbackPlanAccelModelProjectModulesBillingsBillingPlan circular
familyIdstring nullable

::API.Modules.Billings.BillingPlan.FamilyId::

tierinteger

::API.Modules.Billings.BillingPlan.Tier::

isUpgradableboolean

::API.Modules.Billings.BillingPlan.IsUpgradable::

stripeProductIdstring nullable

::API.Modules.Billings.BillingPlan.StripeProductId::

stripePriceIdstring nullable

::API.Modules.Billings.BillingPlan.StripePriceId::

hasFallbackPlanIdboolean

Has fallback plan ID

hasFamilyIdboolean

::API.Modules.Billings.BillingPlan.HasFamilyId::

hasBaseFeeboolean

::API.Modules.Billings.BillingPlan.HasBaseFee::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Billings.BillingPlanFamily.Name::

descriptionstring nullable

::API.Modules.Billings.BillingPlanFamily.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

schoolBillingIdstring required

::API.Modules.Billings.BillingPlanUsage.SchoolBillingId::

planIdstring required

::API.Modules.Billings.BillingPlanUsage.PlanId::

fallbackPlanIdstring required

::API.Modules.Billings.BillingPlanUsage.FallbackPlanId::

invoiceIdstring required

::API.Modules.Billings.BillingPlanUsage.InvoiceId::

fallbackInvoiceIdstring required

::API.Modules.Billings.BillingPlanUsage.FallbackInvoiceId::

fallbackAmountnumber double

::API.Modules.Billings.BillingPlanUsage.FallbackAmount::

feenumber double

::API.Modules.Billings.BillingPlanUsage.Fee::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingPlanUsage.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingPlanUsage.ExchangeRate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

::API.Modules.Billings.BillingPlanUsage.SyncDate::

completedDatestring date-time nullable

::API.Modules.Billings.BillingPlanUsage.CompletedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

cardNumberstring required

Card number

externalIdstring nullable

External ID

last4string nullable

Last 4 digits

typestring nullable

Type

expYearinteger nullable

Expiration year

expMonthinteger nullable

Expiration month

gatewayType'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay'

Payment gateway type

settingsJsonstring nullable

Settings JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

requiresActionboolean

::API.Modules.Billings.BillingPaymentMethod.RequiresAction::

requiresActionDatestring date-time nullable

::API.Modules.Billings.BillingPaymentMethod.RequiresActionDate::

adminIdstring nullable

Admin ID

addressIdstring nullable

Address ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

reasonMessagestring nullable

::API.Modules.Billings.BillingTransaction.ReasonMessage::

amountnumber double

::API.Modules.Billings.BillingTransaction.Amount::

bonusAmountnumber double

::API.Modules.Billings.BillingTransaction.BonusAmount::

overdraftAmountnumber double

::API.Modules.Billings.BillingTransaction.OverdraftAmount::

isHiddenboolean

::API.Modules.Billings.BillingTransaction.IsHidden::

isAutopayboolean

::API.Modules.Billings.BillingTransaction.IsAutopay::

gatewayType'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay' nullable

::API.Modules.Billings.BillingTransaction.GatewayType::

status'success' | 'fail' | 'pending' | 'cancel'

::API.Modules.Billings.BillingTransaction.Status::

errorMessagestring nullable

::API.Modules.Billings.BillingTransaction.ErrorMessage::

savePaymentMethodboolean

::API.Modules.Billings.BillingTransaction.SavePaymentMethod::

isPaymentMethodTestboolean

::API.Modules.Billings.BillingTransaction.IsPaymentMethodTest::

invoiceIdstring nullable

::API.Modules.Billings.BillingTransaction.InvoiceId::

managerIdstring nullable

::API.Modules.Billings.BillingTransaction.ManagerId::

externalIdstring nullable

::API.Modules.Billings.BillingTransaction.ExternalId::

externalPayloadstring nullable

::API.Modules.Billings.BillingTransaction.ExternalPayload::

paymentMethodCardJsonstring nullable

::API.Modules.Billings.BillingTransaction.PaymentMethodCardJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingTransaction.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingTransaction.ExchangeRate::

numberinteger

::API.Modules.Billings.BillingTransaction.Number::

billingPlanIdstring nullable

::API.Modules.Billings.BillingTransaction.BillingPlanId::

paymentMethodIdstring nullable

::API.Modules.Billings.BillingTransaction.PaymentMethodId::

addressIdstring nullable

::API.Modules.Billings.BillingTransaction.AddressId::

billingPromoCodeIdstring nullable

::API.Modules.Billings.BillingTransaction.BillingPromoCodeId::

exchangeAmountnumber double

::API.Modules.Billings.BillingTransaction.ExchangeAmount::

exchangeBonusAmountnumber double

::API.Modules.Billings.BillingTransaction.ExchangeBonusAmount::

isSuccessboolean

::API.Modules.Billings.BillingTransaction.IsSuccess::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

from'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingCurrencyExchangeRate.From::

to'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingCurrencyExchangeRate.To::

ratenumber double

::API.Modules.Billings.BillingCurrencyExchangeRate.Rate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Billings.BillingPromoCode.Name::

codestring required

::API.Modules.Billings.BillingPromoCode.Code::

descriptionstring nullable

::API.Modules.Billings.BillingPromoCode.Description::

bonusBalancenumber double

::API.Modules.Billings.BillingPromoCode.BonusBalance::

trialDaysCountinteger

::API.Modules.Billings.BillingPromoCode.TrialDaysCount::

beginDatestring date-time nullable

::API.Modules.Billings.BillingPromoCode.BeginDate::

endDatestring date-time nullable

::API.Modules.Billings.BillingPromoCode.EndDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'registration' | 'addFunds'

::API.Modules.Billings.BillingPromoCode.Type::

activationCountinteger

::API.Modules.Billings.BillingPromoCode.ActivationCount::

billingPlanIdstring nullable

::API.Modules.Billings.BillingPromoCode.BillingPlanId::

status'active' | 'inactive' | 'expired' | 'ended'

::API.Modules.Billings.BillingPromoCode.Status::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

companystring nullable

Company

firstNamestring nullable

First name

lastNamestring nullable

Last name

addressstring nullable

Address

statestring nullable

State

countrystring nullable

Country

citystring nullable

City

zipCodestring nullable

ZIP code

notestring nullable

Note

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

monthinteger

::API.Modules.Billings.BillingInvoice.Month::

yearinteger

::API.Modules.Billings.BillingInvoice.Year::

periodStartstring date-time nullable

::API.Modules.Billings.BillingInvoice.PeriodStart::

periodEndExclusivestring date-time nullable

::API.Modules.Billings.BillingInvoice.PeriodEndExclusive::

numberstring nullable

::API.Modules.Billings.BillingInvoice.Number::

transferredboolean nullable

::API.Modules.Billings.BillingInvoice.Transferred::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fallbackIdstring nullable

::API.Modules.Billings.BillingInvoice.FallbackId::

fallbackAccelModelProjectModulesBillingsBillingInvoice circular
amountnumber double

::API.Modules.Billings.BillingInvoice.Amount::

correctionToMinimumExpensesAmountnumber double

::API.Modules.Billings.BillingInvoice.CorrectionToMinimumExpensesAmount::

trialPeriodBonusAmountnumber double

::API.Modules.Billings.BillingInvoice.TrialPeriodBonusAmount::

baseFeeAmountnumber double

::API.Modules.Billings.BillingInvoice.BaseFeeAmount::

aiBonusCoveredAmountnumber double

::API.Modules.Billings.BillingInvoice.AiBonusCoveredAmount::

discountOnMainServicesnumber double

::API.Modules.Billings.BillingInvoice.DiscountOnMainServices::

discountOnExtraServicesnumber double

::API.Modules.Billings.BillingInvoice.DiscountOnExtraServices::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingInvoice.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingInvoice.ExchangeRate::

isClosedboolean

::API.Modules.Billings.BillingInvoice.IsClosed::

isFallbackboolean

::API.Modules.Billings.BillingInvoice.IsFallback::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

eventIdstring required

::API.Modules.Billings.AxlStripeEvent.EventId::

eventTypestring nullable

::API.Modules.Billings.AxlStripeEvent.EventType::

schoolIdstring nullable

::API.Modules.Billings.AxlStripeEvent.SchoolId::

createdDatestring date-time

Creation date

processedDatestring date-time nullable

::API.Modules.Billings.AxlStripeEvent.ProcessedDate::

errorMessagestring nullable

::API.Modules.Billings.AxlStripeEvent.ErrorMessage::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

eventKeystring required

::API.Modules.Marketing.MarketingConversion.EventKey::

kindstring required

::API.Modules.Marketing.MarketingConversion.Kind::

occurredDatestring date-time

::API.Modules.Marketing.MarketingConversion.OccurredDate::

createdDatestring date-time

Creation date

payloadJsonstring required

::API.Modules.Marketing.MarketingConversion.PayloadJson::

statestring required

::API.Modules.Marketing.MarketingConversion.State::

attemptsinteger

::API.Modules.Marketing.MarketingConversion.Attempts::

nextAttemptDatestring date-time

::API.Modules.Marketing.MarketingConversion.NextAttemptDate::

leaseTokenstring nullable

::API.Modules.Marketing.MarketingConversion.LeaseToken::

leaseUntilstring date-time nullable

::API.Modules.Marketing.MarketingConversion.LeaseUntil::

sentDatestring date-time nullable

::API.Modules.Marketing.MarketingConversion.SentDate::

lastErrorCodestring nullable

::API.Modules.Marketing.MarketingConversion.LastErrorCode::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fromBillingPlanIdstring nullable

::API.Modules.Billings.SchoolBillingPlanChange.FromBillingPlanId::

toBillingPlanIdstring required

::API.Modules.Billings.SchoolBillingPlanChange.ToBillingPlanId::

changedDatestring date-time

::API.Modules.Billings.SchoolBillingPlanChange.ChangedDate::

reason'manual' | 'autoUpgrade' | 'initial' | 'scheduledDowngrade'

::API.Modules.Billings.SchoolBillingPlanChange.Reason::

previousPlanRemainderAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.PreviousPlanRemainderAmount::

newPlanRemainderAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.NewPlanRemainderAmount::

immediateChargeAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.ImmediateChargeAmount::

nextFullChargeDatestring date-time

::API.Modules.Billings.SchoolBillingPlanChange.NextFullChargeDate::

nextFullChargeAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.NextFullChargeAmount::

transactionIdstring nullable

::API.Modules.Billings.SchoolBillingPlanChange.TransactionId::

createdDatestring date-time

Creation date

isUpgradeboolean

::API.Modules.Billings.SchoolBillingPlanChange.IsUpgrade::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

::API.Modules.UserNotifications.UserNotification.Type::

createdDatestring date-time

Creation date

seenDatestring date-time nullable

::API.Modules.UserNotifications.UserNotification.SeenDate::

textstring nullable

::API.Modules.UserNotifications.UserNotification.Text::

payloadJsonstring nullable

::API.Modules.UserNotifications.UserNotification.PayloadJson::

subscriberAdminIdstring nullable

::API.Modules.UserNotifications.UserNotification.SubscriberAdminId::

subscriberStudentIdstring nullable

::API.Modules.UserNotifications.UserNotification.SubscriberStudentId::

adminIdstring nullable

::API.Modules.UserNotifications.UserNotification.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotification.StudentId::

adminTaskIdstring nullable

::API.Modules.UserNotifications.UserNotification.AdminTaskId::

courseIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseId::

libraryIdstring nullable

::API.Modules.UserNotifications.UserNotification.LibraryId::

schoolContentItemCommentIdstring nullable

::API.Modules.UserNotifications.UserNotification.SchoolContentItemCommentId::

schoolContentItemProgressRatingIdstring nullable

::API.Modules.UserNotifications.UserNotification.SchoolContentItemProgressRatingId::

libraryItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.LibraryItemId::

courseItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseItemId::

courseItemTaskIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseItemTaskId::

orderIdstring nullable

::API.Modules.UserNotifications.UserNotification.OrderId::

orderPaymentIdstring nullable

::API.Modules.UserNotifications.UserNotification.OrderPaymentId::

pipelineItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.PipelineItemId::

scenarioIdstring nullable

::API.Modules.UserNotifications.UserNotification.ScenarioId::

chatChannelIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatChannelId::

chatConversationIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatConversationId::

studentBonusTransactionIdstring nullable

::API.Modules.UserNotifications.UserNotification.StudentBonusTransactionId::

partnershipTransactionIdstring nullable

::API.Modules.UserNotifications.UserNotification.PartnershipTransactionId::

partnershipTransactionRequestIdstring nullable

::API.Modules.UserNotifications.UserNotification.PartnershipTransactionRequestId::

chatMessageIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatMessageId::

emailMessageIdstring nullable

::API.Modules.UserNotifications.UserNotification.EmailMessageId::

communityPostIdstring nullable

::API.Modules.UserNotifications.UserNotification.CommunityPostId::

communityCommentIdstring nullable

::API.Modules.UserNotifications.UserNotification.CommunityCommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'individual' | 'global'

Type

notificationType'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

Notification type

createdDatestring date-time

Creation date

subscriberAdminIdstring nullable

Subscriber admin ID

subscriberStudentIdstring nullable

Subscriber user ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

adminTaskIdstring nullable

Task ID

pipelineItemIdstring nullable

Deal ID

hasSubscriberAdminIdboolean

Whether a subscriber admin ID is set.

hasSubscriberStudentIdboolean

Whether a subscriber user ID is set.

hasSubscriberIdboolean

Whether a subscriber ID is set.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.StudentId::

emailstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.Email::

customEmailstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.CustomEmail::

telegramIdinteger nullable

::API.Modules.UserNotifications.UserNotificationSettings.TelegramId::

useEmailboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseEmail::

useTelegramboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseTelegram::

useWebPushboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseWebPush::

useSmsboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseSms::

canUseEmailboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseEmail::

canUseTgboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseTg::

canUseSmsboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseSms::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

useSiteboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseSite::

useEmailboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseEmail::

useTgboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseTg::

useWebPushboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseWebPush::

useSmsboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseSms::

notificationType'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

::API.Modules.UserNotifications.UserNotificationChannel.NotificationType::

adminIdstring nullable

::API.Modules.UserNotifications.UserNotificationChannel.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotificationChannel.StudentId::

hasAdminIdboolean

::API.Modules.UserNotifications.UserNotificationChannel.HasAdminId::

hasStudentIdboolean

::API.Modules.UserNotifications.UserNotificationChannel.HasStudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

datestring date-time

::API.Modules.Others.CurrencyExchangeRate.Date::

from'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Others.CurrencyExchangeRate.From::

to'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Others.CurrencyExchangeRate.To::

ratenumber double

::API.Modules.Others.CurrencyExchangeRate.Rate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

settingsJsonstring nullable

Settings in JSON format

additionalHtmlstring nullable

Additional HTML

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

snapshotDatestring date-time nullable

Snapshot date

sentCountinteger

Number of submissions

isPublishedboolean

Published

snapshotIdstring nullable

Snapshot ID

aiDialogIdstring nullable

::API.Modules.Quizzes.Quiz.AiDialogId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

settingsJsonstring nullable

Settings in JSON format

positioninteger

Position

type'textField' | 'textArea' | 'number' | 'phone' | 'email' | 'url' | 'checkbox' | 'dropdownList' | 'multiSelect' | 'monoSelect' | 'hiddenField' | 'rating' | 'uploadFile' | 'dateTime' | 'slider' | 'header' | 'paragraph' | 'separator' | 'indent' | 'picture' | 'video' | 'socialButton' | 'nameField'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pageIdstring required

Page ID

leadAttributeIdstring nullable

Lead attribute ID

systemLeadAttribute'email' | 'phone' | 'firstName' | 'lastName' | 'middleName' | 'city' | 'country' | 'comment' | 'birthday' | 'gender' | 'fullName' | 'region' nullable

System lead attribute

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

positioninteger

Position

settingsJsonstring nullable

Settings in JSON format

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

quizIdstring required

Quiz ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

quizIdstring required

::API.Modules.Quizzes.QuizSnapshot.QuizId::

transferredboolean nullable

::API.Modules.Quizzes.QuizSnapshot.Transferred::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

type'crm'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivitystring date-time nullable

Last activity

stageCountinteger

Number of stages

itemCountinteger

Number of deals

autocompleteDealAfterCompleteOrdersboolean

Automatically complete deals when their orders are completed

removeTasksAfterCompleteDealboolean

Delete tasks when a deal is completed

designSettingsJsonstring nullable

::API.Modules.Pipelines.Pipeline.DesignSettingsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

colorstring nullable

Color

type'custom' | 'crmCompleted' | 'crmNotCompleted'

Type

positioninteger

Position

lexorankPositionstring nullable

LexoRank position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

itemCountinteger

Number of deals

inArchiveboolean

Archived

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

positioninteger

Position

dealAmountnumber double

Deal amount

revenuenumber double

Revenue

outdatedboolean

Has overdue tasks

inArchiveboolean

Archived

lexorankPositionstring nullable

LexoRank position

orderCountinteger

Number of orders

adminTaskCountinteger

Number of tasks

numberinteger

Deal number

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

Date the deal was completed

takenDatestring date-time nullable

::API.Modules.Pipelines.PipelineItem.TakenDate::

firstUTMSourcestring nullable

First UTM source

firstUTMMediumstring nullable

First UTM medium

firstUTMCampaignstring nullable

First UTM campaign

firstUTMTermstring nullable

First UTM term

firstUTMContentstring nullable

First UTM content

lastUTMSourcestring nullable

Last UTM source

lastUTMMediumstring nullable

Last UTM medium

lastUTMCampaignstring nullable

Last UTM campaign

lastUTMTermstring nullable

Last UTM term

lastUTMContentstring nullable

Last UTM content

autoArchivedboolean nullable

Archived automatically

pipelineIdstring required

Pipeline ID

stageIdstring required

Stage ID

contactIdstring nullable

Contact ID

responsibleIdstring nullable

Owner ID

webinarIdstring nullable

Webinar ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

sitePageVariationTestIdstring nullable

::API.Modules.Pipelines.PipelineItem.SitePageVariationTestId::

sitePageVariationIdstring nullable

::API.Modules.Pipelines.PipelineItem.SitePageVariationId::

widgetIdstring nullable

Widget ID

chatBotIdstring nullable

Chatbot ID

quizIdstring nullable

Quiz ID

broadcastIdstring nullable

Broadcast ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

flowIdstring nullable

Cohort ID

productIdstring nullable

Product ID

scenarioIdstring nullable

::API.Modules.Pipelines.PipelineItem.ScenarioId::

scenarioNodeIdstring nullable

::API.Modules.Pipelines.PipelineItem.ScenarioNodeId::

emailMessageIdstring nullable

Email message ID

hasContactIdboolean

Has contact ID

hasResponsibleIdboolean

Has owner ID

hasAdminTasksboolean

Has tasks

isCompletedboolean

Completed

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

colorstring nullable

Color

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

itemIdstring required

Deal ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

keystring nullable

Key

additionalDatastring nullable

Additional data

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

Type

positioninteger

Position

requiredboolean

Required

visibleboolean

Visible

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String value

valueNumericnumber double nullable

Numeric value

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time value

valueDatestring date-time nullable

Date value

valueListstring nullable

List value

valueMultiListstring nullable

Multi-select value

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

itemIdstring required

Deal ID

fieldIdstring required

Field ID

hasValueListboolean

Has list value

hasValueMultiListboolean

Has multi-select value

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

stageIdstring required

Stage ID

fieldIdstring required

Field ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.SharedSettings.SharedSettingsExport.Name::

descriptionstring nullable

::API.Modules.SharedSettings.SharedSettingsExport.Description::

accessType'free' | 'contact'

::API.Modules.SharedSettings.SharedSettingsExport.AccessType::

reexportProhibitedboolean

::API.Modules.SharedSettings.SharedSettingsExport.ReexportProhibited::

contactFilterJsonstring nullable

::API.Modules.SharedSettings.SharedSettingsExport.ContactFilterJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.SharedSettings.SharedSettingsExport.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage'

::API.Modules.SharedSettings.SharedSettingsExportEntity.Type::

createdDatestring date-time

Creation date

exportIdstring required

::API.Modules.SharedSettings.SharedSettingsExportEntity.ExportId::

sitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsExportEntity.SitePageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

status'created' | 'processing' | 'completed' | 'error'

::API.Modules.SharedSettings.SharedSettingsImport.Status::

errorMsgstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.ErrorMsg::

emailstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.Email::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

exportIdstring required

::API.Modules.SharedSettings.SharedSettingsImport.ExportId::

createdByAdminIdstring required

::API.Modules.SharedSettings.SharedSettingsImport.CreatedByAdminId::

siteIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.SiteId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage'

::API.Modules.SharedSettings.SharedSettingsImportEntity.Type::

createdDatestring date-time

Creation date

importIdstring required

::API.Modules.SharedSettings.SharedSettingsImportEntity.ImportId::

sitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportEntity.SitePageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage' | 'siteComponent' | 'file' | 'fileManagerItem'

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.Type::

fromSitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromSitePageId::

toSitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToSitePageId::

fromSiteComponentIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromSiteComponentId::

toSiteComponentIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToSiteComponentId::

fromFileIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromFileId::

toFileIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToFileId::

fromFileManagerItemIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromFileManagerItemId::

toFileManagerItemIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToFileManagerItemId::

importIdstring required

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ImportId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring required

Title

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

wordsJsonstring nullable

Words JSON

wordsCountinteger

Word count

wordsstring[] nullable

Words

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

glossaryIdstring required

Glossary ID

webinarIdstring nullable

Webinar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

keystring required

::API.Modules.GlobalVariables.GlobalVariable.Key::

valuestring required

::API.Modules.GlobalVariables.GlobalVariable.Value::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.GlobalVariables.GlobalVariable.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.GlobalVariables.GlobalVariable.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

shortDescriptionstring nullable

Short description

descriptionstring nullable

Description

pricingJsonstring nullable

Pricing JSON

settingsJsonstring nullable

Settings JSON

enabledboolean

Enabled

type'custom' | 'telegramGroups' | 'metaConversions' | 'yandexMetrika' | 'googleAnalytics' | 'facebookForms' | 'googleMeet' | 'zoom' | 'aiCurator' | 'aiAssistant' | 'retell'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

titlestring nullable

Title

type'custom' | 'telegramGroups' | 'metaConversions' | 'yandexMetrika' | 'googleAnalytics' | 'facebookForms' | 'googleMeet' | 'zoom' | 'aiCurator' | 'aiAssistant' | 'retell'

Type

settingsJsonstring nullable

Settings JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

applicationIdstring required

App ID

oAuthTokenIdstring nullable

::API.Modules.Applications.ApplicationSchoolLink.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

schoolLinkIdstring required

Account link ID

siteIdstring nullable

Website ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

externalNamestring nullable

External name

excludeNonExistingUsersboolean

Exclude nonexistent users

type'group' | 'channel'

Type

namestring required

Name

keyPhrasestring required

Key phrase

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

Sync date

ownerIdstring nullable

Owner ID

schoolLinkIdstring required

Account link ID

imageIdstring nullable

Image ID

status'connecting' | 'connected'

Status

descriptionstring nullable

Description

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

state'requested' | 'invited' | 'approved' | 'rejected' | 'left' | 'removed' | 'banned'

State

reasonstring nullable

Reason

isBotboolean

Is a bot

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

addedDatestring date-time nullable

Date added

syncDatestring date-time nullable

Sync date

groupIdstring required

Group ID

studentCommunicationIdstring required

Contact channel ID

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.Applications.FacebookForm.ExternalId::

externalNamestring nullable

::API.Modules.Applications.FacebookForm.ExternalName::

fieldsJsonstring nullable

::API.Modules.Applications.FacebookForm.FieldsJson::

utmFieldsJsonstring nullable

::API.Modules.Applications.FacebookForm.UtmFieldsJson::

namestring required

::API.Modules.Applications.FacebookForm.Name::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

::API.Modules.Applications.FacebookForm.SyncDate::

schoolLinkIdstring required

::API.Modules.Applications.FacebookForm.SchoolLinkId::

descriptionstring nullable

::API.Modules.Applications.FacebookForm.Description::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

answersJsonstring nullable

::API.Modules.Applications.FacebookFormLead.AnswersJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

addedDatestring date-time nullable

::API.Modules.Applications.FacebookFormLead.AddedDate::

formIdstring required

::API.Modules.Applications.FacebookFormLead.FormId::

studentCommunicationIdstring required

::API.Modules.Applications.FacebookFormLead.StudentCommunicationId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'assistant' | 'curator' | 'voice'

::API.Modules.AiAgents.AiAgent.Type::

namestring required

::API.Modules.AiAgents.AiAgent.Name::

descriptionstring nullable

::API.Modules.AiAgents.AiAgent.Description::

ownerAdminIdstring nullable

::API.Modules.AiAgents.AiAgent.OwnerAdminId::

enabledboolean

::API.Modules.AiAgents.AiAgent.Enabled::

settingsJsonstring nullable

::API.Modules.AiAgents.AiAgent.SettingsJson::

vectorStoreIdstring nullable

::API.Modules.AiAgents.AiAgent.VectorStoreId::

state'registering' | 'registered' | 'unregistered' | 'error' | 'pending'

::API.Modules.AiAgents.AiAgent.State::

errorstring nullable

::API.Modules.AiAgents.AiAgent.Error::

hasFileSyncedboolean

::API.Modules.AiAgents.AiAgent.HasFileSynced::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.LeadScoring.LeadScore.StudentId::

stage'm15' | 'h1' | 'h3' | 'h24' | 'd1' | 'd2' | 'd3' | 'd5' | 'd7' | 'd10' | 'd14' | 'e1' | 'e2' | 'e3' | 'e4' | 'e5' | 'e6' | 'e7' | 'e8' | 'e9' | 'e10' | 'e11' | 'e12' | 'e13' | 'e14'

::API.Modules.LeadScoring.LeadScore.Stage::

mode'shadow' | 'live'

::API.Modules.LeadScoring.LeadScore.Mode::

contactCreatedDatestring date-time

::API.Modules.LeadScoring.LeadScore.ContactCreatedDate::

probabilitynumber double

::API.Modules.LeadScoring.LeadScore.Probability::

ruleScorenumber double

::API.Modules.LeadScoring.LeadScore.RuleScore::

percentileinteger nullable

::API.Modules.LeadScoring.LeadScore.Percentile::

tier'none' | 'cold' | 'warm' | 'hot'

::API.Modules.LeadScoring.LeadScore.Tier::

liftnumber double nullable

::API.Modules.LeadScoring.LeadScore.Lift::

modelTrustedboolean nullable

::API.Modules.LeadScoring.LeadScore.ModelTrusted::

reasonsJsonstring nullable

::API.Modules.LeadScoring.LeadScore.ReasonsJson::

modelVersionstring nullable

::API.Modules.LeadScoring.LeadScore.ModelVersion::

originSourcestring nullable

::API.Modules.LeadScoring.LeadScore.OriginSource::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'latitude'

::API.Modules.Live.LiveMachine.Provider::

providerServerIdstring nullable

::API.Modules.Live.LiveMachine.ProviderServerId::

planstring nullable

::API.Modules.Live.LiveMachine.Plan::

sitestring nullable

::API.Modules.Live.LiveMachine.Site::

region'us' | 'latam' | 'eu'

::API.Modules.Live.LiveMachine.Region::

hostnamestring nullable

::API.Modules.Live.LiveMachine.Hostname::

ipv4string nullable

::API.Modules.Live.LiveMachine.Ipv4::

status'requested' | 'provisioning' | 'booting' | 'ready' | 'draining' | 'deleted' | 'failed'

::API.Modules.Live.LiveMachine.Status::

capacityinteger

::API.Modules.Live.LiveMachine.Capacity::

hourlyPriceUsdnumber double

::API.Modules.Live.LiveMachine.HourlyPriceUsd::

userDataIdstring nullable

::API.Modules.Live.LiveMachine.UserDataId::

dnsRecordCreatedboolean

::API.Modules.Live.LiveMachine.DnsRecordCreated::

createdDatestring date-time

Creation date

provisionedDatestring date-time nullable

::API.Modules.Live.LiveMachine.ProvisionedDate::

serverOnDatestring date-time nullable

::API.Modules.Live.LiveMachine.ServerOnDate::

readyDatestring date-time nullable

::API.Modules.Live.LiveMachine.ReadyDate::

lastSampleDatestring date-time nullable

::API.Modules.Live.LiveMachine.LastSampleDate::

idleSinceDatestring date-time nullable

::API.Modules.Live.LiveMachine.IdleSinceDate::

deletedDatestring date-time nullable

::API.Modules.Live.LiveMachine.DeletedDate::

bootStepstring nullable

::API.Modules.Live.LiveMachine.BootStep::

errorstring nullable

::API.Modules.Live.LiveMachine.Error::

readyInfoJsonstring nullable

::API.Modules.Live.LiveMachine.ReadyInfoJson::

currentParticipantsinteger

::API.Modules.Live.LiveMachine.CurrentParticipants::

pressurenumber double

::API.Modules.Live.LiveMachine.Pressure::

isActiveboolean

::API.Modules.Live.LiveMachine.IsActive::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

::API.Modules.Live.LiveRun.WebinarId::

webinarContentIdstring required

::API.Modules.Live.LiveRun.WebinarContentId::

machineIdstring nullable

::API.Modules.Live.LiveRun.MachineId::

region'us' | 'latam' | 'eu'

::API.Modules.Live.LiveRun.Region::

roomNamestring nullable

::API.Modules.Live.LiveRun.RoomName::

status'pending' | 'ready' | 'live' | 'ended' | 'failed'

::API.Modules.Live.LiveRun.Status::

expectedViewersinteger

::API.Modules.Live.LiveRun.ExpectedViewers::

requestedBystring nullable

::API.Modules.Live.LiveRun.RequestedBy::

createdDatestring date-time

Creation date

readyDatestring date-time nullable

::API.Modules.Live.LiveRun.ReadyDate::

liveStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.LiveStartedDate::

lastPublishDatestring date-time nullable

::API.Modules.Live.LiveRun.LastPublishDate::

endRequestedDatestring date-time nullable

::API.Modules.Live.LiveRun.EndRequestedDate::

endedDatestring date-time nullable

::API.Modules.Live.LiveRun.EndedDate::

ingressIdstring nullable

::API.Modules.Live.LiveRun.IngressId::

ingressUrlstring nullable

::API.Modules.Live.LiveRun.IngressUrl::

ingressStreamKeystring nullable

::API.Modules.Live.LiveRun.IngressStreamKey::

egressIdstring nullable

::API.Modules.Live.LiveRun.EgressId::

recordingStatus'none' | 'starting' | 'recording' | 'stopping' | 'uploaded' | 'imported' | 'failed'

::API.Modules.Live.LiveRun.RecordingStatus::

recordingFileIdstring nullable

::API.Modules.Live.LiveRun.RecordingFileId::

recordingVideoIdstring nullable

::API.Modules.Live.LiveRun.RecordingVideoId::

recordingStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.RecordingStartedDate::

recordingSizeinteger nullable

::API.Modules.Live.LiveRun.RecordingSize::

recordingDurationSecnumber double nullable

::API.Modules.Live.LiveRun.RecordingDurationSec::

recordingErrorstring nullable

::API.Modules.Live.LiveRun.RecordingError::

hlsLowEgressIdstring nullable

::API.Modules.Live.LiveRun.HlsLowEgressId::

hlsStatus'none' | 'starting' | 'live' | 'stopped' | 'failed' | 'purged'

::API.Modules.Live.LiveRun.HlsStatus::

hlsStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.HlsStartedDate::

currentHlsViewersinteger

::API.Modules.Live.LiveRun.CurrentHlsViewers::

peakHlsViewersinteger

::API.Modules.Live.LiveRun.PeakHlsViewers::

layoutstring nullable

::API.Modules.Live.LiveRun.Layout::

simulcastEgressIdstring nullable

::API.Modules.Live.LiveRun.SimulcastEgressId::

simulcastTargetsstring nullable

::API.Modules.Live.LiveRun.SimulcastTargets::

simulcastStatusstring nullable

::API.Modules.Live.LiveRun.SimulcastStatus::

currentViewersinteger

::API.Modules.Live.LiveRun.CurrentViewers::

peakViewersinteger

::API.Modules.Live.LiveRun.PeakViewers::

publishersinteger

::API.Modules.Live.LiveRun.Publishers::

errorstring nullable

::API.Modules.Live.LiveRun.Error::

isActiveboolean

::API.Modules.Live.LiveRun.IsActive::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

machineIdstring nullable

::API.Modules.Live.LiveEvent.MachineId::

runIdstring nullable

::API.Modules.Live.LiveEvent.RunId::

schoolIdstring nullable

::API.Modules.Live.LiveEvent.SchoolId::

webinarIdstring nullable

::API.Modules.Live.LiveEvent.WebinarId::

level'info' | 'warning' | 'error'

::API.Modules.Live.LiveEvent.Level::

typestring required

::API.Modules.Live.LiveEvent.Type::

messagestring nullable

::API.Modules.Live.LiveEvent.Message::

dataJsonstring nullable

::API.Modules.Live.LiveEvent.DataJson::

sourcestring nullable

::API.Modules.Live.LiveEvent.Source::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

machineIdstring required

::API.Modules.Live.LiveMachineSample.MachineId::

createdDatestring date-time

Creation date

cpuPercentnumber double

::API.Modules.Live.LiveMachineSample.CpuPercent::

load1number double

::API.Modules.Live.LiveMachineSample.Load1::

memUsedMbinteger

::API.Modules.Live.LiveMachineSample.MemUsedMb::

memTotalMbinteger

::API.Modules.Live.LiveMachineSample.MemTotalMb::

txMbpsnumber double

::API.Modules.Live.LiveMachineSample.TxMbps::

rxMbpsnumber double

::API.Modules.Live.LiveMachineSample.RxMbps::

txPpsinteger

::API.Modules.Live.LiveMachineSample.TxPps::

rxPpsinteger

::API.Modules.Live.LiveMachineSample.RxPps::

udpErrorsinteger

::API.Modules.Live.LiveMachineSample.UdpErrors::

roomsinteger

::API.Modules.Live.LiveMachineSample.Rooms::

participantsinteger

::API.Modules.Live.LiveMachineSample.Participants::

publishersinteger

::API.Modules.Live.LiveMachineSample.Publishers::

ingressesinteger

::API.Modules.Live.LiveMachineSample.Ingresses::

egressesinteger

::API.Modules.Live.LiveMachineSample.Egresses::

roomsJsonstring nullable

::API.Modules.Live.LiveMachineSample.RoomsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Active

agreementRequiredboolean

Agreement required

agreementTextstring nullable

Agreement text

agreementUrlstring nullable

Agreement URL

partnerAssigningCookieDurationDaysinteger

Referral cookie lifetime, in days

partnerAssigningDurationType'endless' | 'days'

Attribution period type

partnerAssigningDurationDaysinteger

Number of days a contact stays attributed to the affiliate

transferBonusPartnerboolean

Credit the affiliate's bonus account

transferBonusPartnerAmountnumber double

Amount credited to the affiliate's bonus account

transferBonusReferralboolean

Credit the bonus account of the contact (referral)

transferBonusReferralAmountnumber double

Amount credited to the bonus account of the contact (referral)

transferFeeMethod'referral' | 'partner'

Commission transfer method

transferFeeAllowedboolean

Allow commission withdrawals

transferFeeMinAmountnumber double

Minimum withdrawal amount

transferFeeAllowedToBonusboolean

Allow commission transfers to the bonus account

transferFeeHoldingPeriodDaysinteger

Holding period, in days, before commissions become available for withdrawal

partnershipVisibleboolean

Show the affiliate dashboard in the Student Portal

partnershipPaidOrdersVisibleboolean

Show affiliates their order list

partnershipAllOrdersVisibleboolean

Show created and unpaid orders

partnershipOrdersContactVisibleboolean

Show contact details of referred buyers

partnershipCommissionDetailsVisibleboolean

Show commission breakdown

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

activatedDatestring date-time nullable

Activation date

paymentGatewayFeeEnabledboolean

Account for payment gateway fees in commission calculations

deductionEnabledboolean

Account for deductions in commission calculations

levelCountinteger

Number of levels

partnershipVisibleToGroupIdstring nullable

Show the affiliate dashboard only to contacts in this group

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'deposit' | 'withdrawal'

Type

amountnumber double

Amount

feenumber double

Commission

deductionnumber double

Deduction

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

validAfterDatestring date-time nullable

Date after which the transaction becomes valid

useBonusboolean

Bonuses used

levelinteger nullable

Level

levelPartnerIdstring nullable

ID of the affiliate at this commission level

partnerIdstring required

Affiliate ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

orderIdstring nullable

Order ID

requestIdstring nullable

Withdrawal request ID

scenarioNodeIdstring nullable

Automation step ID

studentCreatorIdstring nullable

ID of the contact who created the transaction

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

amountnumber double

Amount

partnerCommentstring nullable

Affiliate comment

adminCommentstring nullable

Admin comment

status'requested' | 'approved' | 'declined'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

partnerIdstring required

Affiliate ID

adminIdstring nullable

Admin ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring required

Name

descriptionstring nullable

Description

isActiveboolean

Active

feeType'percent' | 'value'

Commission type

productType'all' | 'selected' | 'categories'

Product type

partnerType'all' | 'selected' | 'group'

Affiliate type

purchaseType'any' | 'first' | 'repeat'

Purchase type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

levelsJsonstring nullable

Levels as JSON

urlsJsonstring nullable

URLs as JSON

levelsnumber[] nullable

Levels

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

partnerIdstring required

Affiliate ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

groupIdstring required

Group ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

productIdstring required

Product ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

::API.Modules.Partnerships.PartnershipOfferProductCategoryLink.OfferId::

categoryIdstring required

::API.Modules.Partnerships.PartnershipOfferProductCategoryLink.CategoryId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Active

codestring required

Code

navigationCountinteger

Number of referral link clicks

registrationCountinteger

Number of sign-ups

amountnumber double

Amount

feenumber double

Commission

availableFeenumber double

Available commission

createdDatestring date-time

Creation date

acceptedDatestring date-time nullable

Acceptance date

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

serialNumberstring nullable

Series

nextNumberinteger

Next number

settingsJsonstring nullable

Settings JSON

releasedCountinteger

Number of certificates issued

usePadLeftboolean

Use fixed number length

padLeftLengthinteger

Fixed number length

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'text' | 'image'

Type

subTypestring nullable

Subtype

valuestring nullable

Value

zIndexinteger

z-index

settingsJsonstring nullable

Settings JSON

metaJsonstring nullable

Metadata JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

certIdstring required

Certificate ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

numberstring required

Certificate number

createdDatestring date-time

Creation date

contactIdstring required

Contact ID

certIdstring required

Certificate ID

imageIdstring required

Image ID

courseIdstring nullable

Course ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Announcements.Tables.Announcement.Name::

textstring required

::API.Modules.Announcements.Tables.Announcement.Text::

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

::API.Modules.Announcements.Tables.Announcement.Lang::

isPublishedboolean

::API.Modules.Announcements.Tables.Announcement.IsPublished::

showOnlyForMigratedSchoolboolean

::API.Modules.Announcements.Tables.Announcement.ShowOnlyForMigratedSchool::

isAdminboolean

::API.Modules.Announcements.Tables.Announcement.IsAdmin::

isSchoolboolean

::API.Modules.Announcements.Tables.Announcement.IsSchool::

createdDatestring date-time

Creation date

beginDatestring date-time nullable

::API.Modules.Announcements.Tables.Announcement.BeginDate::

endDatestring date-time

::API.Modules.Announcements.Tables.Announcement.EndDate::

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

adminIdstring nullable

::API.Modules.Announcements.Tables.UserAnnouncement.AdminId::

studentIdstring nullable

::API.Modules.Announcements.Tables.UserAnnouncement.StudentId::

announcementIdstring required

::API.Modules.Announcements.Tables.UserAnnouncement.AnnouncementId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

shopEnabledboolean

Points shop enabled

leaderboardEnabledboolean

Leaderboard enabled

leaderboardTakeCountinteger

Number of entries shown on the leaderboard

leaderboardDurationinteger

Length of the period the leaderboard covers

leaderboardDurationType'day' | 'month' | 'year'

Unit of the leaderboard period: day, month, or year

pointsNamestring nullable

Points name

pointsShortNamestring nullable

Abbreviated points name

pointsExpireDurationinteger

Points validity period

pointsExpireDurationType'day' | 'month' | 'year' | 'endless'

Unit of the points validity period: day, month, year, or unlimited

pointsIconType'system' | 'custom'

Points icon type

pointsIconCloudKeystring nullable

Cloud storage key of the points icon

achievementStyle'one' | 'two' | 'three' | 'four'

Achievement style

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pointsCustomIconIdstring nullable

ID of the custom points icon

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

pointsinteger

Points

titlestring nullable

Title

descriptionstring nullable

Description

type'system' | 'custom'

Type

subtype'student' | 'activeStudent' | 'serialStudent' | 'earlyBird' | 'nightStudent' | 'firstStep' | 'firstTest' | 'firstTask' | 'buyer1' | 'buyer2' | 'buyer3' | 'sprint' | 'halfMarathonRunner' | 'marathonRunner' nullable

Subtype

imageType'system' | 'custom'

Image type

systemImagestring nullable

System image

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

customImageIdstring nullable

ID of the custom image

systemAchievementIdstring nullable

System achievement ID

systemAchievementAccelModelProjectModulesGamificationsGamificationAchievement circular
gamificationIdstring nullable

Gamification ID

gamificationStyle'one' | 'two' | 'three' | 'four' nullable

Gamification style

imageCloudKeystring nullable

Cloud storage key of the image

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

titlestring required

Name

descriptionstring nullable

Description

pointsinteger

Points

useAvailableCountboolean

Whether the quantity is limited

availableCountinteger

Quantity available

contentType'noContent' | 'product' | 'bonusBalance'

Content type

bonusAmountnumber double

Bonus amount

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

productIdstring nullable

Product ID

gamificationIdstring required

Gamification ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

pointsinteger

Points

type'deposit' | 'withdrawal'

Type

commentstring nullable

Comment

isManualboolean

Created manually

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expiredDatestring date-time nullable

Expiration date

studentIdstring required

Contact ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

studentAchievementIdstring nullable

ID of the achievement earned by the contact

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library step ID

productIdstring nullable

Product ID

scenarioNodeIdstring nullable

Automation step ID

gamificationIdstring required

Gamification ID

burnedTransactionIdstring nullable

ID of the transaction whose points expired

burnedTransactionAccelModelProjectModulesGamificationsGamificationTransaction circular
burnedPointsinteger nullable

Expired points

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

pointsinteger

Points

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

achievementIdstring required

Achievement ID

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library step ID

scenarioNodeIdstring nullable

Automation step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

textstring nullable

Text

generatedCountinteger

Generated count

isPublicboolean

Public

type'chatQuickReply' | 'taskQuickAnswer'

Type

contentType'normal' | 'voice'

Content type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

messageTemplateIdstring required

Message template ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.ManageableFilters.ManageableFilter.Name::

descriptionstring nullable

::API.Modules.ManageableFilters.ManageableFilter.Description::

isPublicboolean

::API.Modules.ManageableFilters.ManageableFilter.IsPublic::

type'order' | 'payment' | 'pipelineItem'

::API.Modules.ManageableFilters.ManageableFilter.Type::

filterJsonstring nullable

::API.Modules.ManageableFilters.ManageableFilter.FilterJson::

orderJsonstring nullable

::API.Modules.ManageableFilters.ManageableFilter.OrderJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

creatorIdstring required

::API.Modules.ManageableFilters.ManageableFilter.CreatorId::

adminIdstring nullable

::API.Modules.ManageableFilters.ManageableFilter.AdminId::

pipelineIdstring nullable

::API.Modules.ManageableFilters.ManageableFilter.PipelineId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Organizations.Organization.Name::

domainstring required

::API.Modules.Organizations.Organization.Domain::

textAgreementstring nullable

::API.Modules.Organizations.Organization.TextAgreement::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.TeamDepartments.TeamDepartment.Name::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

poststring required

::API.Modules.TeamDepartments.TeamDepartmentMember.Post::

role'employee' | 'manager'

::API.Modules.TeamDepartments.TeamDepartmentMember.Role::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring required

::API.Modules.TeamDepartments.TeamDepartmentMember.AdminId::

teamDepartmentIdstring required

::API.Modules.TeamDepartments.TeamDepartmentMember.TeamDepartmentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

additionalDataJsonstring nullable

::API.Modules.DeletedEntities.DeletedEntity.AdditionalDataJson::

createdDatestring date-time

Creation date

studentIdstring nullable

::API.Modules.DeletedEntities.DeletedEntity.StudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Dashboards.Dashboard.Title::

descriptionstring nullable

::API.Modules.Dashboards.Dashboard.Description::

privacyType'public' | 'private'

::API.Modules.Dashboards.Dashboard.PrivacyType::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.Dashboards.Dashboard.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Dashboards.DashboardItem.Title::

type'number' | 'table' | 'chart' | 'pie' | 'text'

::API.Modules.Dashboards.DashboardItem.Type::

settingsJsonstring nullable

::API.Modules.Dashboards.DashboardItem.SettingsJson::

dataSourceType'contact' | 'order' | 'payment' | 'webinarUser' | 'site' | 'adminTask' | 'pipelineDeal' | 'conversion' | 'email' | 'call' | 'custom'

::API.Modules.Dashboards.DashboardItem.DataSourceType::

dataSettingsJsonstring nullable

::API.Modules.Dashboards.DashboardItem.DataSettingsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

customDataSourceIdstring nullable

::API.Modules.Dashboards.DashboardItem.CustomDataSourceId::

dashboardIdstring required

::API.Modules.Dashboards.DashboardItem.DashboardId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Dashboards.DashboardDataSource.Name::

descriptionstring nullable

::API.Modules.Dashboards.DashboardDataSource.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'contact' | 'order' | 'payment' | 'webinarUser' | 'site' | 'adminTask' | 'pipelineDeal' | 'conversion' | 'email' | 'call' | 'custom'

::API.Modules.Dashboards.DashboardDataSource.Type::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Dashboards.DashboardDataSourceField.Name::

keyNamestring nullable

::API.Modules.Dashboards.DashboardDataSourceField.KeyName::

additionalDatastring nullable

::API.Modules.Dashboards.DashboardDataSourceField.AdditionalData::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.Dashboards.DashboardDataSourceField.Type::

positioninteger

::API.Modules.Dashboards.DashboardDataSourceField.Position::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sourceIdstring required

::API.Modules.Dashboards.DashboardDataSourceField.SourceId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sourceIdstring required

::API.Modules.Dashboards.DashboardDataSourceRow.SourceId::

createdByAdminIdstring required

::API.Modules.Dashboards.DashboardDataSourceRow.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueString::

valueNumericnumber double nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueNumeric::

valueBooleanboolean nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueBoolean::

valueDateTimestring date-time nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueDateTime::

valueDatestring date-time nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueDate::

valueListstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueList::

valueMultiListstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueMultiList::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

rowIdstring required

::API.Modules.Dashboards.DashboardDataSourceRowValue.RowId::

fieldIdstring required

::API.Modules.Dashboards.DashboardDataSourceRowValue.FieldId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Name::

descriptionstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Description::

detailsstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Details::

type'online' | 'offline'

::API.Modules.EventCalendars.EventCalendarEvent.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

::API.Modules.EventCalendars.EventCalendarEvent.BeginDate::

endDatestring date-time

::API.Modules.EventCalendars.EventCalendarEvent.EndDate::

duration'min10' | 'min15' | 'min30' | 'hour' | 'hour2' | 'day' | 'custom'

::API.Modules.EventCalendars.EventCalendarEvent.Duration::

timezoneIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.TimezoneId::

urlstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Url::

addressstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Address::

contactFilterEnabledboolean

::API.Modules.EventCalendars.EventCalendarEvent.ContactFilterEnabled::

contactFilterJsonstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.ContactFilterJson::

creatorByAdminIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.CreatorByAdminId::

webinarIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.WebinarId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

eventIdstring required

::API.Modules.EventCalendars.EventCalendarEventMember.EventId::

contactIdstring required

::API.Modules.EventCalendars.EventCalendarEventMember.ContactId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

::API.Modules.Communities.Tables.Community.Enabled::

popupEnabledboolean

::API.Modules.Communities.Tables.Community.PopupEnabled::

popupTextstring nullable

::API.Modules.Communities.Tables.Community.PopupText::

popupJoinTextstring nullable

::API.Modules.Communities.Tables.Community.PopupJoinText::

sortType'createdDate' | 'likesCount' | 'commentsCount'

::API.Modules.Communities.Tables.Community.SortType::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

popularPostsWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.PopularPostsWidgetEnabled::

popularPostsWidgetSortType'createdDate' | 'likesCount' | 'commentsCount'

::API.Modules.Communities.Tables.Community.PopularPostsWidgetSortType::

calendarWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.CalendarWidgetEnabled::

leaderboardWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.LeaderboardWidgetEnabled::

structureVersionIdstring nullable

::API.Modules.Communities.Tables.Community.StructureVersionId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

contactIdstring nullable

::API.Modules.Communities.Tables.CommunityMember.ContactId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityMember.LastActivityDate::

role'user' | 'moderator'

::API.Modules.Communities.Tables.CommunityMember.Role::

viewRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.ViewRestrictionEnabled::

likesRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.LikesRestrictionEnabled::

commentsRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.CommentsRestrictionEnabled::

publishRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.PublishRestrictionEnabled::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Communities.Tables.CommunityBadge.Name::

emojistring nullable

::API.Modules.Communities.Tables.CommunityBadge.Emoji::

descriptionstring nullable

::API.Modules.Communities.Tables.CommunityBadge.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

triggersJsonstring nullable

::API.Modules.Communities.Tables.CommunityBadge.TriggersJson::

imageIdstring nullable

::API.Modules.Communities.Tables.CommunityBadge.ImageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'like' | 'unlike'

::API.Modules.Communities.Tables.CommunityMemberReaction.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberReaction.MemberId::

spaceIdstring required

::API.Modules.Communities.Tables.CommunityMemberReaction.SpaceId::

postIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReaction.PostId::

commentIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReaction.CommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.Text::

type'custom'

::API.Modules.Communities.Tables.CommunityMemberReport.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberReport.MemberId::

postIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.PostId::

commentIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.CommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberBadge.MemberId::

badgeIdstring required

::API.Modules.Communities.Tables.CommunityMemberBadge.BadgeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Communities.Tables.CommunityPost.Title::

bodystring nullable

::API.Modules.Communities.Tables.CommunityPost.Body::

status'default' | 'pending' | 'approved' | 'rejected'

::API.Modules.Communities.Tables.CommunityPost.Status::

likesCountinteger

::API.Modules.Communities.Tables.CommunityPost.LikesCount::

commentsCountinteger

::API.Modules.Communities.Tables.CommunityPost.CommentsCount::

viewsCountinteger

::API.Modules.Communities.Tables.CommunityPost.ViewsCount::

reportsCountinteger

::API.Modules.Communities.Tables.CommunityPost.ReportsCount::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pinDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityPost.PinDate::

lastModerationDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityPost.LastModerationDate::

pinPositioninteger nullable

::API.Modules.Communities.Tables.CommunityPost.PinPosition::

numberinteger

::API.Modules.Communities.Tables.CommunityPost.Number::

spaceIdstring required

::API.Modules.Communities.Tables.CommunityPost.SpaceId::

authorIdstring required

::API.Modules.Communities.Tables.CommunityPost.AuthorId::

isLikedByCurrentUserboolean

::API.Modules.Communities.Tables.CommunityPost.IsLikedByCurrentUser::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.Name::

positioninteger

::API.Modules.Communities.Tables.CommunityPostAttachment.Position::

urlstring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.Url::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fileIdstring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.FileId::

postIdstring required

::API.Modules.Communities.Tables.CommunityPostAttachment.PostId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.Text::

likesCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.LikesCount::

reportsCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.ReportsCount::

childrenCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.ChildrenCount::

status'default' | 'pending' | 'approved' | 'rejected'

::API.Modules.Communities.Tables.CommunityPostComment.Status::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

postIdstring required

::API.Modules.Communities.Tables.CommunityPostComment.PostId::

authorIdstring required

::API.Modules.Communities.Tables.CommunityPostComment.AuthorId::

replyIdstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.ReplyId::

replyAccelModelProjectModulesCommunitiesTablesCommunityPostComment circular
parentIdstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.ParentId::

parentAccelModelProjectModulesCommunitiesTablesCommunityPostComment circular
childrenAccelModelProjectModulesCommunitiesTablesCommunityPostComment[] circular
isLikedByCurrentUserboolean

::API.Modules.Communities.Tables.CommunityPostComment.IsLikedByCurrentUser::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Communities.Tables.CommunitySpace.Title::

titleEmojistring nullable

::API.Modules.Communities.Tables.CommunitySpace.TitleEmoji::

positioninteger

::API.Modules.Communities.Tables.CommunitySpace.Position::

segmentstring nullable

::API.Modules.Communities.Tables.CommunitySpace.Segment::

showIfNoAccessboolean

::API.Modules.Communities.Tables.CommunitySpace.ShowIfNoAccess::

showPaymentLinkboolean

::API.Modules.Communities.Tables.CommunitySpace.ShowPaymentLink::

paymentUrlstring nullable

::API.Modules.Communities.Tables.CommunitySpace.PaymentUrl::

viewAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.ViewAccessType::

viewAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.ViewAccessExtendedFilterJson::

likesAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.LikesAccessType::

likesAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.LikesAccessExtendedFilterJson::

commentsAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.CommentsAccessType::

commentsAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.CommentsAccessExtendedFilterJson::

publishAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.PublishAccessType::

publishAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.PublishAccessExtendedFilterJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

parentIdstring nullable

::API.Modules.Communities.Tables.CommunitySpace.ParentId::

parentAccelModelProjectModulesCommunitiesTablesCommunitySpace circular
childrenAccelModelProjectModulesCommunitiesTablesCommunitySpace[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.OAuthTokens.OAuthToken.ExternalId::

redirectUristring nullable

::API.Modules.OAuthTokens.OAuthToken.RedirectUri::

settingsJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.SettingsJson::

tokenJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.TokenJson::

detailsJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.DetailsJson::

renewalAttemptsinteger

::API.Modules.OAuthTokens.OAuthToken.RenewalAttempts::

renewalErrorstring nullable

::API.Modules.OAuthTokens.OAuthToken.RenewalError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expireDatestring date-time nullable

::API.Modules.OAuthTokens.OAuthToken.ExpireDate::

type'ringCentral' | 'googleMeet' | 'zoom' | 'instagram' | 'facebook' | 'googleBusiness' | 'threads'

::API.Modules.OAuthTokens.OAuthToken.Type::

source'callAccount' | 'chatChannel' | 'application' | 'socialConnection' | 'adConnection'

::API.Modules.OAuthTokens.OAuthToken.Source::

adminIdstring nullable

::API.Modules.OAuthTokens.OAuthToken.AdminId::

encryptedboolean

::API.Modules.OAuthTokens.OAuthToken.Encrypted::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.CustomDataFields.CustomDataField.Name::

keystring nullable

::API.Modules.CustomDataFields.CustomDataField.Key::

additionalDatastring nullable

::API.Modules.CustomDataFields.CustomDataField.AdditionalData::

positioninteger

::API.Modules.CustomDataFields.CustomDataField.Position::

entityType'scenario'

::API.Modules.CustomDataFields.CustomDataField.EntityType::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.CustomDataFields.CustomDataField.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

scenarioIdstring nullable

::API.Modules.CustomDataFields.CustomDataField.ScenarioId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

::API.Modules.AI.AiDialog.AdminId::

sitePageIdstring nullable

::API.Modules.AI.AiDialog.SitePageId::

dialogIdstring nullable

::API.Modules.AI.AiDialog.DialogId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Meetings.Meeting.Name::

internalNamestring nullable

::API.Modules.Meetings.Meeting.InternalName::

subtitlestring nullable

::API.Modules.Meetings.Meeting.Subtitle::

descriptionstring nullable

::API.Modules.Meetings.Meeting.Description::

slugstring nullable

::API.Modules.Meetings.Meeting.Slug::

type'oneToOne' | 'roundRobin'

::API.Modules.Meetings.Meeting.Type::

format'googleMeet' | 'zoom' | 'phoneCall' | 'offline'

::API.Modules.Meetings.Meeting.Format::

imageFit'cover' | 'contain'

::API.Modules.Meetings.Meeting.ImageFit::

maxGuestinteger

::API.Modules.Meetings.Meeting.MaxGuest::

addressstring nullable

::API.Modules.Meetings.Meeting.Address::

timezoneIdstring nullable

::API.Modules.Meetings.Meeting.TimezoneId::

scheduleSettingsJsonstring nullable

::API.Modules.Meetings.Meeting.ScheduleSettingsJson::

bufferTimeMinutesinteger

::API.Modules.Meetings.Meeting.BufferTimeMinutes::

minBookingNoticeMinutesinteger

::API.Modules.Meetings.Meeting.MinBookingNoticeMinutes::

startTimeIntervalMinutesinteger

::API.Modules.Meetings.Meeting.StartTimeIntervalMinutes::

autoCreateTaskForHostboolean

::API.Modules.Meetings.Meeting.AutoCreateTaskForHost::

showTermsCheckboxboolean

::API.Modules.Meetings.Meeting.ShowTermsCheckbox::

termsTextstring nullable

::API.Modules.Meetings.Meeting.TermsText::

confirmationMessagestring nullable

::API.Modules.Meetings.Meeting.ConfirmationMessage::

isPublishedboolean

::API.Modules.Meetings.Meeting.IsPublished::

publishedDatestring date-time nullable

::API.Modules.Meetings.Meeting.PublishedDate::

createdDatestring date-time

Creation date

siteDomainIdstring nullable

::API.Modules.Meetings.Meeting.SiteDomainId::

oAuthTokenIdstring nullable

::API.Modules.Meetings.Meeting.OAuthTokenId::

imageIdstring nullable

::API.Modules.Meetings.Meeting.ImageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isEnabledboolean

::API.Modules.Meetings.MeetingAvailability.IsEnabled::

dayOfWeek'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' nullable

::API.Modules.Meetings.MeetingAvailability.DayOfWeek::

specificDatestring date-time nullable

::API.Modules.Meetings.MeetingAvailability.SpecificDate::

dateIntervalsJsonstring nullable

::API.Modules.Meetings.MeetingAvailability.DateIntervalsJson::

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingAvailability.MeetingId::

type'dayOfWeek' | 'date'

::API.Modules.Meetings.MeetingAvailability.Type::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

durationMinutesinteger

::API.Modules.Meetings.MeetingDuration.DurationMinutes::

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingDuration.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

labelstring nullable

::API.Modules.Meetings.MeetingFormField.Label::

placeholderstring nullable

::API.Modules.Meetings.MeetingFormField.Placeholder::

isRequiredboolean

::API.Modules.Meetings.MeetingFormField.IsRequired::

positioninteger

::API.Modules.Meetings.MeetingFormField.Position::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.Meetings.MeetingFormField.Type::

systemLeadAttribute'email' | 'phone' | 'firstName' | 'lastName' | 'middleName' | 'city' | 'country' | 'comment' | 'birthday' | 'gender' | 'fullName' | 'region' nullable

::API.Modules.Meetings.MeetingFormField.SystemLeadAttribute::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

leadAttributeIdstring nullable

::API.Modules.Meetings.MeetingFormField.LeadAttributeId::

meetingIdstring required

::API.Modules.Meetings.MeetingFormField.MeetingId::

hasSystemLeadAttributeboolean

::API.Modules.Meetings.MeetingFormField.HasSystemLeadAttribute::

hasAttributeIdboolean

::API.Modules.Meetings.MeetingFormField.HasAttributeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

priorityinteger

::API.Modules.Meetings.MeetingHost.Priority::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Meetings.MeetingHost.AdminId::

meetingIdstring required

::API.Modules.Meetings.MeetingHost.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

startDatestring date-time

::API.Modules.Meetings.MeetingBooking.StartDate::

endDatestring date-time

::API.Modules.Meetings.MeetingBooking.EndDate::

guestNamestring nullable

::API.Modules.Meetings.MeetingBooking.GuestName::

guestEmailstring nullable

::API.Modules.Meetings.MeetingBooking.GuestEmail::

guestPhonestring nullable

::API.Modules.Meetings.MeetingBooking.GuestPhone::

guestTimezoneIdstring nullable

::API.Modules.Meetings.MeetingBooking.GuestTimezoneId::

locationstring nullable

::API.Modules.Meetings.MeetingBooking.Location::

status'pending' | 'confirmed' | 'cancelled' | 'completed' | 'noShow'

::API.Modules.Meetings.MeetingBooking.Status::

cancellationReasonstring nullable

::API.Modules.Meetings.MeetingBooking.CancellationReason::

cancelledDatestring date-time nullable

::API.Modules.Meetings.MeetingBooking.CancelledDate::

fieldsJsonstring nullable

::API.Modules.Meetings.MeetingBooking.FieldsJson::

referrerUrlstring nullable

::API.Modules.Meetings.MeetingBooking.ReferrerUrl::

siteHoststring nullable

::API.Modules.Meetings.MeetingBooking.SiteHost::

guestCountinteger

::API.Modules.Meetings.MeetingBooking.GuestCount::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

createdDatestring date-time

Creation date

externalLinkIdstring nullable

::API.Modules.Meetings.MeetingBooking.ExternalLinkId::

adminTaskIdstring nullable

::API.Modules.Meetings.MeetingBooking.AdminTaskId::

adminIdstring required

::API.Modules.Meetings.MeetingBooking.AdminId::

studentIdstring nullable

::API.Modules.Meetings.MeetingBooking.StudentId::

meetingIdstring required

::API.Modules.Meetings.MeetingBooking.MeetingId::

durationIdstring required

::API.Modules.Meetings.MeetingBooking.DurationId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'zoom' | 'googleMeet' | 'ringCentral'

::API.Modules.Meetings.MeetingExternalLink.Type::

externalIdstring nullable

::API.Modules.Meetings.MeetingExternalLink.ExternalId::

externalUrlstring nullable

::API.Modules.Meetings.MeetingExternalLink.ExternalUrl::

resultJsonstring nullable

::API.Modules.Meetings.MeetingExternalLink.ResultJson::

updatedDatestring date-time nullable

Date the record was last updated.

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingExternalLink.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

orderFilter.queryAccelContext.database.currentTransaction.transactionIdstring uuid

::API.EntityFrameworkCore.Storage.IDbContextTransaction.TransactionId::

orderFilter.queryAccelContext.database.currentTransaction.supportsSavepointsboolean

::API.EntityFrameworkCore.Storage.IDbContextTransaction.SupportsSavepoints::

orderFilter.queryAccelContext.database.autoTransactionsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionsEnabled::

orderFilter.queryAccelContext.database.autoTransactionBehavior'whenNeeded' | 'always' | 'never'

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionBehavior::

orderFilter.queryAccelContext.database.autoSavepointsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoSavepointsEnabled::

orderFilter.queryAccelContext.database.providerNamestring

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.ProviderName::

orderFilter.queryAccelContext.changeTracker.autoDetectChangesEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.AutoDetectChangesEnabled::

orderFilter.queryAccelContext.changeTracker.lazyLoadingEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.LazyLoadingEnabled::

orderFilter.queryAccelContext.changeTracker.queryTrackingBehavior'trackAll' | 'noTracking' | 'noTrackingWithIdentityResolution'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.QueryTrackingBehavior::

orderFilter.queryAccelContext.changeTracker.deleteOrphansTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.DeleteOrphansTiming::

orderFilter.queryAccelContext.changeTracker.cascadeDeleteTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.CascadeDeleteTiming::

orderFilter.queryAccelContext.changeTracker.context.database.currentTransaction.transactionIdstring uuid

::API.EntityFrameworkCore.Storage.IDbContextTransaction.TransactionId::

orderFilter.queryAccelContext.changeTracker.context.database.currentTransaction.supportsSavepointsboolean

::API.EntityFrameworkCore.Storage.IDbContextTransaction.SupportsSavepoints::

orderFilter.queryAccelContext.changeTracker.context.database.autoTransactionsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionsEnabled::

orderFilter.queryAccelContext.changeTracker.context.database.autoTransactionBehavior'whenNeeded' | 'always' | 'never'

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionBehavior::

orderFilter.queryAccelContext.changeTracker.context.database.autoSavepointsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoSavepointsEnabled::

orderFilter.queryAccelContext.changeTracker.context.database.providerNamestring

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.ProviderName::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.autoDetectChangesEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.AutoDetectChangesEnabled::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.lazyLoadingEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.LazyLoadingEnabled::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.queryTrackingBehavior'trackAll' | 'noTracking' | 'noTrackingWithIdentityResolution'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.QueryTrackingBehavior::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.deleteOrphansTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.DeleteOrphansTiming::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.cascadeDeleteTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.CascadeDeleteTiming::

modelMicrosoftEntityFrameworkCoreMetadataIModel (unresolved $ref)
contextIdMicrosoftEntityFrameworkCoreDbContextId (unresolved $ref)
orderFilter.queryAccelContext.changeTracker.context.changeTracker.debugView.longViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.LongView::

orderFilter.queryAccelContext.changeTracker.context.changeTracker.debugView.shortViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.ShortView::

orderFilter.queryAccelContext.changeTracker.context.model.modelDependencies.typeMappingSourceMicrosoftEntityFrameworkCoreStorageITypeMappingSource (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.TypeMappingSource::

orderFilter.queryAccelContext.changeTracker.context.model.modelDependencies.constructorBindingFactoryMicrosoftEntityFrameworkCoreMetadataIConstructorBindingFactory (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ConstructorBindingFactory::

orderFilter.queryAccelContext.changeTracker.context.model.modelDependencies.parameterBindingFactoriesMicrosoftEntityFrameworkCoreMetadataIParameterBindingFactories (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ParameterBindingFactories::

orderFilter.queryAccelContext.changeTracker.context.model.modelIdstring uuid

::API.EntityFrameworkCore.Metadata.IModel.ModelId::

orderFilter.queryAccelContext.changeTracker.context.contextId.instanceIdstring uuid

::API.EntityFrameworkCore.DbContextId.InstanceId::

orderFilter.queryAccelContext.changeTracker.context.contextId.leaseinteger

::API.EntityFrameworkCore.DbContextId.Lease::

orderFilter.queryAccelContext.changeTracker.debugView.longViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.LongView::

orderFilter.queryAccelContext.changeTracker.debugView.shortViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.ShortView::

orderFilter.queryAccelContext.model.modelDependencies.typeMappingSourceMicrosoftEntityFrameworkCoreStorageITypeMappingSource (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.TypeMappingSource::

orderFilter.queryAccelContext.model.modelDependencies.constructorBindingFactoryMicrosoftEntityFrameworkCoreMetadataIConstructorBindingFactory (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ConstructorBindingFactory::

orderFilter.queryAccelContext.model.modelDependencies.parameterBindingFactoriesMicrosoftEntityFrameworkCoreMetadataIParameterBindingFactories (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ParameterBindingFactories::

orderFilter.queryAccelContext.model.modelIdstring uuid

::API.EntityFrameworkCore.Metadata.IModel.ModelId::

orderFilter.queryAccelContext.contextId.instanceIdstring uuid

::API.EntityFrameworkCore.DbContextId.InstanceId::

orderFilter.queryAccelContext.contextId.leaseinteger

::API.EntityFrameworkCore.DbContextId.Lease::

orderFilter.hasExtendedFilterJsonboolean

Has advanced filter JSON

orderFilter.hasExtendedFilterIdboolean

Has advanced filter ID

orderFilter.timezoneOffsetMininteger

Time zone offset in minutes

orderFilter.skipEmptyListboolean

Ignore empty lists

orderFilter.itemsTotalinteger

Total items

orderFilter.takeinteger

Number of results per page

orderFilter.skipinteger

Number of records to skip

orderFilter.searchstring

Search phrase

orderFilter.sortNamestring

Property to sort by

orderFilter.sortType'asc' | 'desc'

Sort order

orderFilter.useSortboolean

Apply sorting

orderFilter.useBaseFilterboolean

Use base filter

orderFilter.useItemsTotalboolean

Count total records

orderFilter.softDeletedboolean

Soft-deleted

orderFilter.idsstring[]

List of unique identifiers

skipEmptyListboolean

Ignore empty lists

hasOrderFilterboolean

Has order filter

extendedFilterstring

Extended filter

extendedFilterIdstring

Extended filter ID

cloudKeystring nullable

Cloud storage key

namestring nullable

Name

descriptionstring nullable

Description

originalNamestring nullable

Original file name

mimeTypestring nullable

MIME type

thumbnailUrlstring nullable

Thumbnail URL

type'other' | 'image' | 'video' | 'audio' | 'doc' | 'pdf' | 'ppt' | 'xls' | 'zip' | 'csv' | 'json'

Type

additionalDatastring nullable

Additional data

extensionstring nullable

Extension

sizeinteger

Size

completedboolean

Completed

isPublicboolean

Public

isVoiceboolean

Voice message

state'uploading' | 'completed' | 'aborted' | 'failure'

State

source'amazon' | 'yandex' | 'external' | 'axl'

Source

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

emailMessageIdstring nullable

Email message ID

externalUrlstring nullable

External URL

hasNameboolean

Has name

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

providerstring required

::API.Modules.AccelFiles.AccelFileAiProviderData.Provider::

metadataJsonstring nullable

::API.Modules.AccelFiles.AccelFileAiProviderData.MetadataJson::

fileIdstring required

::API.Modules.AccelFiles.AccelFileAiProviderData.FileId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

fileIdstring required

File ID

scenarioNodeIdstring nullable

Automation step ID

messageTemplateIdstring nullable

Message template ID

courseItemTestQuestionIdstring nullable

Course test question ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

type'pdfToImages'

Type

status'pending' | 'inProgress' | 'success' | 'error'

Status

dataJsonstring nullable

JSON data

progressnumber float

Progress

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

sizeinteger

Size

durationinteger

Duration

type'directory' | 'file'

Type

sectionType'fileSystem' | 'videos'

Section type

folderCountinteger

Number of folders

itemCountinteger

Number of items

fileIdstring nullable

File ID

videoIdstring nullable

Video ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

::API.Modules.AccelFiles.AccelFileManagerItem.SitePageId::

parentIdstring nullable

Parent folder ID

parentAccelModelProjectModulesAccelFilesAccelFileManagerItem circular
softDeletedByAdminIdstring nullable

ID of the admin who deleted the item

createdDatestring date-time

Creation date

createdByAdminIdstring required

ID of the admin who created the item

updatedDatestring date-time nullable

Date the record was last updated.

updatedByAdminIdstring nullable

ID of the admin who last updated the item

childrenAccelModelProjectModulesAccelFilesAccelFileManagerItem[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminCreatorIdstring nullable

ID of the admin who created the event

studentCreatorIdstring nullable

ID of the contact who created the event

scenarioCreatorIdstring nullable

ID of the automation that created the event

applicationCreatorIdstring nullable

::API.Modules.HistoryEvents.HistoryEvent.ApplicationCreatorId::

adminSchoolIdstring nullable

Team member ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

courseRequiredIdstring nullable

Required course ID

courseCategoryIdstring nullable

Course category ID

adminFileIdstring nullable

Admin file ID

productPackageIdstring nullable

Product package ID

coursePlanIdstring nullable

Course plan ID

courseItemIdstring nullable

Course item ID

schoolContentItemCommentIdstring nullable

Membership portal content item comment ID

courseItemTaskIdstring nullable

Course item assignment ID

courseItemTestIdstring nullable

Course item test ID

courseItemTestQuestionIdstring nullable

Course item test question ID

courseItemTestAnswerIdstring nullable

Course item test answer ID

studentIdstring nullable

Contact ID

studentGroupIdstring nullable

Contact group ID

studentCourseAccessIdstring nullable

ID of the contact's course access

studentLicenseSuspensionIdstring nullable

ID of the contact's license suspension

studentCourseIdstring nullable

ID of the contact's course enrollment

studentCourseItemProgressIdstring nullable

ID of the contact's lesson progress

studentCourseItemTaskAnswerIdstring nullable

ID of the contact's assignment answer

schoolContentItemProgressRatingIdstring nullable

Membership portal content item progress rating ID

studentCourseItemTaskAnswerCommentIdstring nullable

ID of the comment on the contact's assignment answer

schoolStudentProfileSettingsIdstring nullable

Membership portal user profile settings ID

dateFlowIdstring nullable

Cohort period ID

tagIdstring nullable

Tag ID

userInviteIdstring nullable

Team member invite ID

fileManagerItemIdstring nullable

File manager item ID

importSessionIdstring nullable

Import session ID

externalImportIdstring nullable

External import ID

policyIdstring nullable

Permission policy ID

schoolCallAccountIdstring nullable

Telephony account ID

schoolCallSessionIdstring nullable

Call session ID

schoolCallSIPRegistrationIdstring nullable

SIP registration ID

schoolCallIncomingLinkIdstring nullable

Incoming number assignment ID

adminTaskIdstring nullable

Task ID

emailTemplateIdstring nullable

Email template ID

broadcastIdstring nullable

Broadcast ID

broadcastListIdstring nullable

Mailing list ID

forumThreadIdstring nullable

Forum thread ID

forumThreadModeratorIdstring nullable

Forum thread moderator ID

forumTopicIdstring nullable

Forum topic ID

forumTopicCommentIdstring nullable

Forum topic comment ID

forumReactionIdstring nullable

Forum reaction ID

forumSubscriptionIdstring nullable

Forum subscription ID

forumBanIdstring nullable

Forum ban ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

siteDomainIdstring nullable

Website domain ID

siteFunnelIdstring nullable

Website funnel ID

siteGuestIdstring nullable

Website visitor ID

siteSessionViewIdstring nullable

ID of the page view in a website session

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library item ID

productIdstring nullable

Product ID

paymentGatewayIdstring nullable

Payment gateway ID

purchaseOrderIdstring nullable

Order ID

purchaseOrderPaymentIdstring nullable

Order payment ID

videoIdstring nullable

Video ID

videoStreamIdstring nullable

Video stream ID

videoDomainIdstring nullable

Video domain ID

loginSessionIdstring nullable

Sign-in session ID

webinarIdstring nullable

Webinar ID

widgetIdstring nullable

Widget ID

chatChannelIdstring nullable

Chat channel ID

quizIdstring nullable

Quiz ID

quizAnswerIdstring nullable

Quiz answer ID

chatBotIdstring nullable

Chatbot ID

chatChannelMessageTemplateIdstring nullable

Chat channel message template ID

applicationIdstring nullable

App ID

telegramGroupIdstring nullable

Telegram group ID

pipelineStageIdstring nullable

Pipeline stage ID

phoneNumberIdstring nullable

::API.Modules.HistoryEvents.HistoryEvent.PhoneNumberId::

pipelineItemIdstring nullable

Deal ID

scenarioIdstring nullable

Automation ID

scenarioNodeIdstring nullable

Automation step ID

partnershipIdstring nullable

Affiliate program ID

partnershipOfferIdstring nullable

Affiliate offer ID

partnershipTransactionIdstring nullable

Affiliate transaction ID

studentBonusTransactionIdstring nullable

ID of the contact's bonus transaction

partnershipTransactionRequestIdstring nullable

Affiliate transaction request ID

certIdstring nullable

Certificate ID

studentCertIdstring nullable

ID of the contact's certificate

gamificationIdstring nullable

Gamification ID

gamificationAchievementIdstring nullable

Gamification achievement ID

gamificationProductIdstring nullable

Gamification product ID

gamificationTransactionIdstring nullable

Gamification transaction ID

studentAchievementIdstring nullable

ID of the contact's achievement

managerCreatorIdstring nullable

ID of the AXL manager who created the event

billingPlanIdstring nullable

Subscription plan ID

schoolBillingIdstring nullable

Account billing ID

createdDatestring date-time

Creation date

additionalDatastring nullable

Additional data

type'courseCreated' | 'courseUpdated' | 'courseCategoryCreated' | 'courseCategoryUpdated' | 'courseCategoryDeleted' | 'coursePackageCreated' | 'coursePackageUpdated' | 'coursePackageDeleted' | 'coursePackageLinkCreated' | 'coursePackageLinkDeleted' | 'courseImageCreated' | 'courseImageUpdated' | 'courseImageDeleted' | 'coursePlanCreated' | 'coursePlanUpdated' | 'coursePlanDeleted' | 'coursePlanCopied' | 'courseCategoryLinkCreated' | 'courseCategoryLinkUpdated' | 'courseCategoryLinkDeleted' | 'courseRequirementCreated' | 'courseRequirementDeleted' | 'courseItemCommentCreated' | 'courseItemCommentUpdated' | 'courseItemCommentDeleted' | 'courseItemCreated' | 'courseItemUpdated' | 'courseItemDeleted' | 'courseItemTaskCreated' | 'courseItemTaskUpdated' | 'courseItemTaskDeleted' | 'courseItemTestCreated' | 'courseItemTestUpdated' | 'courseItemTestDeleted' | 'courseItemTestQuestionCreated' | 'courseItemTestQuestionUpdated' | 'courseItemTestQuestionDeleted' | 'courseItemTestAnswerCreated' | 'courseItemTestAnswerUpdated' | 'courseItemTestAnswerDeleted' | 'courseItemPlanCreated' | 'courseItemPlanDeleted' | 'courseItemRestored' | 'courseItemCopied' | 'courseItemTaskCopied' | 'courseItemTestCopied' | 'courseItemTestQuestionCopied' | 'courseItemTaskFileCreated' | 'courseItemTaskFileDeleted' | 'courseItemTaskFileUpdated' | 'courseItemTestFileCreated' | 'courseItemTestFileDeleted' | 'courseItemTestFileUpdated' | 'courseItemFormSubmitted' | 'courseItemTaskFieldCreated' | 'courseItemTaskFieldUpdated' | 'courseItemTaskFieldDeleted' | 'accelFileCreated' | 'accelFileUpdated' | 'accelFileDeleted' | 'accelFileRefreshed' | 'schoolCreated' | 'schoolUpdated' | 'schoolDeleted' | 'schoolProfileSettingsUpdated' | 'schoolJsCodeUpdated' | 'schoolSettingsUpdated' | 'schoolRegisterFormSubmitted' | 'schoolOwnerChanged' | 'adminCreated' | 'adminInviteCreated' | 'adminUpdated' | 'adminLogin' | 'adminResetPassword' | 'adminRegister' | 'adminForgotPassword' | 'adminConfirmEmail' | 'adminSchoolCreated' | 'adminSchoolUpdated' | 'adminSchoolDeleted' | 'adminSchoolRestored' | 'adminResponsibleCreated' | 'adminResponsibleUpdated' | 'adminResponsibleDeleted' | 'adminStepCourseOpened' | 'adminStepCourseClosed' | 'adminStepCourseCompleted' | 'adminStepCourseUncompleted' | 'allAdminResponsibleUpdated' | 'tagCreated' | 'tagUpdated' | 'tagDeleted' | 'tagMerged' | 'fileManagerItemCreated' | 'fileManagerItemUpdated' | 'fileManagerItemDeleted' | 'studentCreated' | 'studentLogin' | 'studentResetPassword' | 'studentRegister' | 'studentForgotPassword' | 'studentConfirmEmail' | 'studentUpdated' | 'studentCourseCreated' | 'studentCourseStarted' | 'studentCourseCompleted' | 'studentLicenseCreated' | 'studentLicenseUpdated' | 'studentLicenseDeleted' | 'studentCourseFeedbackCreated' | 'studentCourseItemStarted' | 'studentCourseItemCompleted' | 'studentCourseItemTheoryCompleted' | 'studentCourseItemTestsCompleted' | 'studentCourseItemTasksCompleted' | 'studentCourseItemTaskAnswerStatusUpdated' | 'studentConfirmInvite' | 'studentInviteCreated' | 'studentSelfRemoved' | 'studentMergedSource' | 'studentMergedTarget' | 'studentUpdatedLimited' | 'studentRestored' | 'studentProductSubscriptionUpdated' | 'studentCourseItemRatingCreated' | 'studentCourseItemRatingUpdated' | 'studentLibraryItemRatingCreated' | 'studentLibraryItemRatingUpdated' | 'studentGroupCreated' | 'studentGroupUpdated' | 'studentGroupDeleted' | 'studentBonusTransactionCreated' | 'studentBonusTransactionDeleted' | 'studentLicenseSuspensionCreated' | 'studentLicenseSuspensionDeleted' | 'importLeadUpdated' | 'importLeadCreated' | 'leadNoteCreated' | 'leadDeleted' | 'leadDeletedByMerge' | 'leadBanned' | 'leadUnbanned' | 'leadCommentsBanned' | 'leadCommentsUnbanned' | 'leadToBroadcastListAdded' | 'leadFromBroadcastListDeleted' | 'leadTagsUpdated' | 'leadGroupsUpdated' | 'leadGroupCreated' | 'leadGroupUpdated' | 'leadGroupDeleted' | 'leadAddCartProduct' | 'leadDeleteCartProduct' | 'leadVisitCheckout' | 'leadVisitCheckoutSuccess' | 'leadWebinarRegistration' | 'leadWebinarVisit' | 'leadAttributeCreated' | 'leadAttributeUpdated' | 'leadAttributeDeleted' | 'leadAttributeRestored' | 'leadChatChannelStarted' | 'leadChatBotStarted' | 'leadChatChannelScenarioStarted' | 'leadPriorityAssigned' | 'policyCreated' | 'policyUpdated' | 'policyDeleted' | 'forumThreadCreated' | 'forumThreadUpdated' | 'forumThreadDeleted' | 'forumThreadRestored' | 'forumThreadModeratorCreated' | 'forumThreadModeratorDeleted' | 'forumThreadMemberCreated' | 'forumThreadMemberDeleted' | 'forumBanCreated' | 'forumBanDeleted' | 'emailSent' | 'emailUnsubscribed' | 'emailPermanentFail' | 'emailComplained' | 'emailClicked' | 'emailOpened' | 'emailDelivered' | 'emailSuppressed' | 'emailSubscribed' | 'emailTemplateCreated' | 'emailTemplateUpdated' | 'emailTemplateDeleted' | 'emailTemplateCopied' | 'broadcastCreated' | 'broadcastUpdated' | 'broadcastDeleted' | 'broadcastStatusUpdated' | 'schoolCallSessionCompleted' | 'schoolCallSessionStarted' | 'schoolCallSIPRegistrationCreated' | 'schoolCallSIPRegistrationUpdated' | 'schoolCallSIPRegistrationDeleted' | 'schoolCallSIPRegistrationLinkCreated' | 'schoolCallSIPRegistrationLinkDeleted' | 'schoolCallIncomingLinkCreated' | 'schoolCallIncomingLinkUpdated' | 'schoolCallIncomingLinkDeleted' | 'schoolCallAccountCreated' | 'schoolCallAccountUpdated' | 'schoolCallAccountDeleted' | 'adminTaskCreated' | 'adminTaskUpdated' | 'adminTaskDeleted' | 'adminTaskCompleted' | 'adminTaskResetStatus' | 'adminTaskReportUpdated' | 'libraryCreated' | 'libraryUpdated' | 'libraryDeleted' | 'libraryCategoriesUpdated' | 'libraryImageCreated' | 'libraryImageUpdated' | 'libraryImageDeleted' | 'libraryItemCreated' | 'libraryItemUpdated' | 'libraryItemDeleted' | 'libraryItemRestored' | 'libraryItemViewed' | 'libraryItemFormSubmitted' | 'productPackageCreated' | 'productPackageUpdated' | 'productPackageDeleted' | 'productPackageCourseLinkCreated' | 'productPackageCourseLinkDeleted' | 'productPackageCourseLinkUpdated' | 'productPackageLibraryAccessLinkCreated' | 'productPackageLibraryAccessLinkDeleted' | 'productPackageLibraryAccessLinkUpdated' | 'siteCreated' | 'siteUpdated' | 'siteDeleted' | 'sitePageCreated' | 'sitePageUpdated' | 'sitePageDeleted' | 'siteDomainCreated' | 'siteDomainUpdated' | 'siteDomainDeleted' | 'siteMenuItemCreated' | 'siteMenuItemUpdated' | 'siteMenuItemDeleted' | 'siteViewed' | 'siteFunnelCreated' | 'siteFunnelUpdated' | 'siteFunnelDeleted' | 'siteFormSubmitted' | 'sitePageVariationCreated' | 'sitePageVariationUpdated' | 'sitePageVariationDeleted' | 'sitePageVariationTestCreated' | 'sitePageVariationTestUpdated' | 'sitePageVariationTestDeleted' | 'scenarioCreated' | 'scenarioUpdated' | 'scenarioDeleted' | 'scenarioNodeCreated' | 'scenarioNodeUpdated' | 'scenarioNodeDeleted' | 'productCreated' | 'productUpdated' | 'productDeleted' | 'productRestored' | 'productImageCreated' | 'productImageDeleted' | 'paymentGatewayCreated' | 'paymentGatewayUpdated' | 'paymentGatewayDeleted' | 'purchaseOrderCreated' | 'purchaseOrderUpdated' | 'purchaseOrderDeleted' | 'purchaseOrderCompleted' | 'purchaseOrderCanceled' | 'purchaseOrderUnCompleted' | 'purchaseOrderPaid' | 'purchaseOrderRestored' | 'purchaseOrderPaymentCreated' | 'purchaseOrderPaymentUpdated' | 'purchaseOrderPaymentDeleted' | 'purchaseOrderPaymentRefunded' | 'purchaseOrderContentCreated' | 'purchaseOrderContentUpdated' | 'purchaseOrderContentDeleted' | 'videoCreated' | 'videoUpdated' | 'videoDeleted' | 'videoKinescopeDeleted' | 'videoStreamCreated' | 'videoStreamUpdated' | 'videoStreamDeleted' | 'videoStreamMakeCurrent' | 'videoStreamAborted' | 'videoStreamImageCreated' | 'videoStreamImageDeleted' | 'videoDomainCreated' | 'videoDomainUpdated' | 'videoDomainDeleted' | 'videoAccessCreated' | 'videoAccessUpdated' | 'videoAccessDeleted' | 'videoAccessDomainUpdated' | 'widgetViewed' | 'widgetFormSubmitted' | 'webhookSent' | 'quizStarted' | 'quizSubmitted' | 'quizViewed' | 'pipelineDealCreated' | 'pipelineDealUpdated' | 'pipelineDealDeleted' | 'pipelineDealTaskAdded' | 'pipelineDealTaskDeleted' | 'pipelineDealOrderAdded' | 'pipelineDealOrderDeleted' | 'pipelineDealStageChanged' | 'pipelineDealArchived' | 'pipelineDealRestored' | 'pipelineDealCompleted' | 'pipelineStageCreated' | 'pipelineStageUpdated' | 'pipelineStageDeleted' | 'pipelineTagMerged' | 'glossaryCreated' | 'glossaryUpdated' | 'glossaryDeleted' | 'glossaryRestored' | 'glossaryLinkCreated' | 'glossaryLinkDeleted' | 'applicationSchoolLinkCreated' | 'applicationSchoolLinkUpdated' | 'applicationSchoolLinkDeleted' | 'applicationSchoolLinkRestored' | 'telegramGroupCreated' | 'telegramGroupUpdated' | 'telegramGroupDeleted' | 'telegramGroupRestored' | 'telegramGroupUserUpdated' | 'telegramGroupUserInvited' | 'telegramGroupUserBanned' | 'telegramGroupUserApproved' | 'telegramGroupUserRejected' | 'telegramGroupUserDeleted' | 'telegramGroupUserLeft' | 'telegramGroupUserRequested' | 'applicationUpdated' | 'facebookFormCreated' | 'facebookFormUpdated' | 'facebookFormDeleted' | 'facebookFormRestored' | 'facebookFormLeadAdded' | 'facebookFormLeadUpdated' | 'facebookFormLeadDeleted' | 'partnershipCreated' | 'partnershipUpdated' | 'partnershipOfferCreated' | 'partnershipOfferUpdated' | 'partnershipOfferDeleted' | 'partnershipTransactionRequestCreated' | 'partnershipTransactionRequestUpdated' | 'partnershipTransactionRequestDeleted' | 'partnershipTransactionCreated' | 'partnershipTransactionDeleted' | 'certCreated' | 'certUpdated' | 'certDeleted' | 'gamificationCreated' | 'gamificationUpdated' | 'gamificationAchievementCreated' | 'gamificationAchievementUpdated' | 'gamificationAchievementDeleted' | 'gamificationProductCreated' | 'gamificationProductUpdated' | 'gamificationProductDeleted' | 'gamificationProductRestored' | 'gamificationTransactionCreated' | 'chatChannelMessageTemplateUpdated' | 'billingPlanCreated' | 'billingPlanUpdated' | 'billingPlanDeleted' | 'billingPlanRestored' | 'schoolBillingUpdated' | 'teamDepartmentCreated' | 'teamDepartmentUpdated' | 'teamDepartmentDeleted' | 'teamDepartmentMemberCreated' | 'teamDepartmentMemberUpdated' | 'teamDepartmentMemberDeleted' | 'dashboardCreated' | 'dashboardUpdated' | 'dashboardDeleted' | 'dashboardItemCreated' | 'dashboardItemUpdated' | 'dashboardItemDeleted' | 'dashboardDataSourceCreated' | 'dashboardDataSourceUpdated' | 'dashboardDataSourceDeleted' | 'dashboardDataSourceFieldCreated' | 'dashboardDataSourceFieldUpdated' | 'dashboardDataSourceFieldDeleted' | 'eventCalendarEventCreated' | 'eventCalendarEventUpdated' | 'eventCalendarEventDeleted' | 'communityCreated' | 'communityUpdated' | 'communitySpaceCreated' | 'communitySpaceUpdated' | 'communitySpaceDeleted' | 'communityMemberCreated' | 'communityMemberUpdated' | 'communityMemberDeleted' | 'communityPostCreated' | 'communityPostUpdated' | 'communityPostDeleted' | 'communityPostApproved' | 'communityPostRejected' | 'communityPostPending' | 'communityBadgeCreated' | 'communityBadgeUpdated' | 'communityBadgeDeleted' | 'communityPostCommentCreated' | 'communityPostCommentUpdated' | 'communityPostCommentDeleted' | 'communityPostCommentApproved' | 'communityPostCommentRejected' | 'communityPostCommentPending' | 'communityReportCreated' | 'communityReportUpdated' | 'communityReportDeleted' | 'chatConversationMarkedAsRead' | 'chatConversationLeaved' | 'chatConversationClosed' | 'meetingCreated' | 'meetingUpdated' | 'meetingDeleted' | 'meetingViewed' | 'meetingBookingCreated' | 'meetingBookingUpdated' | 'meetingBookingConfirmed' | 'meetingBookingCancelled' | 'meetingBookingCompleted' | 'meetingBookingNoShow' | 'aiDialogCreated' | 'aiDialogDeleted' | 'telephonyNumberUpdated' | 'socialConnectionCreated' | 'socialConnectionDeleted' | 'socialConnectionReauthRequired' | 'socialConnectionMessagingLinked' | 'socialConnectionMessagingUnlinked' | 'socialPostCreated' | 'socialPostUpdated' | 'socialPostDeleted' | 'socialPostScheduled' | 'socialPublicationPublished' | 'socialPublicationFailed' | 'adConnectionCreated' | 'adConnectionDeleted' | 'adCampaignCreated' | 'adCampaignLaunched' | 'adCampaignPaused' | 'adCampaignBudgetChanged' | 'adCampaignRejected'

Type

globalType'system' | 'study' | 'crm' | 'contentEdit' | 'forum' | 'email' | 'communication' | 'library' | 'siteContent' | 'site' | 'scenario' | 'call' | 'product' | 'video' | 'webinar' | 'application' | 'partnership' | 'cert' | 'gamification' | 'billing' | 'dashboard' | 'eventCalendar' | 'chat' | 'community' | 'social' | 'advertising' | 'aiDialog' | 'meeting'

Event category

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

historyEventIdstring required

History event ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

tokenstring nullable

Token

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

expiredDatestring date-time nullable

Expiration date

completedDatestring date-time nullable

Date the session ended

ipstring nullable

IP address

countrystring nullable

Country

citystring nullable

City

userAgentstring nullable

User agent

browserstring nullable

Browser

devicestring nullable

Device

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

studentCommunicationIdstring nullable

Contact method ID

managerIdstring nullable

AXL staff member ID

isInitedboolean

Whether the session is initialized

isManagerAsAdminboolean

Whether an AXL staff member is signed in as the admin

isAdminAsStudentboolean

Whether an admin is signed in as the contact

isActiveboolean

Whether the session is active

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

tokenstring nullable

::API.Modules.Users.UserWebPushToken.Token::

userAgentstring nullable

::API.Modules.Users.UserWebPushToken.UserAgent::

type'fcm' | 'expo'

::API.Modules.Users.UserWebPushToken.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

sessionIdstring required

::API.Modules.Users.UserWebPushToken.SessionId::

adminIdstring nullable

::API.Modules.Users.UserWebPushToken.AdminId::

studentIdstring nullable

::API.Modules.Users.UserWebPushToken.StudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

lastNamestring nullable

Last name

phonestring nullable

Phone

type'simple' | 'api' | 'thirdParty'

Type

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

gender'male' | 'female' | 'other' nullable

Gender

birthdaystring date-time nullable

Birthday

timezoneMode'local' | 'school'

Time zone mode

externalIdstring nullable

External ID

isEmailConfirmedboolean

Email address verified

isPhoneConfirmedboolean

Phone verified

isSystemboolean

Whether this is a system user

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastSeenDatestring date-time nullable

Date of the last visit

agreeWithTermsDatestring date-time nullable

Date the terms were accepted

emailConfirmationSentDatestring date-time nullable

Date the confirmation email was sent

avatarIdstring nullable

Avatar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

codestring required

::API.Modules.Users.AdminPartnerLink.Code::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Users.AdminPartnerLink.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.AdminPartnerTariff.Name::

mainServicePercentnumber float

::API.Modules.Users.AdminPartnerTariff.MainServicePercent::

additionalServicePercentnumber float

::API.Modules.Users.AdminPartnerTariff.AdditionalServicePercent::

networkPercentnumber double

::API.Modules.Users.AdminPartnerTariff.NetworkPercent::

initialPartnerBonusAmountnumber double

::API.Modules.Users.AdminPartnerTariff.InitialPartnerBonusAmount::

initialReferralBonusAmountnumber double

::API.Modules.Users.AdminPartnerTariff.InitialReferralBonusAmount::

referralSpendThresholdnumber double

::API.Modules.Users.AdminPartnerTariff.ReferralSpendThreshold::

adminIdstring required

::API.Modules.Users.AdminPartnerTariff.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

mainServiceAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.MainServiceAmount::

additionalServiceAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.AdditionalServiceAmount::

totalAmountnumber double

::API.Modules.Users.AdminPartnerTransaction.TotalAmount::

createdDatestring date-time

Creation date

type'general' | 'initialBonus' | 'referralFee' | 'networkFee'

::API.Modules.Users.AdminPartnerTransaction.Type::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Users.AdminPartnerTransaction.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Users.AdminPartnerTransaction.ExchangeRate::

billingInvoiceIdstring nullable

::API.Modules.Users.AdminPartnerTransaction.BillingInvoiceId::

commentstring nullable

::API.Modules.Users.AdminPartnerTransaction.Comment::

adminIdstring required

::API.Modules.Users.AdminPartnerTransaction.AdminId::

fromAdminIdstring nullable

::API.Modules.Users.AdminPartnerTransaction.FromAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

studentCommunicationIdstring nullable

Contact method ID

userEmailTemplateIdstring nullable

User email template ID

tokenstring nullable

Token

createdDatestring date-time

Creation date

confirmedDatestring date-time nullable

Date the invite was accepted

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

Admin ID

studentIdstring required

Contact ID

poststring nullable

Job title

trackPurchaseOrderboolean

Track orders

trackChatboolean

Track chat

assignCoursesboolean

::API.Modules.Users.AdminResponsibleStudentLink.AssignCourses::

assignedCourseIdsJsonstring nullable

::API.Modules.Users.AdminResponsibleStudentLink.AssignedCourseIdsJson::

assignedCourseIdsstring[] nullable

::API.Modules.Users.AdminResponsibleStudentLink.AssignedCourseIds::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.AdminViewSetting.Name::

type'crm' | 'order' | 'chatMessageTesting' | 'orderPayment'

::API.Modules.Users.AdminViewSetting.Type::

columnsJsonstring nullable

::API.Modules.Users.AdminViewSetting.ColumnsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring required

::API.Modules.Users.AdminViewSetting.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

partnerEmailstring nullable

::API.Modules.Users.AdminMetadata.PartnerEmail::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

codestring required

::API.Modules.Users.AdminSupportCode.Code::

managerIdstring nullable

::API.Modules.Users.AdminSupportCode.ManagerId::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Users.AdminSupportCode.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

isPrimaryboolean

::API.Modules.Users.AdminDashboardLink.IsPrimary::

adminIdstring required

::API.Modules.Users.AdminDashboardLink.AdminId::

dashboardIdstring required

::API.Modules.Users.AdminDashboardLink.DashboardId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.SmsAssistant.SmsAssistantSession.PhoneE164::

adminIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.AdminId::

schoolIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.SchoolId::

dialogIdstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.DialogId::

state'onboarding' | 'ready' | 'linking'

::API.Modules.SmsAssistant.SmsAssistantSession.State::

channel'sms' | 'whatsApp' | 'telegram'

::API.Modules.SmsAssistant.SmsAssistantSession.Channel::

onboardingJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.OnboardingJson::

pendingInboundJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.PendingInboundJson::

magicLinkTokenstring nullable

::API.Modules.SmsAssistant.SmsAssistantSession.MagicLinkToken::

magicLinkExpiresstring date-time nullable

::API.Modules.SmsAssistant.SmsAssistantSession.MagicLinkExpires::

optedOutDatestring date-time nullable

::API.Modules.SmsAssistant.SmsAssistantSession.OptedOutDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.SmsAssistant.SmsAssistantMessage.PhoneE164::

direction'inbound' | 'outbound'

::API.Modules.SmsAssistant.SmsAssistantMessage.Direction::

channel'sms' | 'whatsApp' | 'telegram'

::API.Modules.SmsAssistant.SmsAssistantMessage.Channel::

bodystring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.Body::

mediaUrlsJsonstring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.MediaUrlsJson::

twilioSidstring nullable

::API.Modules.SmsAssistant.SmsAssistantMessage.TwilioSid::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

schoolIdstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.SchoolId::

adminIdstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.AdminId::

emailstring required

::API.Modules.SystemEmails.SystemEmailMessage.Email::

kindstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Kind::

subjectstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Subject::

status'sent' | 'exceedLimit' | 'error'

::API.Modules.SystemEmails.SystemEmailMessage.Status::

errorstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.Error::

fromstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.From::

isTestboolean

::API.Modules.SystemEmails.SystemEmailMessage.IsTest::

deliveryStatus'none' | 'delivered' | 'bounced' | 'complained' | 'unsubscribed'

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryStatus::

deliveryDatestring date-time nullable

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryDate::

deliveryErrorstring nullable

::API.Modules.SystemEmails.SystemEmailMessage.DeliveryError::

openedDatestring date-time nullable

::API.Modules.SystemEmails.SystemEmailMessage.OpenedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

::API.Modules.SmsAssistant.AdminWhatsAppAccount.AdminId::

phoneE164string nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.PhoneE164::

connectTokenstring nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.ConnectToken::

verificationCodestring nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.VerificationCode::

state'pending' | 'codeSent' | 'verified'

::API.Modules.SmsAssistant.AdminWhatsAppAccount.State::

expiresAtstring date-time nullable

::API.Modules.SmsAssistant.AdminWhatsAppAccount.ExpiresAt::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

isActivePendingboolean

::API.Modules.SmsAssistant.AdminWhatsAppAccount.IsActivePending::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

schoolIdstring required

::API.Modules.AI.Memory.AiAssistantMemory.SchoolId::

kind'fact' | 'preference' | 'entity' | 'profile'

::API.Modules.AI.Memory.AiAssistantMemory.Kind::

contentstring required

::API.Modules.AI.Memory.AiAssistantMemory.Content::

importanceinteger

::API.Modules.AI.Memory.AiAssistantMemory.Importance::

entityTypestring nullable

::API.Modules.AI.Memory.AiAssistantMemory.EntityType::

entityIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.EntityId::

sourceDialogIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.SourceDialogId::

createdByAdminIdstring nullable

::API.Modules.AI.Memory.AiAssistantMemory.CreatedByAdminId::

createdDatestring date-time

Creation date

lastUsedDatestring date-time nullable

::API.Modules.AI.Memory.AiAssistantMemory.LastUsedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

subjectstring nullable

Subject

bodystring nullable

Email body

plainTextstring nullable

Plain text

preheaderstring nullable

Preheader

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

subtype'adminResetPassword' | 'adminInvite' | 'studentEmailConfirmation' | 'studentInvite' | 'studentResetPassword' | 'studentPurchase' | 'webinarRegistration' | 'webinarUpcomingReminder' | 'webinarStartReminder' | 'adminInvoice' | 'productRenewalPaymentSucceeded' | 'productRenewalPaymentFailed' | 'adminConfirmCode' | 'adminEmailConfirmation' | 'studentCert' | 'meetingRegistration' | 'meetingConfirmation' | 'meetingStartReminder' nullable

Subtype

type'system' | 'custom'

Type

purpose'marketing' | 'transactional'

::API.Modules.Emails.EmailTemplate.Purpose::

purposeSource'default' | 'author' | 'check'

::API.Modules.Emails.EmailTemplate.PurposeSource::

systemTemplateIdstring nullable

System template ID

systemTemplateAccelModelProjectModulesEmailsEmailTemplate circular
sentCountinteger

Number of emails sent

openCountinteger

Total opens

clickCountinteger

Total clicks

openUniqueCountinteger

Unique opens

clickUniqueCountinteger

Unique clicks

unsubscribeCountinteger

Total unsubscribes

lastSendDatestring date-time nullable

Date the template was last sent

purchaseCountinteger nullable

Number of purchases

purchaseAmountnumber double nullable

Total purchase amount

openRatenumber double

Open rate

clickRatenumber double

Click-to-open rate

unsubscribeRatenumber double

Unsubscribe rate

emailProfileIdstring nullable

Email profile ID

creatorIdstring nullable

Creator ID

aiDialogIdstring nullable

::API.Modules.Emails.EmailTemplate.AiDialogId::

brandStyleIdstring nullable

::API.Modules.Emails.EmailTemplate.BrandStyleId::

hasBodyboolean

Whether the template has a body

hasSubjectboolean

Whether the template has a subject line

hasPreheaderboolean

Whether the template has a preheader

canOverrideboolean

Whether the account can override this template with its own copy

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

dateCreatedstring date-time

Date created

isSendedboolean

Whether the email was sent

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

templateIdstring required

Template ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'accel' | 'custom'

Type

namestring nullable

Name

descriptionstring nullable

Description

fromEmailstring nullable

From address

replyToEmailstring nullable

Reply-to address

senderNamestring nullable

Sender name

additionalTextstring nullable

Additional text

isPrimaryboolean

Whether this is the primary email profile

hasUnsubscribeLinkboolean

Whether emails include an unsubscribe link

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

emailDomainIdstring nullable

Email domain ID

sentCountinteger

Number of emails sent

smtpUrlstring nullable

SMTP URL

smtpLoginstring nullable

SMTP username

smtpPasswordstring nullable

SMTP password

smtpPortinteger

SMTP port

smtpUseSSLboolean

Whether SMTP uses SSL

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

type'system' | 'custom'

Type

inboundEnabledboolean

Whether inbound email is enabled

isCustomboolean

Whether this is a custom domain

isSystemboolean

Whether this is a system domain

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Emails.EmailResponsible.Name::

emailstring nullable

::API.Modules.Emails.EmailResponsible.Email::

fromstring nullable

::API.Modules.Emails.EmailResponsible.From::

catchAllboolean

::API.Modules.Emails.EmailResponsible.CatchAll::

inboundCountinteger

::API.Modules.Emails.EmailResponsible.InboundCount::

spamCountinteger

::API.Modules.Emails.EmailResponsible.SpamCount::

createdDatestring date-time

Creation date

domainIdstring nullable

::API.Modules.Emails.EmailResponsible.DomainId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

responsibleIdstring required

::API.Modules.Emails.EmailResponsibleAdminLink.ResponsibleId::

adminIdstring required

::API.Modules.Emails.EmailResponsibleAdminLink.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

reason'complained' | 'permanentFail' | 'custom' | 'providerStopList'

Reason

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

apiKeystring nullable

API key

settingJsonstring nullable

Settings in JSON format

type'elasticEmail' | 'mailgun'

Type

status'ready' | 'expired'

Status

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

status'created' | 'registered' | 'dnsRecordsRegistered' | 'verified'

Status

dnsRecordsJsonstring nullable

DNS records in JSON format

inboundDnsRecordsJsonstring nullable

Inbound email DNS records in JSON format

webhooksRegisteredboolean

Whether webhooks are registered

inboundVerifiedboolean

Whether inbound email is verified

inboundWebhookRegisteredboolean

Whether the inbound email webhook is registered

verifyUntilDatestring date-time nullable

Verification end date

inboundVerifyUntilDatestring date-time nullable

Inbound email verification end date

trackingWebhooksRegisteredboolean

::API.Modules.Emails.EmailDomainIntegration.TrackingWebhooksRegistered::

webhooksSignedboolean

::API.Modules.Emails.EmailDomainIntegration.WebhooksSigned::

inboundWebhookSignedboolean

::API.Modules.Emails.EmailDomainIntegration.InboundWebhookSigned::

trackingRequiredboolean

::API.Modules.Emails.EmailDomainIntegration.TrackingRequired::

trackingStatus'none' | 'recordMissing' | 'caaBlocked' | 'recordFound' | 'certificatePending' | 'verified' | 'httpOnly' | 'failed'

::API.Modules.Emails.EmailDomainIntegration.TrackingStatus::

trackingRequestedDatestring date-time nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingRequestedDate::

trackingCheckedDatestring date-time nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingCheckedDate::

trackingErrorstring nullable

::API.Modules.Emails.EmailDomainIntegration.TrackingError::

integrationIdstring required

Integration ID

domainIdstring required

Domain ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

addressstring nullable

::API.Modules.Emails.EmailSpamAddress.Address::

type'email' | 'domain'

::API.Modules.Emails.EmailSpamAddress.Type::

isSpamboolean

::API.Modules.Emails.EmailSpamAddress.IsSpam::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

contentHashstring required

::API.Modules.Emails.ContentCheck.EmailContentCheck.ContentHash::

policyVersioninteger

::API.Modules.Emails.ContentCheck.EmailContentCheck.PolicyVersion::

depth'rules' | 'full'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Depth::

mode'shadow' | 'advise' | 'enforce'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Mode::

verdict'ok' | 'advice' | 'block'

::API.Modules.Emails.ContentCheck.EmailContentCheck.Verdict::

aiStatus'none' | 'done' | 'failed' | 'skipped'

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiStatus::

issuesJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.IssuesJson::

categoriesJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.CategoriesJson::

purposeJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.PurposeJson::

summarystring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Summary::

snapshotJsonstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.SnapshotJson::

subjectstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Subject::

langstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.Lang::

aiModelstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiModel::

aiPriceUsdnumber double nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.AiPriceUsd::

subjectType'template' | 'broadcast' | 'inline' | 'test' | 'thirdParty' | 'system'

::API.Modules.Emails.ContentCheck.EmailContentCheck.SubjectType::

emailTemplateIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.EmailTemplateId::

broadcastIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.BroadcastId::

createdByAdminIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

reviewStatus'none' | 'pending' | 'approved' | 'rejected'

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewStatus::

reviewReason'none' | 'aiBlock' | 'aiDoubt' | 'schoolRequest' | 'purposeChanged'

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewReason::

reviewRequestedDatestring date-time nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestedDate::

reviewRequestedByAdminIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestedByAdminId::

reviewRequestCommentstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewRequestComment::

reviewedByManagerIdstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewedByManagerId::

reviewDatestring date-time nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewDate::

reviewCommentstring nullable

::API.Modules.Emails.ContentCheck.EmailContentCheck.ReviewComment::

isApprovedboolean

::API.Modules.Emails.ContentCheck.EmailContentCheck.IsApproved::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

source'auto' | 'manager'

::API.Modules.Emails.Engine.EmailAccountPause.Source::

enforcedboolean

::API.Modules.Emails.Engine.EmailAccountPause.Enforced::

reasonsstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.Reasons::

countsJsonstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.CountsJson::

commentstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.Comment::

createdByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.CreatedByManagerId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

endedDatestring date-time nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndedDate::

endedByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndedByManagerId::

endCommentstring nullable

::API.Modules.Emails.Engine.EmailAccountPause.EndComment::

isOpenboolean

::API.Modules.Emails.Engine.EmailAccountPause.IsOpen::

stopsMarketingboolean

::API.Modules.Emails.Engine.EmailAccountPause.StopsMarketing::

reasonListstring[] nullable

::API.Modules.Emails.Engine.EmailAccountPause.ReasonList::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

datestring date-time

::API.Modules.Emails.Engine.EmailAccountDailyStat.Date::

acceptedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Accepted::

deliveredinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Delivered::

hardBouncedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.HardBounced::

providerStopListinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.ProviderStopList::

spamBlockedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.SpamBlocked::

complainedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Complained::

unsubscribedinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.Unsubscribed::

acceptedMonthinteger

::API.Modules.Emails.Engine.EmailAccountDailyStat.AcceptedMonth::

scoreinteger nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.Score::

providerReputationnumber double nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.ProviderReputation::

trustLevel'new' | 'verified' | 'restricted'

::API.Modules.Emails.Engine.EmailAccountDailyStat.TrustLevel::

trustReasonstring nullable

::API.Modules.Emails.Engine.EmailAccountDailyStat.TrustReason::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

kind'trustLevel' | 'hourlyCeiling'

::API.Modules.Emails.Engine.EmailAccountOverride.Kind::

valuestring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.Value::

commentstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.Comment::

createdByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.CreatedByManagerId::

createdDatestring date-time

Creation date

endedDatestring date-time nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndedDate::

endedByManagerIdstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndedByManagerId::

endCommentstring nullable

::API.Modules.Emails.Engine.EmailAccountOverride.EndComment::

isOpenboolean

::API.Modules.Emails.Engine.EmailAccountOverride.IsOpen::

trustLevel'new' | 'verified' | 'restricted' nullable

::API.Modules.Emails.Engine.EmailAccountOverride.TrustLevel::

hourlyCeilinginteger nullable

::API.Modules.Emails.Engine.EmailAccountOverride.HourlyCeiling::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

sentDatestring date-time nullable

Sent date

scheduledSendDatestring date-time nullable

Scheduled send date

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sendImmediatelyboolean

Send immediately

alwaysSendEmailboolean

Always send email

useEmailMessageboolean nullable

Use email message

useChatMessageboolean nullable

Use chat message

textstring nullable

Text

buttonsJsonstring nullable

Chat message buttons as JSON

chatChannelsJsonstring nullable

Chat channels as JSON

chatChannelsSettingsJsonstring nullable

Chat channel settings as JSON

sessionPreparedCountinteger

Number of recipients prepared for sending

sessionProcessedCountinteger

Number of recipients processed

sessionSentErrorCountinteger

Number of recipients the broadcast failed to send to

totalProcessedCountinteger

Total number of messages processed

totalSentErrorCountinteger

Total number of send errors

totalSentCountinteger

Total number of messages sent

sessionSentCountinteger

Number of recipients the broadcast was sent to

totalEmailSentCountinteger

Total number of emails sent

totalEmailErrorCountinteger

Total number of email errors

totalEmailProcessedCountinteger

Total number of emails processed

totalChatSentCountinteger

Total number of chat messages sent

totalChatErrorCountinteger

Total number of chat errors

totalChatProcessedCountinteger

Total number of chat messages processed

openCountinteger

Number of opens

openUniqCountinteger

Number of unique opens

clickCountinteger

Number of clicks

clickUniqCountinteger

Number of unique clicks

chatButtonClickCountinteger

Number of clicks on chat message buttons

chatButtonClickUniqCountinteger

Number of unique clicks on chat message buttons

unsubscribeCountinteger

Number of unsubscribes

openRatenumber double

Open rate

clickRatenumber double

Click rate

chatButtonClickRatenumber double

Click rate on chat message buttons

unsubscribeRatenumber double

Unsubscribe rate

totalClickUniqCountinteger

Total number of unique clicks

totalClickCountinteger

Total number of clicks

totalClickRatenumber double

Overall click rate

progressnumber float

Progress

status'scheduled' | 'preparing' | 'sending' | 'sent' | 'paused' | 'aborted' | 'startError' | 'contentBlocked'

Status

version'v1' | 'v2'

Version

errorstring nullable

Error

purchaseCountinteger nullable

Number of purchases

purchaseAmountnumber double nullable

Purchase amount

broadcastListIdstring nullable

ID of the mailing list

listMode'external' | 'internal'

::API.Modules.Broadcasts.Broadcast.ListMode::

extendedFilterJsonstring nullable

::API.Modules.Broadcasts.Broadcast.ExtendedFilterJson::

createdByAdminIdstring nullable

ID of the admin who created the broadcast

softDeletedByAdminIdstring nullable

ID of the admin who deleted the broadcast

emailTemplateIdstring nullable

ID of the email template

emailTemplateMode'existing' | 'new'

Email template mode

customEmailTemplateJsonstring nullable

Custom email template as JSON

abortedByAdminIdstring nullable

ID of the admin who canceled the broadcast

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

type'manual' | 'dynamic'

Type

extendedFilterJsonstring nullable

Advanced filter as JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

broadcastIdstring required

ID of the broadcast

fileIdstring required

ID of the file

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Schools.School.Name::

descriptionstring nullable

::API.Modules.Schools.School.Description::

numberinteger

::API.Modules.Schools.School.Number::

domainstring required

::API.Modules.Schools.School.Domain::

techDomainPostfixstring nullable

::API.Modules.Schools.School.TechDomainPostfix::

maxEmailsPerHourinteger

::API.Modules.Schools.School.MaxEmailsPerHour::

emailReputationnumber double

::API.Modules.Schools.School.EmailReputation::

emailThrottlingEnabledboolean

::API.Modules.Schools.School.EmailThrottlingEnabled::

customDomainstring nullable

::API.Modules.Schools.School.CustomDomain::

customDomainDnsTarget'unknown' | 'current' | 'legacy' | 'external' | 'none'

::API.Modules.Schools.School.CustomDomainDnsTarget::

customDomainDnsCheckedDatestring date-time nullable

::API.Modules.Schools.School.CustomDomainDnsCheckedDate::

timezoneIdstring nullable

::API.Modules.Schools.School.TimezoneId::

timezoneOffsetstring nullable

::API.Modules.Schools.School.TimezoneOffset::

countryIdstring nullable

::API.Modules.Schools.School.CountryId::

disableOpenRegistrationboolean

::API.Modules.Schools.School.DisableOpenRegistration::

showUnavailableStartedCoursesboolean

::API.Modules.Schools.School.ShowUnavailableStartedCourses::

isForumAvailableboolean

::API.Modules.Schools.School.IsForumAvailable::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

statisticsUpdatedDatestring date-time nullable

::API.Modules.Schools.School.StatisticsUpdatedDate::

jsHeadCodestring nullable

::API.Modules.Schools.School.JsHeadCode::

jsBodyCodestring nullable

::API.Modules.Schools.School.JsBodyCode::

customCodeAllowedboolean

::API.Modules.Schools.School.CustomCodeAllowed::

customCodeEnabledboolean

::API.Modules.Schools.School.CustomCodeEnabled::

leadScoringEnabledboolean

::API.Modules.Schools.School.LeadScoringEnabled::

customCodeFileIdstring nullable

::API.Modules.Schools.School.CustomCodeFileId::

defaultBrandStyleIdstring nullable

::API.Modules.Schools.School.DefaultBrandStyleId::

supportChatEnabledboolean

::API.Modules.Schools.School.SupportChatEnabled::

supportConversationTitlestring nullable

::API.Modules.Schools.School.SupportConversationTitle::

recordInternalCallsboolean

::API.Modules.Schools.School.RecordInternalCalls::

recordCRMCallsboolean

::API.Modules.Schools.School.RecordCRMCalls::

migrationStatus'default' | 'pending' | 'inProgress' | 'completed' | 'aborted' | 'error'

::API.Modules.Schools.School.MigrationStatus::

scheduledDeletingDatestring date-time nullable

::API.Modules.Schools.School.ScheduledDeletingDate::

deletionStatus'default' | 'pending' | 'messageHasBeenSent' | 'completed' | 'error'

::API.Modules.Schools.School.DeletionStatus::

externalIdstring nullable

::API.Modules.Schools.School.ExternalId::

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

::API.Modules.Schools.School.Lang::

type'simple' | 'thirdParty'

::API.Modules.Schools.School.Type::

featuresstring[] nullable

::API.Modules.Schools.School.Features::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Schools.School.Currency::

logoIdstring nullable

::API.Modules.Schools.School.LogoId::

faviconIdstring nullable

::API.Modules.Schools.School.FaviconId::

ownerIdstring nullable

::API.Modules.Schools.School.OwnerId::

studentProfileSettingsIdstring nullable

::API.Modules.Schools.School.StudentProfileSettingsId::

mainSiteDomainIdstring nullable

::API.Modules.Schools.School.MainSiteDomainId::

organizationIdstring nullable

::API.Modules.Schools.School.OrganizationId::

schoolStatisticsIdstring nullable

::API.Modules.Schools.School.SchoolStatisticsId::

currentDomainstring nullable

::API.Modules.Schools.School.CurrentDomain::

isExternalboolean

::API.Modules.Schools.School.IsExternal::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

defaultVideoProvider'cloudVideo' | 'museVideo' | 'custom' | 'kinescope' | 'axl' nullable

::API.Modules.Schools.SchoolMetadata.DefaultVideoProvider::

organisationActivity'existingOnlineSchool' | 'creatingOnlineSchool' | 'studying' | 'technicalSpecialist' | 'other'

::API.Modules.Schools.SchoolMetadata.OrganisationActivity::

organisationActivityOtherstring nullable

::API.Modules.Schools.SchoolMetadata.OrganisationActivityOther::

howDidYouHearAboutUs'internet' | 'wordOfMouth' | 'socialMedia' | 'other'

::API.Modules.Schools.SchoolMetadata.HowDidYouHearAboutUs::

howDidYouHearAboutUsOtherstring nullable

::API.Modules.Schools.SchoolMetadata.HowDidYouHearAboutUsOther::

employeesNumber'lessThan10' | 'from10To25' | 'from50To100' | 'moreThan100'

::API.Modules.Schools.SchoolMetadata.EmployeesNumber::

leadsNumber'lessThan1k' | 'from1kTo5k' | 'from5kTo10k' | 'from10kTo50k' | 'from50kTo100k' | 'moreThan100k'

::API.Modules.Schools.SchoolMetadata.LeadsNumber::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

partnerEmailstring nullable

::API.Modules.Schools.SchoolMetadata.PartnerEmail::

partnerBonusAmountnumber double

::API.Modules.Schools.SchoolMetadata.PartnerBonusAmount::

partnerBonusTransactionIdstring nullable

::API.Modules.Schools.SchoolMetadata.PartnerBonusTransactionId::

billingPromoCodeIdstring nullable

::API.Modules.Schools.SchoolMetadata.BillingPromoCodeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

Admin ID

poststring nullable

Job title

isConfirmedboolean

Confirmed

updatedDatestring date-time

Date the record was last updated.

createdDatestring date-time

Creation date

lastActivityDatestring date-time nullable

Last activity date

emailUnsubscribedboolean

Unsubscribed from emails

emailUnsubscribedDatestring date-time nullable

Email unsubscribe date

softDeletedByAdminIdstring nullable

ID of the admin who soft-deleted the record

chatUserIdstring nullable

Chat user ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailboolean

Email

emailNeedConfirmboolean

Email confirmation required

blockAccessIfEmailUnconfirmedboolean

Block access until email is confirmed

blockEmailChangeboolean

Block email changes

phoneboolean

Phone

phoneRequiredboolean

Phone required

phoneNeedConfirmboolean

Phone confirmation required

blockAccessIfPhoneUnconfirmedboolean

Block access until phone is confirmed

firstNameboolean

First name

firstNameRequiredboolean

First name required

lastNameboolean

Last name

lastNameRequiredboolean

Last name required

middleNameboolean

Middle name

middleNameRequiredboolean

Middle name required

birthdayboolean

Birthday

birthdayRequiredboolean

Birthday required

genderboolean

Gender

genderRequiredboolean

Gender required

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'month' | 'total'

::API.Modules.Schools.SchoolStatistics.Type::

contactsCountinteger

::API.Modules.Schools.SchoolStatistics.ContactsCount::

importedContactsCountinteger

::API.Modules.Schools.SchoolStatistics.ImportedContactsCount::

studentsCountinteger

::API.Modules.Schools.SchoolStatistics.StudentsCount::

activeStudentsCountinteger

::API.Modules.Schools.SchoolStatistics.ActiveStudentsCount::

adminsCountinteger

::API.Modules.Schools.SchoolStatistics.AdminsCount::

sentEmailMessagesCountinteger

::API.Modules.Schools.SchoolStatistics.SentEmailMessagesCount::

chatMessagesCountinteger

::API.Modules.Schools.SchoolStatistics.ChatMessagesCount::

webinarUsersCountinteger

::API.Modules.Schools.SchoolStatistics.WebinarUsersCount::

coursesCountinteger

::API.Modules.Schools.SchoolStatistics.CoursesCount::

sitesCountinteger

::API.Modules.Schools.SchoolStatistics.SitesCount::

siteVisitsCountinteger

::API.Modules.Schools.SchoolStatistics.SiteVisitsCount::

convertedVideoDurationnumber double

::API.Modules.Schools.SchoolStatistics.ConvertedVideoDuration::

videoViewsCountinteger

::API.Modules.Schools.SchoolStatistics.VideoViewsCount::

videoViewsDurationnumber double

::API.Modules.Schools.SchoolStatistics.VideoViewsDuration::

activityDayCountinteger

::API.Modules.Schools.SchoolStatistics.ActivityDayCount::

paymentsAmountnumber double

::API.Modules.Schools.SchoolStatistics.PaymentsAmount::

usedFilesSpaceAmountinteger

::API.Modules.Schools.SchoolStatistics.UsedFilesSpaceAmount::

usedConvertedVideoSpaceAmountinteger

::API.Modules.Schools.SchoolStatistics.UsedConvertedVideoSpaceAmount::

aiTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiTokensAmount::

aiCuratorActiveDaysAmountinteger

::API.Modules.Schools.SchoolStatistics.AiCuratorActiveDaysAmount::

aiAssistantActiveDaysAmountinteger

::API.Modules.Schools.SchoolStatistics.AiAssistantActiveDaysAmount::

aiFunctionTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiFunctionTokensAmount::

aiCuratorTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiCuratorTokensAmount::

aiAssistantTokensAmountinteger

::API.Modules.Schools.SchoolStatistics.AiAssistantTokensAmount::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

currentIdstring nullable

::API.Modules.Schools.SchoolStatistics.CurrentId::

currentAccelModelProjectModulesSchoolsSchoolStatistics circular
totalAccelModelProjectModulesSchoolsSchoolStatistics circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

balancenumber double

Balance

bonusBalancenumber double

Bonus balance

creditnumber double

Credit

agreedBillingPlanboolean

Agreed billing plan

trialDaysCountinteger

Number of trial days

discountOnMainServicesnumber double

Discount on main services

discountOnExtraServicesnumber double

Discount on extra services

aiSpendCapUsdnumber double nullable

::API.Modules.Schools.SchoolBilling.AiSpendCapUsd::

aiSpendCapsJsonstring nullable

::API.Modules.Schools.SchoolBilling.AiSpendCapsJson::

aiBonusSpentUsdnumber double

::API.Modules.Schools.SchoolBilling.AiBonusSpentUsd::

telephonySpendCapUsdnumber double nullable

::API.Modules.Schools.SchoolBilling.TelephonySpendCapUsd::

stripeCustomerIdstring nullable

::API.Modules.Schools.SchoolBilling.StripeCustomerId::

stripeSubscriptionIdstring nullable

::API.Modules.Schools.SchoolBilling.StripeSubscriptionId::

stripeSubscriptionStatusstring nullable

::API.Modules.Schools.SchoolBilling.StripeSubscriptionStatus::

billingAnchorDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.BillingAnchorDate::

scheduledBillingPlanIdstring nullable

::API.Modules.Schools.SchoolBilling.ScheduledBillingPlanId::

scheduledPlanChangeDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.ScheduledPlanChangeDate::

hasScheduledPlanChangeboolean

::API.Modules.Schools.SchoolBilling.HasScheduledPlanChange::

trialReminderSentDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialReminderSentDate::

trialEndedNoticeSentDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialEndedNoticeSentDate::

autoRechargeboolean

Auto-recharge

autoRechargeAmountnumber double

Auto-recharge amount

autoRechargeBalancenumber double

Auto-recharge balance

createdDatestring date-time

Creation date

recalculateFromDatestring date-time nullable

Recalculate from date

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

billingPlanIdstring required

Billing plan ID

autoRechargePaymentMethodIdstring nullable

Auto-recharge payment method ID

trialCompletedDatestring date-time nullable

Trial end date

totalBalancenumber double

Total balance

totalBalanceWithCreditnumber double

Total balance with credit

trialEndExclusiveDatestring date-time nullable

::API.Modules.Schools.SchoolBilling.TrialEndExclusiveDate::

isAwaitingSubscriptionboolean

::API.Modules.Schools.SchoolBilling.IsAwaitingSubscription::

isLockedboolean

Locked

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isRegistrationAgreementEnabledboolean

::API.Modules.Schools.SchoolSettings.IsRegistrationAgreementEnabled::

registrationAgreementTextstring nullable

::API.Modules.Schools.SchoolSettings.RegistrationAgreementText::

isCookieNotificationEnabledboolean

::API.Modules.Schools.SchoolSettings.IsCookieNotificationEnabled::

cookieNotificationTextstring nullable

::API.Modules.Schools.SchoolSettings.CookieNotificationText::

isPageFooterEnabledboolean

::API.Modules.Schools.SchoolSettings.IsPageFooterEnabled::

footerTextstring nullable

::API.Modules.Schools.SchoolSettings.FooterText::

isLearnPageFooterEnabledboolean

::API.Modules.Schools.SchoolSettings.IsLearnPageFooterEnabled::

userSessionCountLimitEnabledboolean

::API.Modules.Schools.SchoolSettings.UserSessionCountLimitEnabled::

userSessionCountLimitinteger

::API.Modules.Schools.SchoolSettings.UserSessionCountLimit::

deductionEnabledboolean

::API.Modules.Schools.SchoolSettings.DeductionEnabled::

deductionnumber double

::API.Modules.Schools.SchoolSettings.Deduction::

outboundCallCountryMode'all' | 'allowList' | 'denyList'

::API.Modules.Schools.SchoolSettings.OutboundCallCountryMode::

outboundCallCountriesstring nullable

::API.Modules.Schools.SchoolSettings.OutboundCallCountries::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

currentStepstring nullable

::API.Modules.Schools.SchoolMigration.CurrentStep::

totalCountinteger

::API.Modules.Schools.SchoolMigration.TotalCount::

processedCountinteger

::API.Modules.Schools.SchoolMigration.ProcessedCount::

errorstring nullable

::API.Modules.Schools.SchoolMigration.Error::

settingsJsonstring nullable

::API.Modules.Schools.SchoolMigration.SettingsJson::

additionalDataJsonstring nullable

::API.Modules.Schools.SchoolMigration.AdditionalDataJson::

source'postgreSql' | 'warehousePostgreSql' | 's3' | 'webhook' | 'kinescope' | 'emails'

::API.Modules.Schools.SchoolMigration.Source::

status'default' | 'pending' | 'inProgress' | 'completed' | 'aborted' | 'error'

::API.Modules.Schools.SchoolMigration.Status::

scheduledDatestring date-time

::API.Modules.Schools.SchoolMigration.ScheduledDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time nullable

::API.Modules.Schools.SchoolMigration.BeginDate::

endDatestring date-time nullable

::API.Modules.Schools.SchoolMigration.EndDate::

durationInMinutesinteger

::API.Modules.Schools.SchoolMigration.DurationInMinutes::

progressnumber float

::API.Modules.Schools.SchoolMigration.Progress::

sourceProgressnumber float

::API.Modules.Schools.SchoolMigration.SourceProgress::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.AdminId::

stepsJsonstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.StepsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.CompletedDate::

pausedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.PausedDate::

pauseCountinteger

::API.Modules.Schools.SchoolImplementationOnboarding.PauseCount::

feedbackRatinginteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackRating::

feedbackCommentstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackComment::

feedbackSubmittedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackSubmittedDate::

feedbackSubmittedByAdminIdstring nullable

::API.Modules.Schools.SchoolImplementationOnboarding.FeedbackSubmittedByAdminId::

progressPercentinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressPercent::

progressStepsHandledinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressStepsHandled::

progressStepsTotalinteger nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressStepsTotal::

progressUpdatedDatestring date-time nullable

::API.Modules.Schools.SchoolImplementationOnboarding.ProgressUpdatedDate::

isCompletedboolean

::API.Modules.Schools.SchoolImplementationOnboarding.IsCompleted::

isPausedboolean

::API.Modules.Schools.SchoolImplementationOnboarding.IsPaused::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

middleNamestring nullable

Middle name

lastNamestring nullable

Last name

phonestring nullable

Phone

phoneE164string nullable

Phone in E.164 format

commentstring nullable

Comment

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

gender'male' | 'female' | 'other' nullable

Gender

birthdaystring date-time nullable

Birthday

emailConfirmationSentDatestring date-time nullable

Date the email confirmation was sent

phoneConfirmationSentDatestring date-time nullable

Date the phone confirmation was sent

registrationDatestring date-time nullable

Registration date

lastActivityDatestring date-time nullable

Last activity date

updatedDatestring date-time nullable

Date the record was last updated.

lastSeenDatestring date-time nullable

Last seen date

createdDatestring date-time

Creation date

emailLastClickDatestring date-time nullable

Date of the last click in an email

emailLastOpenDatestring date-time nullable

Date an email was last opened

concurrencyStampstring nullable

Concurrency stamp

isSchoolEmailConfirmedboolean

Email address verified in the Student Portal

isEmailConfirmedboolean

Email address verified

isPhoneConfirmedboolean

Phone number verified

isTemporaryboolean

Temporary

isRegistrationAgreementAcceptedboolean nullable

Registration agreement accepted

needChangePasswordboolean

Password change required

mergingboolean nullable

Merging

bannedboolean nullable

Banned

commentsBannedboolean nullable

::API.Modules.Students.Student.CommentsBanned::

emailUnsubscribedboolean

Unsubscribed from emails

emailUnsubscribedDatestring date-time nullable

Date unsubscribed from emails

doNotCallboolean

::API.Modules.Students.Student.DoNotCall::

doNotCallDatestring date-time nullable

::API.Modules.Students.Student.DoNotCallDate::

leadPriorityinteger nullable

::API.Modules.Students.Student.LeadPriority::

leadPriorityTier'none' | 'cold' | 'warm' | 'hot'

::API.Modules.Students.Student.LeadPriorityTier::

leadPriorityProbabilitynumber double nullable

::API.Modules.Students.Student.LeadPriorityProbability::

leadPriorityLiftnumber double nullable

::API.Modules.Students.Student.LeadPriorityLift::

leadPriorityReasonsJsonstring nullable

::API.Modules.Students.Student.LeadPriorityReasonsJson::

leadPriorityDatestring date-time nullable

::API.Modules.Students.Student.LeadPriorityDate::

countrystring nullable

Country

citystring nullable

City

regionstring nullable

Region

ipstring nullable

IP address

timezoneIdstring nullable

Time zone ID

timezoneJsonstring nullable

Time zone (JSON)

webinarCountinteger

Number of webinars

paymentsAmountnumber double

Total payment amount

paymentsAmountUsdnumber double nullable

Total payment amount in USD

paymentsCountnumber double

Number of payments

bonusBalancenumber double

Bonus balance

enterUTMSourcestring nullable

First UTM source

enterUTMMediumstring nullable

First UTM medium

enterUTMCampaignstring nullable

First UTM campaign

enterUTMTermstring nullable

First UTM term

enterUTMContentstring nullable

First UTM content

exitUTMSourcestring nullable

Last UTM source

exitUTMMediumstring nullable

Last UTM medium

exitUTMCampaignstring nullable

Last UTM campaign

exitUTMTermstring nullable

Last UTM term

exitUTMContentstring nullable

Last UTM content

normalizedCommunicationsstring nullable

Normalized contact channels

onlineStatus'offline' | 'online'

Online status

avatarIdstring nullable

Avatar ID

chatUserIdstring nullable

Chat user ID

partnerIdstring nullable

Affiliate ID

partnerExpireDatestring date-time nullable

Affiliate expiration date

externalIdstring nullable

External ID

tagsstring[] nullable

Tags

groupsstring[] nullable

Groups

hasFirstNameboolean

Has first name

hasLastNameboolean

Has last name

hasEmailboolean

Has email

hasPhoneboolean

Has phone

hasPhoneE164boolean

Has E.164 phone number

hasAvatarIdboolean

Has avatar ID

hasBirthdayboolean

Has birthday

hasGenderboolean

Has gender

hasPaymentsboolean

Has payments

hasConcurrencyStampboolean

Has concurrency stamp

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

repetitiveboolean

Whether the license is a renewal

type'course' | 'coursePlan' | 'productPackage' | 'flowDate' | 'library' | 'product' | 'allCourses' | 'allLibraries' nullable

Type

state'active' | 'paused'

State

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

creditEndDatestring date-time nullable

Grace period end date

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expirationEventTriggeredboolean

Expiration event triggered

suspendedPeriodInSecinteger

Suspension period, in seconds

renewalCountLimitEnabledboolean

Renewal limit enabled

renewalCountLimitinteger nullable

Renewal limit

studentIdstring required

Contact ID

productPackageIdstring nullable

Product package ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Plan ID

libraryAccessIdstring nullable

Library access ID

dateFlowIdstring nullable

Cohort dates ID

productIdstring nullable

Product ID

purchaseOrderIdstring nullable

Order ID

currentRenewalIdstring nullable

Current renewal ID

currentSuspensionIdstring nullable

Current suspension ID

paymentMethodIdstring nullable

Payment method ID

gamificationProductIdstring nullable

Gamification product ID

hasOrderIdboolean

Has an order ID

isCourseboolean

Course

isLibraryboolean

Library

isFlowDateboolean

Cohort dates

isProductboolean

Product

isAllCousesboolean

All courses

isAllLibrariesboolean

All libraries

relevance'past' | 'present' | 'future'

Validity status

hasCourseIdboolean

Has a course ID

hasCoursePlanIdboolean

Has a plan ID

hasFlowDateIdboolean

Has a cohort dates ID

hasProductIdboolean

Has a product ID

hasLibraryItemIdsboolean

Has library step IDs

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Users.StudentRole.Name::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.Users.StudentRoleLink.StudentId::

studentRoleIdstring required

::API.Modules.Users.StudentRoleLink.StudentRoleId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

beginDatestring date-time nullable

Start date

endDatestring date-time nullable

End date

lastActivityDatestring date-time nullable

Last activity date

state'notStarted' | 'inProgress' | 'ended'

State

progressnumber float

Progress

scoreinteger

Score

feedbackstring nullable

Feedback

studentIdstring required

Contact ID

courseIdstring required

Course ID

currentCourseItemIdstring nullable

Current course step ID

hasFeedbackboolean

Has feedback

flowBeginDatestring date-time nullable

Cohort start date

accessBeginDatestring date-time nullable

Access start date

accessEndDatestring date-time nullable

Access end date

isSubscriptionboolean

Subscription

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.Students.StudentApplicationSchoolLink.StudentId::

applicationSchoolLinkIdstring required

::API.Modules.Students.StudentApplicationSchoolLink.ApplicationSchoolLinkId::

settingsJsonstring nullable

::API.Modules.Students.StudentApplicationSchoolLink.SettingsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time

Start date

completeDatestring date-time nullable

Completion date

precompleteDatestring date-time nullable

Preliminary completion date

theoryStatusboolean nullable

Theory status

testStatusboolean nullable

Test status

taskStatus'default' | 'started' | 'pending' | 'completed' nullable

Assignment status

status'default' | 'opened'

Status

numberUncheckedTasksinteger

Number of assignments not yet reviewed

numberCorrectTasksinteger

Number of assignments answered correctly

numberIncorrectTasksinteger

Number of assignments answered incorrectly

scoreinteger

Score

courseItemIdstring required

Step ID

ratingIdstring nullable

Rating ID

studentCourseIdstring required

ID of the contact's course enrollment

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

status'default' | 'pending' | 'incorrect' | 'correct' | 'incomplete' | 'editing'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastStudentCommentDatestring date-time nullable

Last contact comment date

lastAdminCommentDatestring date-time nullable

Last admin comment date

lastStudentCommentSeenByAdminDatestring date-time nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.LastStudentCommentSeenByAdminDate::

studentIdstring nullable

Contact ID

courseItemTaskIdstring required

Assignment ID

applicationSchoolLinkIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.ApplicationSchoolLinkId::

aiCuratorTaskReviewIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.AiCuratorTaskReviewId::

studentCourseItemProgressIdstring required

ID of the contact's progress on the course step

courseIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswer.CourseId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

stringValuestring nullable

String

booleanValueboolean nullable

Boolean value

listValuestring nullable

List

listLabelValuestring nullable

List of labels

multiListValuestring nullable

Multi-select list

multiListLabelValuestring nullable

Multi-select list labels

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fieldIdstring nullable

Field ID

answerIdstring required

Answer ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isRightboolean

Is correct

studentIdstring required

Contact ID

courseItemTestIdstring required

Test ID

studentCourseItemProgressIdstring required

ID of the contact's progress on the course step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

commentstring nullable

Comment

studentCourseItemTaskAnswerIdstring required

Answer ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

schoolLinkIdstring nullable

::API.Modules.Students.StudentCourseItemTaskAnswerComment.SchoolLinkId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

commentstring nullable

Comment

ratinginteger

Rating

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sectionType'course' | 'library'

Section type

studentIdstring required

Contact ID

courseItemIdstring nullable

Course step ID

libraryItemIdstring nullable

Library step ID

studentCourseItemProgressIdstring nullable

ID of the contact's progress on the course step

studentLibraryItemProgressIdstring nullable

ID of the contact's progress on the library step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

groupIdstring required

Group ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

studentIdstring required

::API.Modules.Students.StudentProduct.StudentId::

productIdstring required

::API.Modules.Students.StudentProduct.ProductId::

orderIdstring nullable

::API.Modules.Students.StudentProduct.OrderId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

completedDatestring date-time nullable

Completion date

blockingNodePayloadJsonstring nullable

Payload JSON of the step the run is waiting on

scenarioIdstring required

Automation ID

studentIdstring required

Contact ID

initialNodeIdstring required

Starting step ID

lastExecutedNodeIdstring nullable

Last executed step ID

blockingNodeIdstring nullable

ID of the step the run is waiting on

completedByAdminIdstring nullable

ID of the admin who completed the run

chatConversationIdstring nullable

Chat conversation ID

webinarIdstring nullable

Webinar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

broadcastListIdstring required

Mailing list ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

studentIdstring required

Contact ID

webinarIdstring required

Webinar ID

webinarUserIdstring required

Webinar attendee ID

presenceDurationInSecinteger

Time spent in the webinar, in seconds

presenceMinutesinteger[] nullable

::API.Modules.Users.StudentWebinarLink.PresenceMinutes::

presenceMinutesCountinteger

::API.Modules.Users.StudentWebinarLink.PresenceMinutesCount::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

cardFirstSixDigitsstring nullable

First six digits of the card

cardLastFourDigitsstring nullable

Last four digits of the card

cardExpMonthinteger nullable

Card expiration month

cardExpYearinteger nullable

Card expiration year

externalIdstring nullable

External ID

settingsJsonstring nullable

Settings JSON

gatewayIdstring required

Payment gateway ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

attemptinteger

Attempts

errorstring nullable

Error

status'process' | 'success' | 'fail' | 'cancel'

Status

tryDatestring date-time nullable

Attempt date

durationInDaysnumber double

Duration in days

trialboolean nullable

Trial

licenseIdstring required

License ID

orderIdstring nullable

Order ID

paymentIdstring nullable

Payment ID

paymentMethodIdstring nullable

Payment method ID

gamificationProductIdstring nullable

Gamification product ID

originalProductIdstring nullable

Original product ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

Start date

endDatestring date-time

End date

licenseIdstring required

License ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

externalNamestring nullable

External nickname

externalFirstNamestring nullable

External first name

externalLastNamestring nullable

External last name

type'email' | 'vk' | 'tg' | 'vb' | 'fb' | 'wa' | 'ig' | 'line' | 'phone' | 'threads'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

unsubscribedboolean nullable

Unsubscribed

unsubscribedDatestring date-time nullable

Unsubscribe date

confirmedboolean nullable

Confirmed

confirmationTokenstring nullable

Confirmation token

confirmationTokenSentDatestring date-time nullable

Date the confirmation token was sent

confirmationAttemptsLeftinteger

Confirmation attempts left

confirmationType'tgGateway' | 'sms'

Confirmation type

blockedUntilstring date-time nullable

Blocked until

sendingsLeftinteger

Messages left to send

studentIdstring nullable

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sourceIdstring required

::API.Modules.Students.StudentDuplicateLink.SourceId::

targetIdstring required

::API.Modules.Students.StudentDuplicateLink.TargetId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

amountnumber double

Amount

commentstring nullable

Comment

validUntilDatestring date-time nullable

Valid until

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

studentCreatorIdstring nullable

ID of the contact who created the transaction

orderIdstring nullable

Order ID

transactionIdstring nullable

Affiliate program transaction ID

scenarioNodeIdstring nullable

Automation step ID

burnedTransactionIdstring nullable

Expired transaction ID

burnedTransactionAccelModelProjectModulesStudentsStudentBonusTransaction circular
type'deposit' | 'withdrawal'

Type

burnedAmountnumber double nullable

Expired amount

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

lastStudyDatestring date-time nullable

Last study date

continuousStudyStartDatestring date-time nullable

Learning streak start date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Course title

shortDescriptionstring nullable

Brief description of the course

desingStyleHTMLPublishedstring nullable

Published HTML code of the course design style

showOnSiteboolean

Show the course on the website

showInSchoolboolean

Show the course in the Student Portal

showOnlyForWhoHaveAccessboolean

Show course only to users with access

freeAccessboolean

Available for free

isPublishedboolean

Published

dontAskFeedbackboolean

Disable feedback requests

gamificationEnabledboolean

Gamification enabled

isCompleteAnyCourseRequirementboolean

Completing any one of the required courses is enough to start this course

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentCountinteger

Number of students

showIfNoAccessboolean

::API.Modules.Courses.Course.ShowIfNoAccess::

paymentUrlstring nullable

::API.Modules.Courses.Course.PaymentUrl::

appearanceSettingsJsonstring nullable

::API.Modules.Courses.Course.AppearanceSettingsJson::

primaryImageIdstring nullable

Primary image ID

certIdstring nullable

Certificate ID

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

courseIdstring required

Course ID

categoryIdstring required

Category ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

disableTimeLimitsboolean

Disable time limits

isPopularboolean

Popular

courseIdstring required

Course ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

status'processing' | 'correct' | 'incorrect' | 'incomplete' | 'manualReviewRequired' | 'error'

::API.Modules.AI.AiCuratorTaskReview.Status::

commentstring nullable

::API.Modules.AI.AiCuratorTaskReview.Comment::

confidencePercentageinteger

::API.Modules.AI.AiCuratorTaskReview.ConfidencePercentage::

tokensinteger

::API.Modules.AI.AiCuratorTaskReview.Tokens::

errorMessagestring nullable

::API.Modules.AI.AiCuratorTaskReview.ErrorMessage::

internalReasoningstring nullable

::API.Modules.AI.AiCuratorTaskReview.InternalReasoning::

additionalDatastring nullable

::API.Modules.AI.AiCuratorTaskReview.AdditionalData::

studentCourseItemTaskAnswerIdstring required

::API.Modules.AI.AiCuratorTaskReview.StudentCourseItemTaskAnswerId::

schoolLinkIdstring required

::API.Modules.AI.AiCuratorTaskReview.SchoolLinkId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

commentCountinteger

Comment count

allowCommentsboolean

Allow comments

showCommentsboolean

Show comments

disableCommentModerationboolean

Disable comment moderation

blockCourseUntilTasksApprovedboolean

Lock the course until assignments are approved

theoryVisibleboolean

Show theory

tasksVisibleboolean

Show assignments

testsVisibleboolean

Show tests

commentstring nullable

Comment for editors and tutors

type'step' | 'section'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

avgRatingnumber float

Average rating

titlestring nullable

Title

positioninteger

Position

scoreinteger

Score

isOptionalboolean

Optional

isDraftboolean

Draft

availableOnAllPlansboolean

Available on all plans

showRegardlessPlanboolean

Show regardless of plan

ratingEnabledboolean

Enable rating

ratingRequiredboolean

Rating required

ratingCommentRequiredboolean

Comment required with a rating

availability'previousStepCompleted' | 'allPreviousStepsCompleted' | 'regardlessOfPreviousSteps'

Availability

regularTimeDelayActiveboolean

Time delay enabled for a regular purchase or manual course addition

regularTimeDelayinteger nullable

Time delay for regular purchase or manual course addition

regularTimeDelayCondition'previousStep' | 'courseStart' | 'accessStart' | 'previousSectionStarted' | 'previousSectionCompleted' nullable

Time delay conditions for regular purchase or manual addition of a course

regularTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Time delay unit for a regular purchase or manual course addition

regularWaitUntilTimeActiveboolean

Wait-until-time rule enabled

regularWaitUntilTimestring date-time nullable

Wait until a specific time

regularWaitUntilTimeDaysOfWeekActiveboolean

Days-of-week rule enabled

regularWaitUntilDaysOfWeekstring[] nullable

Only on certain days of the week

flowTimeDelayActiveboolean

Time delay enabled when the course is taken in a cohort

flowTimeDelayinteger nullable

Time delay when the course is taken in a cohort

flowTimeDelayCondition'previousStep' | 'flowStart' | 'courseStart' | 'previousSectionStarted' | 'previousSectionCompleted' nullable

Time delay conditions when the course is taken in a cohort

flowTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Time delay unit when the course is taken in a cohort

flowWaitUntilTimeActiveboolean

Wait-until-time rule enabled when the course is taken in a cohort

flowWaitUntilTimestring date-time nullable

Wait until a specific time when the course is taken in a cohort

flowWaitUntilTimeDaysOfWeekActiveboolean

Days-of-week rule enabled when the course is taken in a cohort

flowWaitUntilDaysOfWeekstring[] nullable

Only on specific days of the week when the course is taken in a cohort

dateDelayActiveboolean

Specific-date availability enabled

dateDelaystring date-time nullable

Available after a specific date

preventCopingAndSelectingTextboolean

Prevent text copying and selection

numberNestedStepsinteger

Number of nested steps

layoutType'legacy' | 'custom'

::API.Modules.Courses.CourseItem.LayoutType::

customTheoryHtmlstring nullable

::API.Modules.Courses.CourseItem.CustomTheoryHtml::

brandStyleIdstring nullable

::API.Modules.Courses.CourseItem.BrandStyleId::

parentItemIdstring nullable

Parent item ID

needCheckRegularTimeDelayboolean

Time delay must be checked

needCheckFlowTimeDelayboolean

Time delay must be checked when the course is taken in a cohort

needCheckDateDelayboolean

Specific-date availability must be checked

needCheckRegularWaitUntilTimeDelayboolean

Wait-until-time rule must be checked

needCheckRegularWaitUntilTimeDaysOfWeekboolean

Days-of-week rule must be checked

needCheckFlowWaitUntilTimeDelayboolean

Wait-until-time rule must be checked when the course is taken in a cohort

needCheckFlowWaitUntilTimeDaysOfWeekboolean

Days-of-week rule must be checked when the course is taken in a cohort

needCheckRatingCommentboolean

Rating comment must be checked

isStepboolean

Is a step

numberCompletedStepsinteger

Number of completed steps

hasAccessboolean

Has access

disableTimeLimitsboolean

Time limits disabled

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

courseItemIdstring required

Step ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

courseItemIdstring required

Step ID

coursePlanIdstring required

Plan ID

attachedDatestring date-time

Date attached

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

state'moderation' | 'published' | 'notPublished'

State

sectionType'course' | 'library'

Section type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring nullable

Course step ID

libraryItemIdstring nullable

Library step ID

parentIdstring nullable

Parent comment ID

parentAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment circular
replyIdstring nullable

Reply ID

replyAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment circular
studentIdstring nullable

Contact ID

toStudentIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItemComment.ToStudentId::

schoolContentItemProgressRatingIdstring nullable

Rating ID

adminIdstring nullable

Admin ID

childrenAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment[] circular
repliesAccelModelProjectModulesSchoolContentItemsSchoolContentItemComment[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

descriptionstring nullable

Description

questionstring nullable

Question

correctAnswerstring nullable

Correct answer

disableVerificationboolean

Disable review

disableAiCuratorReviewboolean

::API.Modules.Courses.CourseItemTask.DisableAiCuratorReview::

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

placeholderstring nullable

Placeholder

descriptionstring nullable

Description

requiredboolean

Required

positioninteger

Position

additionalDatastring nullable

Additional data

type'textField' | 'textArea' | 'checkbox' | 'multiSelect' | 'monoSelect'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

taskIdstring required

Assignment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

descriptionstring nullable

Description

minPercentageCompletioninteger

Minimum passing percentage

minScoreCompletioninteger

Minimum passing score

type'simple'

Type

countingMethod'percent' | 'score'

Scoring method

positioninteger

Position

shuffleboolean

Shuffle

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

answerstring nullable

Answer

isCorrectboolean

Correct

positioninteger

Position

courseItemTestQuestionIdstring required

Question ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

questionstring nullable

Question

positioninteger

Position

scoreinteger

Score

multiAnswerboolean

Multiple answers

shuffleboolean

Shuffle

answersJsonstring nullable

Answers in JSON

type'simple' | 'correlation' | 'order' | 'missingWords' | 'choosingCorrectOption'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

courseItemTestIdstring required

Test ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'session' | 'rightsChanged' | 'bulkActionSession' | 'externalImport' | 'fileManager' | 'gamificationAchievement' | 'resetGamification' | 'aiCurator' | 'aiAssistant'

::API.Modules.Notifications.NotificationTemplate.Type::

headerstring nullable

::API.Modules.Notifications.NotificationTemplate.Header::

bodystring nullable

::API.Modules.Notifications.NotificationTemplate.Body::

requiredSendEmailboolean

::API.Modules.Notifications.NotificationTemplate.RequiredSendEmail::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

denyAccessContentAfterEndboolean

Block access to content after the cohort ends

denyAccessContentBeforeStartboolean

Block access to content before the cohort starts

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

namestring nullable

Name

beginDatestring date-time

Start date

endDatestring date-time

End date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

courseIdstring required

Course ID

coursePlanIdstring nullable

Course plan ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

flowIdstring required

Cohort ID

forumThreadIdstring required

Forum thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

flowIdstring required

Cohort ID

libraryAccessIdstring required

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

colorstring nullable

Color

positioninteger

Position

type'contact' | 'order' | 'messageTemplate'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type0 | 100 | 150 | 155 | 200 | 205 | 210 | 215 | 300 | 305 | 400 | 405 | 500 | 505 | 600 | 605 | 650 | 655 | 656 | 680 | 685 | 700 | 800 | 805 | 900 | 905 | 910 | 1000 | 1005 | 1100 | 1105 | 1110 | 1115 | 1150 | 1155 | 1500 | 1600 | 1650 | 1700 | 1750 | 1770 | 1775 | 1785 | 1800 | 1801 | 1850 | 1900 | 1950 | 1955 | 1960 | 1965 | 1970 | 1975 | 1980 | 1985 | 1990 | 1995 | 2000 | 2100 | 2200 | 2300 | 2400 | 2500 | 2600 | 2700 | 2800 | 2840 | 2850 | 2855 | 2900 | 2950 | 3000 | 3050 | 3100 | 3300 | 3400 | 3500 | 3600 | 3650 | 3700 | 3800 | 3900 | 4000 | 4100 | 4200 | 4300 | 4400 | 4500 | 4600 | 4700 | 4800 | 4900 | 5000 | 5100 | 5200 | 5300 | 5301 | 5302 | 5350 | 5400 | 5401 | 5402 | 5500 | 6000 | 6100 | 7001 | 8000 | 8100 | 8200 | 9100 | 10000 | 10100 | 10101 | 10200 | 10201 | 10300 | 10301 | 10302 | 10303 | 10304 | 11005 | 11010 | 11015 | 12001 | 13001 | 14001 | 15001 | 16001 | 16005 | 16010 | 17001 | 18001 | 18002 | 18003 | 19001 | 19002 | 20001 | 20002 | 21001 | 22001 | 22002 | 23001 | 23002 | 24001 | 25001 | 25002 | 26001 | 27001 | 28001 | 28002 | 28100 | 29001 | 30001 | 30002 | 31001 | 31002 | 32001 | 32002 | 33001 | 33002 | 33021 | 33022 | 34001 | 34002 | 35001 | 35002 | 35003 | 35005 | 36001 | 36002 | 37001 | 37002

Type

parentType0 | 100 | 150 | 155 | 200 | 205 | 210 | 215 | 300 | 305 | 400 | 405 | 500 | 505 | 600 | 605 | 650 | 655 | 656 | 680 | 685 | 700 | 800 | 805 | 900 | 905 | 910 | 1000 | 1005 | 1100 | 1105 | 1110 | 1115 | 1150 | 1155 | 1500 | 1600 | 1650 | 1700 | 1750 | 1770 | 1775 | 1785 | 1800 | 1801 | 1850 | 1900 | 1950 | 1955 | 1960 | 1965 | 1970 | 1975 | 1980 | 1985 | 1990 | 1995 | 2000 | 2100 | 2200 | 2300 | 2400 | 2500 | 2600 | 2700 | 2800 | 2840 | 2850 | 2855 | 2900 | 2950 | 3000 | 3050 | 3100 | 3300 | 3400 | 3500 | 3600 | 3650 | 3700 | 3800 | 3900 | 4000 | 4100 | 4200 | 4300 | 4400 | 4500 | 4600 | 4700 | 4800 | 4900 | 5000 | 5100 | 5200 | 5300 | 5301 | 5302 | 5350 | 5400 | 5401 | 5402 | 5500 | 6000 | 6100 | 7001 | 8000 | 8100 | 8200 | 9100 | 10000 | 10100 | 10101 | 10200 | 10201 | 10300 | 10301 | 10302 | 10303 | 10304 | 11005 | 11010 | 11015 | 12001 | 13001 | 14001 | 15001 | 16001 | 16005 | 16010 | 17001 | 18001 | 18002 | 18003 | 19001 | 19002 | 20001 | 20002 | 21001 | 22001 | 22002 | 23001 | 23002 | 24001 | 25001 | 25002 | 26001 | 27001 | 28001 | 28002 | 28100 | 29001 | 30001 | 30002 | 31001 | 31002 | 32001 | 32002 | 33001 | 33002 | 33021 | 33022 | 34001 | 34002 | 35001 | 35002 | 35003 | 35005 | 36001 | 36002 | 37001 | 37002 nullable

Parent permission type

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminSchoolIdstring required

Team member ID

rightIdstring required

Permission ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

policyIdstring required

Policy ID

parentIdstring required

Parent policy ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

policyIdstring required

Policy ID

rightIdstring required

Permission ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminSchoolIdstring required

Team member ID

policyIdstring required

Policy ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

filterIdstring required

Filter ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

siteIdstring nullable

Website ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

ID of the admin who created the record

updatedByAdminIdstring nullable

ID of the admin who last updated the record

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

entityType'lead' | 'purchaseOrder' | 'purchaseOrderPayment' | 'chatUser' | 'quizAnswer' | 'webinarChatMessage' | 'courseItemRating' | 'webinarEvent' | 'webinarUser' | 'courseItemComment' | 'courseFeedback'

Entity type

type'export' | 'import'

Type

state'idle' | 'active' | 'finished' | 'error'

State

exportFormat'xlsx' | 'csv' | 'json' nullable

Export format

createdDatestring date-time

Creation date

endDatestring date-time nullable

End date

countinteger

Count

processedCountinteger

Processed count

percentnumber float

Percent

errorstring nullable

Error

namestring nullable

Name

qualityReportJsonstring nullable

::API.Modules.Imports.ImportExportSession.QualityReportJson::

addedCountinteger

Added count

updatedCountinteger

Updated count

skippedCountinteger

Skipped count

isCanceledboolean

Canceled

filterstring nullable

Filter

fieldsstring nullable

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the response body for the full list of fields.

adminIdstring required

Admin ID

fileIdstring nullable

File ID

chatChannelIdstring nullable

Chat channel ID

hasChatChannelIdboolean

Has chat channel ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sessionIdstring required

::API.Modules.Imports.ImportExportSessionEntityLink.SessionId::

studentIdstring nullable

::API.Modules.Imports.ImportExportSessionEntityLink.StudentId::

chatUserIdstring nullable

::API.Modules.Imports.ImportExportSessionEntityLink.ChatUserId::

actionType'none' | 'created' | 'updated'

::API.Modules.Imports.ImportExportSessionEntityLink.ActionType::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

keyNamestring nullable

Key name

additionalDatastring nullable

Additional data

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

positioninteger

Position

limitedAccessboolean

Limited access

hideInViewboolean

Hide from the contact card

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String

valueNumericnumber double nullable

Number

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time

valueDatestring date-time nullable

Date

valueListstring nullable

List

valueMultiListstring nullable

Multi-select list

additionalDatastring nullable

Additional data

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

leadIdstring required

Contact ID

leadAttributeIdstring required

Attribute ID

hasValueListboolean

Contains a list of values

hasValueMultiListboolean

Contains a multi-select list of values

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

isDraftboolean

Whether the conversation is a draft

memberCountinteger

Number of members

externalIdstring nullable

External ID

creatorUnsubscribedboolean

Creator unsubscribed

creatorUnsubscribedReasonstring nullable

Reason the creator unsubscribed

createdDatestring date-time

Creation date

lastActivityDatestring date-time nullable

Last activity date

creatorLastActivityDatestring date-time nullable

Date of the creator's last activity

type'support' | 'normal' | 'group'

Type

state'new' | 'opened' | 'closed' | 'aiAssistant'

State

creatorUserIdstring nullable

ID of the user who created the conversation

creatorMemberIdstring nullable

ID of the member who created the conversation

channelIdstring nullable

ID of the channel

lastMessageFromMemberIdstring nullable

ID of the member who sent the last message

currentStudentScenarioIdstring nullable

ID of the contact's current automation run

aiAssistantIdstring nullable

::API.Modules.Chats.ChatConversation.AiAssistantId::

lastMessageIdstring nullable

ID of the last message

lastMessageTextstring nullable

Last message text

lastMessageIndexinteger

Last message index

lastDeliveredMessageIndexinteger

Last delivered message index

aiAssistantState'thinking' | 'callHuman' | 'spam' nullable

::API.Modules.Chats.ChatConversation.AiAssistantState::

aiAssistantSpamBlockUntilDatestring date-time nullable

::API.Modules.Chats.ChatConversation.AiAssistantSpamBlockUntilDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Whether the member is active

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncedDatestring date-time nullable

Last sync date

lastSeenMessageIndexinteger nullable

Last seen message index

conversationIdstring nullable

ID of the conversation

userIdstring nullable

ID of the user

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

emailstring nullable

Email

firstNamestring nullable

First name

lastNamestring nullable

Last name

userNamestring nullable

Username

phonestring nullable

Phone

externalIdstring nullable

External ID

metadatastring nullable

Metadata

isSystemboolean

Whether the user is a system user

createdDatestring date-time nullable

Creation date

syncDatestring date-time nullable

Last sync date

lastSeenDatestring date-time nullable

Last seen date

channelType'accel' | 'vk' | 'tg' | 'vb' | 'fb' | 'wazzup24' | 'wa' | 'ig' | 'line' | 'smsc' | 'twilio' | 'ringCentral' | 'axlPhone' | 'site'

Channel type

adminIdstring nullable

ID of the admin

studentIdstring nullable

Contact ID

callUserIdstring nullable

ID of the telephony user

aiAssistantIdstring nullable

::API.Modules.Chats.ChatUser.AiAssistantId::

avatarJsonstring nullable

Avatar as JSON

type'guest' | 'student' | 'admin' | 'school' | 'aiAssistant'

Type

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

settingsJsonstring nullable

Channel settings as JSON

webhookIdstring nullable

Webhook ID

externalIdstring nullable

External ID

privateIdstring nullable

::API.Modules.Chats.ChatChannel.PrivateId::

type'accel' | 'vk' | 'tg' | 'vb' | 'fb' | 'wazzup24' | 'wa' | 'ig' | 'line' | 'smsc' | 'twilio' | 'ringCentral' | 'axlPhone' | 'site'

Type

userCountinteger

Number of users

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

broadcastDisabledboolean

Broadcasts disabled

disabledboolean

Disabled

disabledReasonstring nullable

Reason the channel was disabled

numberinteger

Number

colorstring nullable

Color

defaultChatBotIdstring nullable

ID of the default chatbot

oAuthTokenIdstring nullable

::API.Modules.Chats.ChatChannel.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

type'simple' | 'webinar'

Type

numberinteger

Number

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phrasestring required

Phrase

executionTimesinteger

Number of times the phrase was triggered

createdDatestring date-time

Creation date

chatBotIdstring required

ID of the chatbot

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

namestring required

Name

externalIdstring required

External ID

languagestring nullable

Language

sourceJsonstring nullable

Source JSON

targetJsonstring nullable

Target JSON

errorstring nullable

Error

status'approved' | 'inAppeal' | 'pending' | 'rejected' | 'pendingDeletion' | 'deleted' | 'disabled' | 'paused' | 'limitExceeded' | 'flagged' | 'unflagged' | 'reinstated' | 'deferred' | 'unknown'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

channelIdstring required

ID of the channel

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

canStudentCreateTopicsboolean

Whether users can create topics

isPublishedboolean

Whether the thread is published

isLimitedAccessboolean

Whether access is limited

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

Last activity date

topicCountinteger

Topic count

commentCountinteger

Comment count

parentThreadIdstring nullable

Parent thread ID

parentThreadAccelModelProjectModulesForumForumThread circular
updatedByAdminIdstring nullable

ID of the admin who last updated the thread

childrenAccelModelProjectModulesForumForumThread[] circular
designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring required

Thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring required

Thread ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

Last activity date

commentCountinteger

Comment count

likeCountinteger

Like count

dislikeCountinteger

Dislike count

threadIdstring required

Thread ID

studentIdstring required

Contact ID

lastCommentIdstring nullable

Last comment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sequenceNumberinteger

Sequence number

likeCountinteger

Like count

dislikeCountinteger

Dislike count

replyToCommentIdstring nullable

ID of the comment being replied to

replyToCommentAccelModelProjectModulesForumForumTopicComment circular
topicIdstring required

Topic ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'like' | 'dislike'

Type

studentIdstring required

Contact ID

topicIdstring nullable

Topic ID

commentIdstring nullable

Comment ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

threadIdstring nullable

Thread ID

topicIdstring nullable

Topic ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

reasonstring nullable

Reason

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

commentIdstring nullable

Comment ID

topicIdstring nullable

Topic ID

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.Name::

filterJsonstring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.FilterJson::

type'personal' | 'global'

::API.Modules.ExtendedFilters.ExtendedFilter.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring nullable

::API.Modules.ExtendedFilters.ExtendedFilter.AdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'voximplant' | 'zadarma' | 'onlinePbx' | 'novofon' | 'mangoOffice' | 'ringCentral' | 'kcell' | 'twilio' | 'retell' | 'axlTelephony'

Type

settingsJsonstring nullable

Settings as JSON

externalIdstring nullable

External ID

saveCallRecordsboolean

Save call recordings

transcribeCallsboolean

::API.Modules.Calls.SchoolCallAccount.TranscribeCalls::

analyzeCallsboolean

::API.Modules.Calls.SchoolCallAccount.AnalyzeCalls::

activeboolean

Active

identifierinteger

Identifier

namestring nullable

Name

emailstring nullable

Email

apiKeystring nullable

API key

passwordstring nullable

Password

sessionIdstring nullable

Session ID

parentIdstring nullable

ID of the parent account

parentAccelModelProjectModulesCallsSchoolCallAccount circular
currentCallApplicationIdstring nullable

ID of the current call application

callSubUserIdstring nullable

ID of the call account sub-user

oAuthTokenIdstring nullable

::API.Modules.Calls.SchoolCallAccount.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

namestring nullable

Name

secureRecordStorageboolean

Secure recording storage

callAccountIdstring nullable

ID of the call account

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'voximplant' | 'zadarma' | 'onlinePbx' | 'novofon' | 'mangoOffice' | 'ringCentral' | 'kcell' | 'twilio' | 'retell' | 'axlTelephony'

Type

settingsJsonstring nullable

Settings in JSON format

externalIdstring nullable

External ID

numberstring nullable

Number

activeboolean

Active

namestring nullable

Name

displayNamestring nullable

Display name

passwordstring nullable

Password

identifierinteger

Identifier

schoolCallAccountIdstring nullable

Telephony account ID

callApplicationIdstring nullable

Call application ID

chatUserIdstring nullable

Chat user ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

isIncomingboolean

Incoming call

durationInSecnumber double

Duration in seconds

orderPaymentAmountnumber double

Order payment amount

providerCallCostnumber double

Provider call cost

platformCallCostnumber double

Platform call cost

providerRecordCostnumber double

Provider recording cost

platformRecordCostnumber double

Platform recording cost

providerResourseCostnumber double

Provider resource cost

platformResourseCostnumber double

Platform resource cost

totalProviderCostnumber double

Total provider cost

totalPlatformCostnumber double

Total platform cost

costBreakdownstring nullable

::API.Modules.Calls.SchoolCallSession.CostBreakdown::

providerSessionIdstring nullable

::API.Modules.Calls.SchoolCallSession.ProviderSessionId::

costReconciledDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.CostReconciledDate::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

descriptionstring nullable

Description

startDatestring date-time nullable

Start date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

Completion date

state'inProgress' | 'completed' | 'failed' | 'waitingForCompletion' | 'answered' | 'rejected' | 'canceled' | 'busy' | 'timeExpired' | 'disabled' | 'unprocessedType' | 'voicemail' | 'notAvailable' | 'notAllowed' | 'missed'

State

analysisState'none' | 'skipped' | 'pending' | 'completed' | 'failed'

::API.Modules.Calls.SchoolCallSession.AnalysisState::

source'unknown' | 'inbound' | 'softphone' | 'scenario' | 'manual' | 'batch' | 'campaign' | 'assistant'

::API.Modules.Calls.SchoolCallSession.Source::

sourceScenarioIdstring nullable

::API.Modules.Calls.SchoolCallSession.SourceScenarioId::

transcriptstring nullable

::API.Modules.Calls.SchoolCallSession.Transcript::

summarystring nullable

::API.Modules.Calls.SchoolCallSession.Summary::

aiInterest'low' | 'medium' | 'high' nullable

::API.Modules.Calls.SchoolCallSession.AiInterest::

aiObjection'none' | 'price' | 'time' | 'notAFit' | 'trust' | 'other' nullable

::API.Modules.Calls.SchoolCallSession.AiObjection::

aiAgreedstring nullable

::API.Modules.Calls.SchoolCallSession.AiAgreed::

aiCallbackTextstring nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackText::

aiCallbackLocalstring nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackLocal::

aiCallbackDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.AiCallbackDate::

analysisErrorstring nullable

::API.Modules.Calls.SchoolCallSession.AnalysisError::

analyzedDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.AnalyzedDate::

aiPriceTokensnumber double

::API.Modules.Calls.SchoolCallSession.AiPriceTokens::

aiCostUsdnumber double

::API.Modules.Calls.SchoolCallSession.AiCostUsd::

hangupCause'unallocatedNumber' | 'noRouteTransitNet' | 'noRouteDestination' | 'channelUnacceptable' | 'normalClearing' | 'userBusy' | 'noUserResponse' | 'noAnswer' | 'subscriberAbsent' | 'callRejected' | 'numberChanged' | 'redirectionToNewDestination' | 'exchangeRoutingError' | 'destinationOutOfOrder' | 'invalidNumberFormat' | 'facilityRejected' | 'normalUnspecified' | 'normalCircuitCongestion' | 'networkOutOfOrder' | 'normalTemporaryFailure' | 'switchCongestion' | 'accessInfoDiscarded' | 'requestedChanUnAvail' | 'facilityNotSubscribed' | 'outgoingCallBarred' | 'incomingCallBarred' | 'serviceUnavailable' | 'bearerCapabilityNotImpl' | 'chanNotImplemented' | 'facilityNotImplemented' | 'serviceNotImplemented' | 'invalidCallReference' | 'incompatibleDestination' | 'invalidMsgUnspecified' | 'mandatoryIeMissing' | 'messageTypeNonExist' | 'wrongMessage' | 'ieNonExist' | 'invalidIeContents' | 'wrongCallState' | 'recoveryOnTimerExpire' | 'mandatoryIeLengthError' | 'protocolError' | 'interWorking' | 'originatorCancel' | 'crash' | 'systemShutdown' | 'loseRace' | 'managerRequest' | 'blindTransfer' | 'attendedTransfer' | 'allottedTimeout' | 'userChallenge' | 'mediaTimeout' | 'pickedOff' | 'userNotRegistered' | 'progressTimeout' | 'gatewayDown' | 'invalidGateway' | 'pickup' | 'supervising' | 'takeOver' | 'timeout' | 'rccTransfer' | 'callerInputRedirect' | 'callFlip' | 'parkLocation' | 'dtmfTransfer' | 'agentAnswered' | 'agentDropped' | 'rejected' | 'cancelled' | 'internalError' | 'targetBusy' | 'invalidNumber' | 'internationalDisabled' | 'destinationBlocked' | 'notEnoughFunds' | 'noSuchUser' | 'callRedirected' | 'callReplied' | 'callFinished' | 'callDropped' | 'clientCalledBack' | 'calledBack' | 'didntCallBack' | 'couldntGetThrough' nullable

Reason the call ended

missReasonstring nullable

::API.Modules.Calls.SchoolCallSession.MissReason::

outcomeIdstring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeId::

outcomeNotestring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeNote::

outcomeByAdminIdstring nullable

::API.Modules.Calls.SchoolCallSession.OutcomeByAdminId::

outcomeDatestring date-time nullable

::API.Modules.Calls.SchoolCallSession.OutcomeDate::

fromUserIdstring nullable

ID of the caller

toUserIdstring nullable

ID of the call recipient

sipRegistrationIdstring nullable

ID of the SIP registration

chatConversationIdstring nullable

ID of the chat conversation

callAccountIdstring nullable

ID of the call account

phoneNumberIdstring nullable

::API.Modules.Calls.SchoolCallSession.PhoneNumberId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

incomingboolean nullable

Incoming call

successfulboolean

Successful

durationInSecnumber double

Duration in seconds

providerCostnumber double

Provider cost

platformCostnumber double

Platform cost

startDatestring date-time nullable

Start date

providerTransactionIdinteger nullable

Provider transaction ID

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

descriptionstring nullable

Description

fromNumberstring nullable

Phone number the call was made from

toNumberstring nullable

Phone number the call was made to

identifierinteger

Identifier

fromUserIdstring nullable

ID of the caller

toUserIdstring nullable

ID of the call recipient

sipRegistrationIdstring nullable

ID of the SIP registration

sessionIdstring required

ID of the call session

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

startDatestring date-time nullable

Start date

durationInSecnumber double

Duration in seconds

providerCostnumber double

Provider cost

platformCostnumber double

Platform cost

namestring nullable

Name

urlstring nullable

URL

providerTransactionIdinteger nullable

Provider transaction ID

state'awaitingDownload' | 'downloading' | 'downloadingFailed' | 'uploading' | 'uploadingFailed' | 'deleting' | 'deletingFailed' | 'completed'

State

sessionIdstring required

ID of the call session

fileIdstring nullable

ID of the file

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Calls.SchoolCallOutcome.Name::

kind'neutral' | 'positive' | 'negative'

::API.Modules.Calls.SchoolCallOutcome.Kind::

positioninteger

::API.Modules.Calls.SchoolCallOutcome.Position::

isSeededboolean

::API.Modules.Calls.SchoolCallOutcome.IsSeeded::

suggestsFollowUpboolean

::API.Modules.Calls.SchoolCallOutcome.SuggestsFollowUp::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

identifierinteger

Identifier

externalIdstring nullable

External ID

domainstring required

Domain

loginstring required

Username

passwordstring nullable

Password

lastErrorMessagestring nullable

Last error message

providerCostnumber double

Provider cost

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

purchaseDatestring date-time nullable

Purchase date

nextSubscriptionRenewalDatestring date-time nullable

Next subscription renewal date

status'none' | 'inProgress' | 'verified' | 'diactivated' | 'error'

Status

callAccountIdstring required

ID of the call account

oAuthTokenIdstring nullable

::API.Modules.Calls.SchoolCallSIPRegistration.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sipRegistrationIdstring required

ID of the SIP registration

schoolAdminIdstring required

ID of the account admin

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

identifierinteger

Identifier

externalIdstring nullable

External ID

namestring nullable

Name

passwordstring nullable

Password

callAccountIdstring required

ID of the call account

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'retell' | 'axl'

::API.Modules.Voice.VoiceCall.Provider::

externalIdstring nullable

::API.Modules.Voice.VoiceCall.ExternalId::

agentIdstring nullable

::API.Modules.Voice.VoiceCall.AgentId::

agentNamestring nullable

::API.Modules.Voice.VoiceCall.AgentName::

fromNumberstring nullable

::API.Modules.Voice.VoiceCall.FromNumber::

toNumberstring nullable

::API.Modules.Voice.VoiceCall.ToNumber::

incomingboolean

::API.Modules.Voice.VoiceCall.Incoming::

status'unknown' | 'registered' | 'ongoing' | 'completed' | 'notAnswered' | 'busy' | 'failed' | 'voicemail'

::API.Modules.Voice.VoiceCall.Status::

disconnectionReasonstring nullable

::API.Modules.Voice.VoiceCall.DisconnectionReason::

durationInSecnumber double

::API.Modules.Voice.VoiceCall.DurationInSec::

startDatestring date-time nullable

::API.Modules.Voice.VoiceCall.StartDate::

endDatestring date-time nullable

::API.Modules.Voice.VoiceCall.EndDate::

createdDatestring date-time

Creation date

providerCostUsdnumber double

::API.Modules.Voice.VoiceCall.ProviderCostUsd::

aiPriceTokensnumber double

::API.Modules.Voice.VoiceCall.AiPriceTokens::

aiCostUsdnumber double

::API.Modules.Voice.VoiceCall.AiCostUsd::

recordingUrlstring nullable

::API.Modules.Voice.VoiceCall.RecordingUrl::

transcriptstring nullable

::API.Modules.Voice.VoiceCall.Transcript::

summarystring nullable

::API.Modules.Voice.VoiceCall.Summary::

outcomeKeystring nullable

::API.Modules.Voice.VoiceCall.OutcomeKey::

outcomeTitlestring nullable

::API.Modules.Voice.VoiceCall.OutcomeTitle::

outcomeReasonstring nullable

::API.Modules.Voice.VoiceCall.OutcomeReason::

extractedVariablesJsonstring nullable

::API.Modules.Voice.VoiceCall.ExtractedVariablesJson::

sourcestring nullable

::API.Modules.Voice.VoiceCall.Source::

requestedOutcomesJsonstring nullable

::API.Modules.Voice.VoiceCall.RequestedOutcomesJson::

requestedVariablesJsonstring nullable

::API.Modules.Voice.VoiceCall.RequestedVariablesJson::

studentIdstring nullable

::API.Modules.Voice.VoiceCall.StudentId::

scenarioNodeIdstring nullable

::API.Modules.Voice.VoiceCall.ScenarioNodeId::

studentScenarioIdstring nullable

::API.Modules.Voice.VoiceCall.StudentScenarioId::

adminIdstring nullable

::API.Modules.Voice.VoiceCall.AdminId::

instructionsstring nullable

::API.Modules.Voice.VoiceCall.Instructions::

campaignIdstring nullable

::API.Modules.Voice.VoiceCall.CampaignId::

quizIdstring nullable

::API.Modules.Voice.VoiceCall.QuizId::

quizSnapshotIdstring nullable

::API.Modules.Voice.VoiceCall.QuizSnapshotId::

quizAnswerIdstring nullable

::API.Modules.Voice.VoiceCall.QuizAnswerId::

quizFilledboolean nullable

::API.Modules.Voice.VoiceCall.QuizFilled::

orderIdstring nullable

::API.Modules.Voice.VoiceCall.OrderId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

kind'campaign' | 'single'

::API.Modules.Voice.Campaigns.VoiceCampaign.Kind::

namestring required

::API.Modules.Voice.Campaigns.VoiceCampaign.Name::

agentIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.AgentId::

scenarioIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.ScenarioId::

callNodeIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.CallNodeId::

filterJsonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FilterJson::

status'draft' | 'running' | 'paused' | 'finished' | 'cancelled' | 'scheduled'

::API.Modules.Voice.Campaigns.VoiceCampaign.Status::

concurrencyinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.Concurrency::

callWindowEnabledboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowEnabled::

callWindowFromMinutesinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowFromMinutes::

callWindowToMinutesinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.CallWindowToMinutes::

timezoneIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.TimezoneId::

createdByAdminIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.CreatedByAdminId::

assistantDialogIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.AssistantDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

scheduledStartDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.ScheduledStartDate::

startedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.StartedDate::

finishedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FinishedDate::

finishReasonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaign.FinishReason::

totalCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.TotalCount::

queuedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.QueuedCount::

runningCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.RunningCount::

doneCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.DoneCount::

answeredCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.AnsweredCount::

notAnsweredCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.NotAnsweredCount::

voicemailCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.VoicemailCount::

failedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.FailedCount::

skippedCountinteger

::API.Modules.Voice.Campaigns.VoiceCampaign.SkippedCount::

isActiveboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.IsActive::

isOverboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.IsOver::

hasFilterboolean

::API.Modules.Voice.Campaigns.VoiceCampaign.HasFilter::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

campaignIdstring required

::API.Modules.Voice.Campaigns.VoiceCampaignContact.CampaignId::

studentIdstring required

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StudentId::

phoneE164string nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.PhoneE164::

recipientTimezonesstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.RecipientTimezones::

status'queued' | 'running' | 'done' | 'skipped'

::API.Modules.Voice.Campaigns.VoiceCampaignContact.Status::

skipReasonstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.SkipReason::

studentScenarioIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StudentScenarioId::

attemptsinteger

::API.Modules.Voice.Campaigns.VoiceCampaignContact.Attempts::

lastCallIdstring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.LastCallId::

lastCallStatus'unknown' | 'registered' | 'ongoing' | 'completed' | 'notAnswered' | 'busy' | 'failed' | 'voicemail' nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.LastCallStatus::

outcomeKeystring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.OutcomeKey::

outcomeTitlestring nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.OutcomeTitle::

createdDatestring date-time

Creation date

startedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.StartedDate::

finishedDatestring date-time nullable

::API.Modules.Voice.Campaigns.VoiceCampaignContact.FinishedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolTelephonyAccount.ProviderType::

subAccountSidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SubAccountSid::

authTokenstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.AuthToken::

isAuthTokenEncryptedboolean

::API.Modules.Telephony.SchoolTelephonyAccount.IsAuthTokenEncrypted::

softphoneApiKeySidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneApiKeySid::

softphoneApiKeySecretstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneApiKeySecret::

isSoftphoneApiKeySecretEncryptedboolean

::API.Modules.Telephony.SchoolTelephonyAccount.IsSoftphoneApiKeySecretEncrypted::

softphoneAppSidstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SoftphoneAppSid::

status'notConnected' | 'active' | 'suspended' | 'closed'

::API.Modules.Telephony.SchoolTelephonyAccount.Status::

statusReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.StatusReason::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

connectedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.ConnectedDate::

suspendedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.SuspendedDate::

closedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyAccount.ClosedDate::

callAccountIdstring nullable

::API.Modules.Telephony.SchoolTelephonyAccount.CallAccountId::

hasSoftphoneboolean

::API.Modules.Telephony.SchoolTelephonyAccount.HasSoftphone::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

telephonyAccountIdstring required

::API.Modules.Telephony.SchoolPhoneNumber.TelephonyAccountId::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolPhoneNumber.ProviderType::

providerSidstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderSid::

phoneE164string required

::API.Modules.Telephony.SchoolPhoneNumber.PhoneE164::

friendlyNamestring nullable

::API.Modules.Telephony.SchoolPhoneNumber.FriendlyName::

countrystring nullable

::API.Modules.Telephony.SchoolPhoneNumber.Country::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.SchoolPhoneNumber.Kind::

capabilities'none' | 'voice' | 'sms' | 'mms'

::API.Modules.Telephony.SchoolPhoneNumber.Capabilities::

voiceEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.VoiceEnabled::

smsEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.SmsEnabled::

mmsEnabledboolean

::API.Modules.Telephony.SchoolPhoneNumber.MmsEnabled::

recordCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.RecordCalls::

transcribeCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.TranscribeCalls::

analyzeCallsboolean

::API.Modules.Telephony.SchoolPhoneNumber.AnalyzeCalls::

announceRecordingboolean

::API.Modules.Telephony.SchoolPhoneNumber.AnnounceRecording::

recordingNoticeMode'everyone' | 'requiredStatesOnly' | 'never'

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeMode::

recordingNoticeAcceptedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeAcceptedDate::

recordingNoticeAcceptedByAdminIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RecordingNoticeAcceptedByAdminId::

outboundCountryMode'all' | 'allowList' | 'denyList'

::API.Modules.Telephony.SchoolPhoneNumber.OutboundCountryMode::

outboundCountriesstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.OutboundCountries::

useForCheaperOutboundboolean

::API.Modules.Telephony.SchoolPhoneNumber.UseForCheaperOutbound::

inboundRouteType'none' | 'softphone' | 'forwardExternal' | 'voicemail' | 'scenario' | 'aiAgent'

::API.Modules.Telephony.SchoolPhoneNumber.InboundRouteType::

inboundRouteTargetstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundRouteTarget::

inboundAgentIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentId::

inboundRingSecondsinteger nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundRingSeconds::

inboundVoicemailOnMissboolean

::API.Modules.Telephony.SchoolPhoneNumber.InboundVoicemailOnMiss::

inboundAgentFallback'none' | 'team' | 'admins'

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentFallback::

inboundAgentFallbackAdminIdsstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.InboundAgentFallbackAdminIds::

chatChannelIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ChatChannelId::

complianceIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ComplianceId::

status'active' | 'restricted' | 'pendingRelease' | 'released' | 'pendingActivation'

::API.Modules.Telephony.SchoolPhoneNumber.Status::

providerMonthlyCostUsdnumber double

::API.Modules.Telephony.SchoolPhoneNumber.ProviderMonthlyCostUsd::

monthlyPriceUsdnumber double

::API.Modules.Telephony.SchoolPhoneNumber.MonthlyPriceUsd::

purchasedDatestring date-time

::API.Modules.Telephony.SchoolPhoneNumber.PurchasedDate::

nextChargeDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.NextChargeDate::

lastChargedPeriodstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.LastChargedPeriod::

scheduledReleaseDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ScheduledReleaseDate::

releasedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ReleasedDate::

updatedDatestring date-time nullable

Date the record was last updated.

providerOrderIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderOrderId::

providerSubOrderIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.ProviderSubOrderId::

regulatoryProfileIdstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryProfileId::

regulatoryStatusstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryStatus::

regulatoryRejectionstring nullable

::API.Modules.Telephony.SchoolPhoneNumber.RegulatoryRejection::

activatedDatestring date-time nullable

::API.Modules.Telephony.SchoolPhoneNumber.ActivatedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneNumberIdstring required

::API.Modules.Telephony.SchoolPhoneNumberAdmin.PhoneNumberId::

adminIdstring required

::API.Modules.Telephony.SchoolPhoneNumberAdmin.AdminId::

canCallboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.CanCall::

canSendSmsboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.CanSendSms::

isPrimaryboolean

::API.Modules.Telephony.SchoolPhoneNumberAdmin.IsPrimary::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

telephonyAccountIdstring required

::API.Modules.Telephony.SchoolTelephonyCompliance.TelephonyAccountId::

kind'smsBrandCampaign' | 'regulatoryBundle' | 'internationalSms'

::API.Modules.Telephony.SchoolTelephonyCompliance.Kind::

status'none' | 'draft' | 'submitted' | 'approved' | 'rejected' | 'cancelled'

::API.Modules.Telephony.SchoolTelephonyCompliance.Status::

providerBrandSidstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ProviderBrandSid::

providerCampaignSidstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ProviderCampaignSid::

applicationJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.ApplicationJson::

aiFilledFieldsJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.AiFilledFieldsJson::

rejectionReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.RejectionReason::

submissionFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.SubmissionFeeUsd::

monthlyFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.MonthlyFeeUsd::

feeChargedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.FeeChargedDate::

vettingRequestedboolean

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingRequested::

vettingFeeUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingFeeUsd::

vettingStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingStatus::

vettingScoreinteger nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingScore::

vettingOrderedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.VettingOrderedDate::

nextChargeDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.NextChargeDate::

lastChargedPeriodstring nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.LastChargedPeriod::

createdDatestring date-time

Creation date

submittedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.SubmittedDate::

decisionDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.DecisionDate::

cancelledDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyCompliance.CancelledDate::

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

countrystring required

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Country::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Kind::

status'draft' | 'submitted' | 'approved' | 'declined'

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.Status::

valuesJsonstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ValuesJson::

providerGroupIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ProviderGroupId::

providerGroupStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ProviderGroupStatus::

declineReasonstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.DeclineReason::

confirmedByAdminIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ConfirmedByAdminId::

confirmedDatestring date-time nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryProfile.ConfirmedDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

profileIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProfileId::

requirementIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.RequirementId::

fileIdstring required

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.FileId::

fileNamestring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.FileName::

contentTypestring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ContentType::

sizeinteger

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.Size::

sha256string nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.Sha256::

providerDocumentIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProviderDocumentId::

providerStatusstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.ProviderStatus::

uploadedByAdminIdstring nullable

::API.Modules.Telephony.SchoolTelephonyRegulatoryDocument.UploadedByAdminId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

chargeType'outboundCallMinutes' | 'inboundCallMinutes' | 'outboundSmsSegments' | 'inboundSmsSegments' | 'numberMonthlyRent' | 'numberPurchase' | 'complianceApplication' | 'complianceMonthlyFee' | 'callRecording' | 'brandVetting' | 'campaignUpfront' | 'callWebRtcMinutes' | 'callControlMinutes' | 'callMediaMinutes'

::API.Modules.Telephony.SchoolTelephonyCharge.ChargeType::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderType::

quantitynumber double

::API.Modules.Telephony.SchoolTelephonyCharge.Quantity::

providerCostUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderCostUsd::

priceUsdnumber double

::API.Modules.Telephony.SchoolTelephonyCharge.PriceUsd::

occurredDatestring date-time

::API.Modules.Telephony.SchoolTelephonyCharge.OccurredDate::

periodstring required

::API.Modules.Telephony.SchoolTelephonyCharge.Period::

phoneNumberIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.PhoneNumberId::

sourceEntityIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.SourceEntityId::

providerReferencestring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.ProviderReference::

idempotencyKeystring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.IdempotencyKey::

invoiceIdstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.InvoiceId::

descriptionstring nullable

::API.Modules.Telephony.SchoolTelephonyCharge.Description::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

phoneE164string required

::API.Modules.Telephony.PlatformPhoneNumber.PhoneE164::

providerType'twilio' | 'telnyx'

::API.Modules.Telephony.PlatformPhoneNumber.ProviderType::

providerSidstring nullable

::API.Modules.Telephony.PlatformPhoneNumber.ProviderSid::

kind'local' | 'mobile' | 'tollFree'

::API.Modules.Telephony.PlatformPhoneNumber.Kind::

purpose'none' | 'assistant' | 'opsAlerts'

::API.Modules.Telephony.PlatformPhoneNumber.Purpose::

messagingProfileIdstring nullable

::API.Modules.Telephony.PlatformPhoneNumber.MessagingProfileId::

notestring nullable

::API.Modules.Telephony.PlatformPhoneNumber.Note::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Domains.AccountDomain.Name::

unicodeNamestring nullable

::API.Modules.Domains.AccountDomain.UnicodeName::

tldstring nullable

::API.Modules.Domains.AccountDomain.Tld::

origin'purchased' | 'transferredIn' | 'connected'

::API.Modules.Domains.AccountDomain.Origin::

status'pending' | 'active' | 'failed' | 'transferPending' | 'expired' | 'redemption' | 'transferredOut' | 'released' | 'awaitingVerification' | 'awaitingDelegation'

::API.Modules.Domains.AccountDomain.Status::

dnsMode'axl' | 'custom' | 'external'

::API.Modules.Domains.AccountDomain.DnsMode::

zoneIdstring nullable

::API.Modules.Domains.AccountDomain.ZoneId::

zoneStatus'none' | 'active' | 'deleting' | 'deleted' | 'error'

::API.Modules.Domains.AccountDomain.ZoneStatus::

zoneDeleteAfterstring date-time nullable

::API.Modules.Domains.AccountDomain.ZoneDeleteAfter::

nameServersJsonstring nullable

::API.Modules.Domains.AccountDomain.NameServersJson::

delegationVerifiedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.DelegationVerifiedDate::

dnsMoveJsonstring nullable

::API.Modules.Domains.AccountDomain.DnsMoveJson::

delegationCheckedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.DelegationCheckedDate::

ownershipTokenstring nullable

::API.Modules.Domains.AccountDomain.OwnershipToken::

ownershipVerifiedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.OwnershipVerifiedDate::

registrar'none' | 'nameCom'

::API.Modules.Domains.AccountDomain.Registrar::

registeredDatestring date-time nullable

::API.Modules.Domains.AccountDomain.RegisteredDate::

expiresDatestring date-time nullable

::API.Modules.Domains.AccountDomain.ExpiresDate::

autoRenewboolean

::API.Modules.Domains.AccountDomain.AutoRenew::

privacyEnabledboolean

::API.Modules.Domains.AccountDomain.PrivacyEnabled::

transferLockedboolean

::API.Modules.Domains.AccountDomain.TransferLocked::

transferLockUntilstring date-time nullable

::API.Modules.Domains.AccountDomain.TransferLockUntil::

contactVerification'unknown' | 'pending' | 'verified' | 'suspended'

::API.Modules.Domains.AccountDomain.ContactVerification::

renewalPriceUsdnumber double nullable

::API.Modules.Domains.AccountDomain.RenewalPriceUsd::

renewalCostUsdnumber double nullable

::API.Modules.Domains.AccountDomain.RenewalCostUsd::

registrarSyncedDatestring date-time nullable

::API.Modules.Domains.AccountDomain.RegistrarSyncedDate::

freeFirstYearboolean

::API.Modules.Domains.AccountDomain.FreeFirstYear::

contactIdstring nullable

::API.Modules.Domains.AccountDomain.ContactId::

dnsMonthlyPriceUsdnumber double

::API.Modules.Domains.AccountDomain.DnsMonthlyPriceUsd::

nextDnsChargeDatestring date-time nullable

::API.Modules.Domains.AccountDomain.NextDnsChargeDate::

expiryNoticeStageinteger

::API.Modules.Domains.AccountDomain.ExpiryNoticeStage::

provisioningJsonstring nullable

::API.Modules.Domains.AccountDomain.ProvisioningJson::

provisioningStep'none' | 'charged' | 'zoneCreated' | 'registered' | 'recordsApplied' | 'usagesAttached' | 'completed'

::API.Modules.Domains.AccountDomain.ProvisioningStep::

lastErrorstring nullable

::API.Modules.Domains.AccountDomain.LastError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring nullable

::API.Modules.Domains.AccountDomain.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainIdstring required

::API.Modules.Domains.DomainDnsRecord.DomainId::

namestring required

::API.Modules.Domains.DomainDnsRecord.Name::

type'a' | 'aaaa' | 'cname' | 'mx' | 'txt' | 'srv' | 'caa' | 'ns' | 'alias'

::API.Modules.Domains.DomainDnsRecord.Type::

valuestring required

::API.Modules.Domains.DomainDnsRecord.Value::

priorityinteger nullable

::API.Modules.Domains.DomainDnsRecord.Priority::

weightinteger nullable

::API.Modules.Domains.DomainDnsRecord.Weight::

portinteger nullable

::API.Modules.Domains.DomainDnsRecord.Port::

ttlinteger

::API.Modules.Domains.DomainDnsRecord.Ttl::

source'user' | 'system' | 'imported'

::API.Modules.Domains.DomainDnsRecord.Source::

purpose'none' | 'site' | 'siteWww' | 'lms' | 'siteHost' | 'emailSpf' | 'emailDkim' | 'emailDmarc' | 'emailBounces' | 'emailTracking' | 'emailMx' | 'verification'

::API.Modules.Domains.DomainDnsRecord.Purpose::

syncStatus'pending' | 'synced' | 'error'

::API.Modules.Domains.DomainDnsRecord.SyncStatus::

syncErrorstring nullable

::API.Modules.Domains.DomainDnsRecord.SyncError::

commentstring nullable

::API.Modules.Domains.DomainDnsRecord.Comment::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

updatedByAdminIdstring nullable

::API.Modules.Domains.DomainDnsRecord.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

firstNamestring nullable

::API.Modules.Domains.DomainContact.FirstName::

lastNamestring nullable

::API.Modules.Domains.DomainContact.LastName::

companyNamestring nullable

::API.Modules.Domains.DomainContact.CompanyName::

emailstring nullable

::API.Modules.Domains.DomainContact.Email::

phonestring nullable

::API.Modules.Domains.DomainContact.Phone::

address1string nullable

::API.Modules.Domains.DomainContact.Address1::

address2string nullable

::API.Modules.Domains.DomainContact.Address2::

citystring nullable

::API.Modules.Domains.DomainContact.City::

statestring nullable

::API.Modules.Domains.DomainContact.State::

zipstring nullable

::API.Modules.Domains.DomainContact.Zip::

countrystring nullable

::API.Modules.Domains.DomainContact.Country::

isDefaultboolean

::API.Modules.Domains.DomainContact.IsDefault::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainIdstring required

::API.Modules.Domains.DomainOperation.DomainId::

type'register' | 'renew' | 'transferIn' | 'restore' | 'dnsHosting' | 'setNameservers' | 'lock' | 'unlock' | 'privacyOn' | 'privacyOff' | 'autoRenewOn' | 'autoRenewOff' | 'contactUpdated' | 'authCodeIssued' | 'glueChanged' | 'verificationEmailResent' | 'zoneCreated' | 'zoneDeleted' | 'recordsChanged' | 'recordsImported' | 'attached' | 'detached' | 'ownershipVerified' | 'delegated' | 'transferredOut' | 'movedToAccount' | 'error'

::API.Modules.Domains.DomainOperation.Type::

status'pending' | 'succeeded' | 'failed' | 'cancelled'

::API.Modules.Domains.DomainOperation.Status::

priceUsdnumber double

::API.Modules.Domains.DomainOperation.PriceUsd::

providerCostUsdnumber double

::API.Modules.Domains.DomainOperation.ProviderCostUsd::

yearsinteger nullable

::API.Modules.Domains.DomainOperation.Years::

billingTransactionIdstring nullable

::API.Modules.Domains.DomainOperation.BillingTransactionId::

providerOrderIdstring nullable

::API.Modules.Domains.DomainOperation.ProviderOrderId::

idempotencyKeystring nullable

::API.Modules.Domains.DomainOperation.IdempotencyKey::

periodstring nullable

::API.Modules.Domains.DomainOperation.Period::

detailsJsonstring nullable

::API.Modules.Domains.DomainOperation.DetailsJson::

errorstring nullable

::API.Modules.Domains.DomainOperation.Error::

adminIdstring nullable

::API.Modules.Domains.DomainOperation.AdminId::

createdDatestring date-time

Creation date

completedDatestring date-time nullable

::API.Modules.Domains.DomainOperation.CompletedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

domainNamestring required

::API.Modules.Domains.DomainAgreementAcceptance.DomainName::

domainIdstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.DomainId::

kind'register' | 'transferIn'

::API.Modules.Domains.DomainAgreementAcceptance.Kind::

adminIdstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AdminId::

adminEmailstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AdminEmail::

ipstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.Ip::

agreementVersionstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.AgreementVersion::

documentsJsonstring nullable

::API.Modules.Domains.DomainAgreementAcceptance.DocumentsJson::

yearsinteger

::API.Modules.Domains.DomainAgreementAcceptance.Years::

acceptedDatestring date-time

::API.Modules.Domains.DomainAgreementAcceptance.AcceptedDate::

retainUntilDatestring date-time nullable

::API.Modules.Domains.DomainAgreementAcceptance.RetainUntilDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

registrar'none' | 'nameCom'

::API.Modules.Domains.DomainRegistrarEvent.Registrar::

eventNamestring required

::API.Modules.Domains.DomainRegistrarEvent.EventName::

domainNamestring nullable

::API.Modules.Domains.DomainRegistrarEvent.DomainName::

domainIdstring nullable

::API.Modules.Domains.DomainRegistrarEvent.DomainId::

fingerprintstring required

::API.Modules.Domains.DomainRegistrarEvent.Fingerprint::

payloadJsonstring nullable

::API.Modules.Domains.DomainRegistrarEvent.PayloadJson::

status'pending' | 'applied' | 'ignored' | 'failed'

::API.Modules.Domains.DomainRegistrarEvent.Status::

attemptsinteger

::API.Modules.Domains.DomainRegistrarEvent.Attempts::

errorstring nullable

::API.Modules.Domains.DomainRegistrarEvent.Error::

receivedDatestring date-time

::API.Modules.Domains.DomainRegistrarEvent.ReceivedDate::

processedDatestring date-time nullable

::API.Modules.Domains.DomainRegistrarEvent.ProcessedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialConnection.Provider::

mode'direct' | 'viaFacebookPage'

::API.Modules.Social.SocialConnection.Mode::

providerAccountIdstring required

::API.Modules.Social.SocialConnection.ProviderAccountId::

accountNamestring nullable

::API.Modules.Social.SocialConnection.AccountName::

usernamestring nullable

::API.Modules.Social.SocialConnection.Username::

avatarUrlstring nullable

::API.Modules.Social.SocialConnection.AvatarUrl::

profileUrlstring nullable

::API.Modules.Social.SocialConnection.ProfileUrl::

parentAccountIdstring nullable

::API.Modules.Social.SocialConnection.ParentAccountId::

oAuthTokenIdstring nullable

::API.Modules.Social.SocialConnection.OAuthTokenId::

chatChannelIdstring nullable

::API.Modules.Social.SocialConnection.ChatChannelId::

permissionsJsonstring nullable

::API.Modules.Social.SocialConnection.PermissionsJson::

metadataJsonstring nullable

::API.Modules.Social.SocialConnection.MetadataJson::

status'active' | 'reauthRequired' | 'disabled' | 'error'

::API.Modules.Social.SocialConnection.Status::

followersCountinteger nullable

::API.Modules.Social.SocialConnection.FollowersCount::

mediaCountinteger nullable

::API.Modules.Social.SocialConnection.MediaCount::

lastSyncDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastSyncDate::

lastMetricsDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastMetricsDate::

lastCheckDatestring date-time nullable

::API.Modules.Social.SocialConnection.LastCheckDate::

lastErrorstring nullable

::API.Modules.Social.SocialConnection.LastError::

createdByAdminIdstring nullable

::API.Modules.Social.SocialConnection.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Social.SocialPost.Title::

textstring nullable

::API.Modules.Social.SocialPost.Text::

linkUrlstring nullable

::API.Modules.Social.SocialPost.LinkUrl::

mediaJsonstring nullable

::API.Modules.Social.SocialPost.MediaJson::

firstCommentEnabledboolean

::API.Modules.Social.SocialPost.FirstCommentEnabled::

firstCommentTextstring nullable

::API.Modules.Social.SocialPost.FirstCommentText::

status'draft' | 'scheduled' | 'publishing' | 'published' | 'partiallyPublished' | 'failed'

::API.Modules.Social.SocialPost.Status::

source'manual' | 'imported' | 'ai' | 'api'

::API.Modules.Social.SocialPost.Source::

scheduledDatestring date-time nullable

::API.Modules.Social.SocialPost.ScheduledDate::

publishedDatestring date-time nullable

::API.Modules.Social.SocialPost.PublishedDate::

metricsSummaryJsonstring nullable

::API.Modules.Social.SocialPost.MetricsSummaryJson::

aiDialogIdstring nullable

::API.Modules.Social.SocialPost.AiDialogId::

createdByAdminIdstring nullable

::API.Modules.Social.SocialPost.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

socialPostIdstring required

::API.Modules.Social.SocialPublication.SocialPostId::

socialConnectionIdstring required

::API.Modules.Social.SocialPublication.SocialConnectionId::

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialPublication.Provider::

kind'image' | 'carousel' | 'video' | 'reel' | 'text' | 'link'

::API.Modules.Social.SocialPublication.Kind::

providerPostIdstring nullable

::API.Modules.Social.SocialPublication.ProviderPostId::

permalinkstring nullable

::API.Modules.Social.SocialPublication.Permalink::

adaptedTextstring nullable

::API.Modules.Social.SocialPublication.AdaptedText::

adaptedMediaJsonstring nullable

::API.Modules.Social.SocialPublication.AdaptedMediaJson::

mediaOverrideJsonstring nullable

::API.Modules.Social.SocialPublication.MediaOverrideJson::

status'pending' | 'preparing' | 'publishing' | 'published' | 'failed' | 'skipped'

::API.Modules.Social.SocialPublication.Status::

scheduledDatestring date-time nullable

::API.Modules.Social.SocialPublication.ScheduledDate::

publishedDatestring date-time nullable

::API.Modules.Social.SocialPublication.PublishedDate::

providerContainerIdstring nullable

::API.Modules.Social.SocialPublication.ProviderContainerId::

containerStatusstring nullable

::API.Modules.Social.SocialPublication.ContainerStatus::

attemptinteger

::API.Modules.Social.SocialPublication.Attempt::

errorstring nullable

::API.Modules.Social.SocialPublication.Error::

errorCodestring nullable

::API.Modules.Social.SocialPublication.ErrorCode::

firstCommentTextstring nullable

::API.Modules.Social.SocialPublication.FirstCommentText::

firstCommentEnabledboolean nullable

::API.Modules.Social.SocialPublication.FirstCommentEnabled::

firstCommentStatus'none' | 'pending' | 'published' | 'failed' | 'skipped'

::API.Modules.Social.SocialPublication.FirstCommentStatus::

firstCommentProviderIdstring nullable

::API.Modules.Social.SocialPublication.FirstCommentProviderId::

firstCommentErrorstring nullable

::API.Modules.Social.SocialPublication.FirstCommentError::

isImportedboolean

::API.Modules.Social.SocialPublication.IsImported::

thumbnailFileIdstring nullable

::API.Modules.Social.SocialPublication.ThumbnailFileId::

metricsSummaryJsonstring nullable

::API.Modules.Social.SocialPublication.MetricsSummaryJson::

nextMetricsDatestring date-time nullable

::API.Modules.Social.SocialPublication.NextMetricsDate::

nextCommentsDatestring date-time nullable

::API.Modules.Social.SocialPublication.NextCommentsDate::

lastCommentsDatestring date-time nullable

::API.Modules.Social.SocialPublication.LastCommentsDate::

removedFromProviderDatestring date-time nullable

::API.Modules.Social.SocialPublication.RemovedFromProviderDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

socialPostIdstring required

::API.Modules.Social.SocialComment.SocialPostId::

socialPublicationIdstring required

::API.Modules.Social.SocialComment.SocialPublicationId::

socialConnectionIdstring required

::API.Modules.Social.SocialComment.SocialConnectionId::

provider'instagram' | 'facebook' | 'threads' | 'tikTok' | 'youTube' | 'linkedIn' | 'pinterest'

::API.Modules.Social.SocialComment.Provider::

providerCommentIdstring required

::API.Modules.Social.SocialComment.ProviderCommentId::

parentProviderCommentIdstring nullable

::API.Modules.Social.SocialComment.ParentProviderCommentId::

authorProviderIdstring nullable

::API.Modules.Social.SocialComment.AuthorProviderId::

authorNamestring nullable

::API.Modules.Social.SocialComment.AuthorName::

authorUsernamestring nullable

::API.Modules.Social.SocialComment.AuthorUsername::

textstring nullable

::API.Modules.Social.SocialComment.Text::

likeCountinteger nullable

::API.Modules.Social.SocialComment.LikeCount::

replyCountinteger nullable

::API.Modules.Social.SocialComment.ReplyCount::

isOwnboolean

::API.Modules.Social.SocialComment.IsOwn::

isHiddenboolean

::API.Modules.Social.SocialComment.IsHidden::

publishedDatestring date-time

::API.Modules.Social.SocialComment.PublishedDate::

collectedDatestring date-time

::API.Modules.Social.SocialComment.CollectedDate::

removedFromProviderDatestring date-time nullable

::API.Modules.Social.SocialComment.RemovedFromProviderDate::

privateReplyDatestring date-time nullable

::API.Modules.Social.SocialComment.PrivateReplyDate::

privateReplyConversationIdstring nullable

::API.Modules.Social.SocialComment.PrivateReplyConversationId::

rawJsonstring nullable

::API.Modules.Social.SocialComment.RawJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'metaAds' | 'googleAds' | 'tikTokAds' | 'linkedInAds' | 'pinterestAds'

::API.Modules.Advertising.AdConnection.Provider::

providerAccountIdstring required

::API.Modules.Advertising.AdConnection.ProviderAccountId::

accountNamestring nullable

::API.Modules.Advertising.AdConnection.AccountName::

currencystring nullable

::API.Modules.Advertising.AdConnection.Currency::

timezoneNamestring nullable

::API.Modules.Advertising.AdConnection.TimezoneName::

oAuthTokenIdstring nullable

::API.Modules.Advertising.AdConnection.OAuthTokenId::

pageIdstring nullable

::API.Modules.Advertising.AdConnection.PageId::

instagramUserIdstring nullable

::API.Modules.Advertising.AdConnection.InstagramUserId::

pageNamestring nullable

::API.Modules.Advertising.AdConnection.PageName::

instagramUsernamestring nullable

::API.Modules.Advertising.AdConnection.InstagramUsername::

status'active' | 'reauthRequired' | 'disabled' | 'error'

::API.Modules.Advertising.AdConnection.Status::

providerAccountStatusinteger nullable

::API.Modules.Advertising.AdConnection.ProviderAccountStatus::

disableReasoninteger nullable

::API.Modules.Advertising.AdConnection.DisableReason::

hasFundingSourceboolean

::API.Modules.Advertising.AdConnection.HasFundingSource::

defaultUtmJsonstring nullable

::API.Modules.Advertising.AdConnection.DefaultUtmJson::

dsaPayorstring nullable

::API.Modules.Advertising.AdConnection.DsaPayor::

dsaBeneficiarystring nullable

::API.Modules.Advertising.AdConnection.DsaBeneficiary::

defaultSpecialCategory'none' | 'housing' | 'employment' | 'financialProducts' | 'issues'

::API.Modules.Advertising.AdConnection.DefaultSpecialCategory::

minBudgetsJsonstring nullable

::API.Modules.Advertising.AdConnection.MinBudgetsJson::

termsAcceptedDatestring date-time nullable

::API.Modules.Advertising.AdConnection.TermsAcceptedDate::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastSyncDate::

lastInsightsDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastInsightsDate::

lastCheckDatestring date-time nullable

::API.Modules.Advertising.AdConnection.LastCheckDate::

accessExpiryNoticeForstring date-time nullable

::API.Modules.Advertising.AdConnection.AccessExpiryNoticeFor::

accessExpiresAtstring date-time nullable

::API.Modules.Advertising.AdConnection.AccessExpiresAt::

lastErrorstring nullable

::API.Modules.Advertising.AdConnection.LastError::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdConnection.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adConnectionIdstring required

::API.Modules.Advertising.AdCampaign.AdConnectionId::

providerCampaignIdstring nullable

::API.Modules.Advertising.AdCampaign.ProviderCampaignId::

namestring required

::API.Modules.Advertising.AdCampaign.Name::

objective'leads' | 'traffic' | 'engagement' | 'awareness' | 'sales'

::API.Modules.Advertising.AdCampaign.Objective::

specialCategory'none' | 'housing' | 'employment' | 'financialProducts' | 'issues'

::API.Modules.Advertising.AdCampaign.SpecialCategory::

specialCategoryCountriesJsonstring nullable

::API.Modules.Advertising.AdCampaign.SpecialCategoryCountriesJson::

status'draft' | 'scheduled' | 'pendingReview' | 'active' | 'paused' | 'completed' | 'rejected' | 'needsAction' | 'archived'

::API.Modules.Advertising.AdCampaign.Status::

providerStatusstring nullable

::API.Modules.Advertising.AdCampaign.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.AdCampaign.ProviderEffectiveStatus::

budgetKind'daily' | 'lifetime'

::API.Modules.Advertising.AdCampaign.BudgetKind::

budgetAmountnumber double nullable

::API.Modules.Advertising.AdCampaign.BudgetAmount::

currencystring nullable

::API.Modules.Advertising.AdCampaign.Currency::

startDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.EndDate::

destinationUrlstring nullable

::API.Modules.Advertising.AdCampaign.DestinationUrl::

utmCampaignstring nullable

Identifies a specific advertising campaign

launchStage'none' | 'campaignCreated' | 'adSetCreated' | 'mediaUploaded' | 'creativeCreated' | 'adCreated' | 'done'

::API.Modules.Advertising.AdCampaign.LaunchStage::

stateVersioninteger

::API.Modules.Advertising.AdCampaign.StateVersion::

providerSettingsJsonstring nullable

::API.Modules.Advertising.AdCampaign.ProviderSettingsJson::

source'wizard' | 'ai' | 'imported' | 'boostedPost'

::API.Modules.Advertising.AdCampaign.Source::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdCampaign.CreatedByAdminId::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdCampaign.LastSyncDate::

metricsSummaryJsonstring nullable

::API.Modules.Advertising.AdCampaign.MetricsSummaryJson::

lastErrorstring nullable

::API.Modules.Advertising.AdCampaign.LastError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adCampaignIdstring required

::API.Modules.Advertising.AdGroup.AdCampaignId::

providerAdSetIdstring nullable

::API.Modules.Advertising.AdGroup.ProviderAdSetId::

namestring nullable

::API.Modules.Advertising.AdGroup.Name::

targetingJsonstring nullable

::API.Modules.Advertising.AdGroup.TargetingJson::

audienceSpecJsonstring nullable

::API.Modules.Advertising.AdGroup.AudienceSpecJson::

optimizationGoalstring nullable

::API.Modules.Advertising.AdGroup.OptimizationGoal::

billingEventstring nullable

::API.Modules.Advertising.AdGroup.BillingEvent::

promotedObjectJsonstring nullable

::API.Modules.Advertising.AdGroup.PromotedObjectJson::

budgetKind'daily' | 'lifetime'

::API.Modules.Advertising.AdGroup.BudgetKind::

budgetAmountnumber double nullable

::API.Modules.Advertising.AdGroup.BudgetAmount::

startDatestring date-time nullable

::API.Modules.Advertising.AdGroup.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdGroup.EndDate::

providerStatusstring nullable

::API.Modules.Advertising.AdGroup.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.AdGroup.ProviderEffectiveStatus::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.AdGroup.LastSyncDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adGroupIdstring required

::API.Modules.Advertising.Ad.AdGroupId::

providerAdIdstring nullable

::API.Modules.Advertising.Ad.ProviderAdId::

providerCreativeIdstring nullable

::API.Modules.Advertising.Ad.ProviderCreativeId::

namestring nullable

::API.Modules.Advertising.Ad.Name::

mediaJsonstring nullable

::API.Modules.Advertising.Ad.MediaJson::

primaryTextstring nullable

::API.Modules.Advertising.Ad.PrimaryText::

headlinestring nullable

::API.Modules.Advertising.Ad.Headline::

descriptionstring nullable

::API.Modules.Advertising.Ad.Description::

callToActionstring nullable

::API.Modules.Advertising.Ad.CallToAction::

linkUrlstring nullable

::API.Modules.Advertising.Ad.LinkUrl::

urlTagsstring nullable

::API.Modules.Advertising.Ad.UrlTags::

objectStoryIdstring nullable

::API.Modules.Advertising.Ad.ObjectStoryId::

sourceInstagramMediaIdstring nullable

::API.Modules.Advertising.Ad.SourceInstagramMediaId::

providerStatusstring nullable

::API.Modules.Advertising.Ad.ProviderStatus::

providerEffectiveStatusstring nullable

::API.Modules.Advertising.Ad.ProviderEffectiveStatus::

reviewFeedbackJsonstring nullable

::API.Modules.Advertising.Ad.ReviewFeedbackJson::

issuesJsonstring nullable

::API.Modules.Advertising.Ad.IssuesJson::

metricsSummaryJsonstring nullable

::API.Modules.Advertising.Ad.MetricsSummaryJson::

qualityRankingstring nullable

::API.Modules.Advertising.Ad.QualityRanking::

engagementRateRankingstring nullable

::API.Modules.Advertising.Ad.EngagementRateRanking::

conversionRateRankingstring nullable

::API.Modules.Advertising.Ad.ConversionRateRanking::

lastSyncDatestring date-time nullable

::API.Modules.Advertising.Ad.LastSyncDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Advertising.AdAudience.Name::

targetingJsonstring nullable

::API.Modules.Advertising.AdAudience.TargetingJson::

estimateJsonstring nullable

::API.Modules.Advertising.AdAudience.EstimateJson::

isSavedboolean

::API.Modules.Advertising.AdAudience.IsSaved::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Advertising.AdChannel.Name::

kind'manual' | 'adAccount' | 'socialPosts' | 'emailBroadcasts'

::API.Modules.Advertising.AdChannel.Kind::

orderinteger

::API.Modules.Advertising.AdChannel.Order::

adConnectionIdstring nullable

::API.Modules.Advertising.AdChannel.AdConnectionId::

autoTagEnabledboolean

::API.Modules.Advertising.AdChannel.AutoTagEnabled::

autoTagAllLinksboolean

::API.Modules.Advertising.AdChannel.AutoTagAllLinks::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdChannel.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adChannelIdstring required

::API.Modules.Advertising.AdActivity.AdChannelId::

namestring required

::API.Modules.Advertising.AdActivity.Name::

descriptionstring nullable

::API.Modules.Advertising.AdActivity.Description::

startDatestring date-time nullable

::API.Modules.Advertising.AdActivity.StartDate::

endDatestring date-time nullable

::API.Modules.Advertising.AdActivity.EndDate::

source'manual' | 'meta' | 'socialPost' | 'broadcast'

::API.Modules.Advertising.AdActivity.Source::

adCampaignIdstring nullable

::API.Modules.Advertising.AdActivity.AdCampaignId::

sourceEntityIdstring nullable

::API.Modules.Advertising.AdActivity.SourceEntityId::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdActivity.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adActivityIdstring required

::API.Modules.Advertising.AdUtmRule.AdActivityId::

adGroupIdstring nullable

::API.Modules.Advertising.AdUtmRule.AdGroupId::

adIdstring nullable

::API.Modules.Advertising.AdUtmRule.AdId::

sourcestring nullable

::API.Modules.Advertising.AdUtmRule.Source::

mediumstring nullable

::API.Modules.Advertising.AdUtmRule.Medium::

campaignstring nullable

::API.Modules.Advertising.AdUtmRule.Campaign::

contentstring nullable

::API.Modules.Advertising.AdUtmRule.Content::

termstring nullable

::API.Modules.Advertising.AdUtmRule.Term::

matchKeystring required

::API.Modules.Advertising.AdUtmRule.MatchKey::

isAutoboolean

::API.Modules.Advertising.AdUtmRule.IsAuto::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adActivityIdstring required

::API.Modules.Advertising.AdSpendEntry.AdActivityId::

amountnumber double

::API.Modules.Advertising.AdSpendEntry.Amount::

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Advertising.AdSpendEntry.Currency::

dateFromstring date-time

::API.Modules.Advertising.AdSpendEntry.DateFrom::

dateTostring date-time

::API.Modules.Advertising.AdSpendEntry.DateTo::

commentstring nullable

::API.Modules.Advertising.AdSpendEntry.Comment::

source'manual' | 'csv'

::API.Modules.Advertising.AdSpendEntry.Source::

importIdstring nullable

::API.Modules.Advertising.AdSpendEntry.ImportId::

createdByAdminIdstring nullable

::API.Modules.Advertising.AdSpendEntry.CreatedByAdminId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

Start date

endDatestring date-time

End date

completedDatestring date-time nullable

Completion date

duration'min10' | 'min15' | 'min30' | 'hour' | 'hour2' | 'day' | 'custom'

Duration

status'scheduled' | 'done' | 'undone'

Status

reminder'none' | 'min5' | 'min30' | 'hour' nullable

Reminder

contactIdstring nullable

Contact ID

responsibleAdminIdstring nullable

Assignee ID

studentScenarioProgressIdstring nullable

Contact automation progress ID

creatorByAdminIdstring nullable

ID of the admin who created the task

pipelineItemIdstring nullable

Deal ID

hasScenarioNodeIdboolean

Has automation step ID

hasPipelineItemIdboolean

Has deal ID

outdatedboolean

Overdue

completedboolean

Completed

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminTaskIdstring required

Task ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminTaskIdstring required

Task ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

desingStyleHTMLPublishedstring nullable

Published HTML design style

freeAccessboolean

Available for free

isPublishedboolean

Published

gamificationEnabledboolean

Gamification enabled

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentCountinteger

User count

itemCountinteger

Number of steps

primaryImageIdstring nullable

Primary image ID

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Name

commentstring nullable

Comment

positioninteger

Position

avgRatingnumber float

Average rating

type'section' | 'step'

Type

isDraftboolean

Draft

ratingEnabledboolean

Rating enabled

ratingCommentRequiredboolean

Rating comment required

preventCopingAndSelectingTextboolean

Prevent copying and selecting text

allowCommentsboolean

Allow comments

showCommentsboolean

Show comments

disableCommentModerationboolean

Disable comment moderation

viewCountinteger

View count

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

flowTimeDelayActiveboolean

Enable delay when the library is taken in a cohort

flowTimeDelayinteger nullable

Delay when the library is taken in a cohort

flowTimeDelayCondition'flowStart' nullable

Delay condition when the library is taken in a cohort

flowTimeDelayMeasureType'days' | 'hours' | 'weeks' | 'months' | 'minutes' nullable

Delay unit when the library is taken in a cohort

libraryIdstring required

Library ID

parentItemIdstring nullable

Parent item ID

parentItemAccelModelProjectModulesLibrariesLibraryItem circular
childrenAccelModelProjectModulesLibrariesLibraryItem[] circular
canContainChildrenboolean

Can contain child items

needCheckFlowTimeDelayboolean

Whether to check the delay when the library is taken in a cohort

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryItemIdstring required

Library step ID

libraryAccessIdstring required

Library access ID

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

categoryIdstring required

Category ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

libraryIdstring required

Library ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

durationnumber float

Duration

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productPackageIdstring required

Product package ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Plan ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productPackageIdstring required

Product package ID

libraryAccessIdstring required

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

nodeCountinteger

Number of steps

additionalDatastring nullable

Additional data

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedStudentScenariosCountinteger

Number of completed runs

activeStudentScenariosCountinteger

Number of active runs

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

sitePageIdstring nullable

Website page ID

flowIdstring nullable

Cohort ID

webinarIdstring nullable

Webinar ID

widgetIdstring nullable

Widget ID

productIdstring nullable

Product ID

chatBotIdstring nullable

Chatbot ID

quizIdstring nullable

Form or quiz ID

pipelineIdstring nullable

Pipeline ID

partnershipIdstring nullable

Affiliate program ID

certIdstring nullable

Certificate ID

chatChannelIdstring nullable

Chat channel ID

telegramGroupIdstring nullable

Telegram group/channel ID

facebookFormIdstring nullable

::API.Modules.Scenarios.Scenario.FacebookFormId::

gamificationIdstring nullable

Gamification ID

gamificationProductIdstring nullable

Gamification product ID

communityIdstring nullable

::API.Modules.Scenarios.Scenario.CommunityId::

meetingIdstring nullable

::API.Modules.Scenarios.Scenario.MeetingId::

socialConnectionIdstring nullable

::API.Modules.Scenarios.Scenario.SocialConnectionId::

voiceCampaignIdstring nullable

::API.Modules.Scenarios.Scenario.VoiceCampaignId::

type'course' | 'courseItem' | 'sitePage' | 'flow' | 'webinar' | 'product' | 'chatBot' | 'widget' | 'simple' | 'quiz' | 'pipeline' | 'partnership' | 'cert' | 'chatChannel' | 'gamification' | 'gamificationProduct' | 'telegramGroup' | 'community' | 'facebookForm' | 'meeting' | 'socialConnection'

Type

isActiveboolean

Active

isMainboolean

::API.Modules.Scenarios.Scenario.IsMain::

targetIdstring nullable

Target ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

settingsJsonstring nullable

JSON settings

payloadstring nullable

Payload

type'event' | 'action' | 'listener'

Type

actionTypestring nullable

Action type

executionCountinteger

Number of executions

listenerCountinteger

Number of contacts waiting at the step

useButtonsOneTimeboolean nullable

Use one-time buttons

purchaseCountinteger nullable

Purchase count

purchaseAmountnumber double nullable

Purchase amount

scenarioIdstring required

Automation ID

hasPayloadboolean

Has payload

hasSettingsJsonboolean

Has JSON settings

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'button' | 'expireButton' | 'custom' | 'aiAssistant' | 'voiceCallOutcome'

Type

payloadJsonstring nullable

Payload (JSON)

executionCountinteger

Number of executions

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

nodeIdstring required

Step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time nullable

Creation date

parentNodeIdstring required

Previous step ID

childNodeIdstring required

Next step ID

scenarioIdstring required

Automation ID

portIdstring nullable

Port ID

type'default' | 'success' | 'fail' | 'aborted' | 'repeat' | 'wait'

Type

pointsJsonstring nullable

Connector points (JSON)

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

expirationDatestring date-time nullable

::API.Modules.Scenarios.ScenarioNodeListener.ExpirationDate::

nodeIdstring required

::API.Modules.Scenarios.ScenarioNodeListener.NodeId::

studentScenarioIdstring required

::API.Modules.Scenarios.ScenarioNodeListener.StudentScenarioId::

nodePayloadJsonstring required

::API.Modules.Scenarios.ScenarioNodeListener.NodePayloadJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

executedDatestring date-time

Execution date

scenarioNodeIdstring required

Step ID

studentIdstring required

Contact ID

flowDateIdstring nullable

Cohort date ID

webinarIdstring nullable

Webinar ID

studentLicenseIdstring nullable

Contact license ID

meetingBookingIdstring nullable

::API.Modules.Scenarios.ExecutedScenarioNode.MeetingBookingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

scheduledDatestring date-time

::API.Modules.PlannedActions.PlannedAction.ScheduledDate::

payloadstring nullable

::API.Modules.PlannedActions.PlannedAction.Payload::

scenarioNodeIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodeId::

studentScenarioIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentScenarioId::

adminTaskIdstring nullable

::API.Modules.PlannedActions.PlannedAction.AdminTaskId::

scenarioNodeListenerIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodeListenerId::

scenarioNodePortIdstring nullable

::API.Modules.PlannedActions.PlannedAction.ScenarioNodePortId::

studentLicenseIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentLicenseId::

studentLicenseSuspensionIdstring nullable

::API.Modules.PlannedActions.PlannedAction.StudentLicenseSuspensionId::

actionNamestring nullable

::API.Modules.PlannedActions.PlannedAction.ActionName::

expiryDatestring date-time nullable

::API.Modules.PlannedActions.PlannedAction.ExpiryDate::

type'scenario' | 'common' | 'scenarioNodeListener'

::API.Modules.PlannedActions.PlannedAction.Type::

hasPayloadboolean

::API.Modules.PlannedActions.PlannedAction.HasPayload::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Brands.BrandStyle.Name::

summarystring nullable

::API.Modules.Brands.BrandStyle.Summary::

isSystemboolean

::API.Modules.Brands.BrandStyle.IsSystem::

sourceStyleIdstring nullable

::API.Modules.Brands.BrandStyle.SourceStyleId::

sourceStyleAccelModelProjectModulesBrandsBrandStyle circular
descriptionMdstring nullable

::API.Modules.Brands.BrandStyle.DescriptionMd::

tokensJsonstring nullable

::API.Modules.Brands.BrandStyle.TokensJson::

previewPageHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewPageHtml::

previewEmailHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewEmailHtml::

previewLessonHtmlstring nullable

::API.Modules.Brands.BrandStyle.PreviewLessonHtml::

logoFileIdstring nullable

::API.Modules.Brands.BrandStyle.LogoFileId::

logoInverseFileIdstring nullable

::API.Modules.Brands.BrandStyle.LogoInverseFileId::

assetsJsonstring nullable

::API.Modules.Brands.BrandStyle.AssetsJson::

aiDialogIdstring nullable

::API.Modules.Brands.BrandStyle.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

creatorIdstring nullable

::API.Modules.Brands.BrandStyle.CreatorId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

subdomainstring nullable

Subdomain

domainPostfixstring nullable

::API.Modules.Sites.Site.DomainPostfix::

shortDescriptionstring nullable

Short description

enabledboolean

Enabled

headerIntegrationCodestring nullable

Integration code added to the head section of every page

bodyIntegrationCodestring nullable

Integration code added to the body of every page

robotsTxtstring nullable

Contents of the robots.txt file

llmsTxtstring nullable

::API.Modules.Sites.Site.LlmsTxt::

formTermsstring nullable

Form terms

formTermsEnabledboolean

Whether form terms are enabled

formTermsDefaultAcceptedboolean

Whether the form terms checkbox is checked by default

checkoutFormTermsstring nullable

Checkout form terms

checkoutFormTermsEnabledboolean

Whether checkout form terms are enabled

checkoutFormTermsDefaultAcceptedboolean

Whether the checkout form terms checkbox is checked by default

isCookieNotificationEnabledboolean

Whether the cookie notification is enabled

cookieNotificationTextstring nullable

Cookie notification text

mapEnabledboolean

::API.Modules.Sites.Site.MapEnabled::

chatEnabledboolean

::API.Modules.Sites.Site.ChatEnabled::

chatChannelIdstring nullable

::API.Modules.Sites.Site.ChatChannelId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

faviconIdstring nullable

Favicon ID

logoIdstring nullable

Logo ID

siteDomainIdstring nullable

Site domain ID

page404Idstring nullable

404 page ID

createdByAdminIdstring required

ID of the admin who created the site

updatedByAdminIdstring nullable

ID of the admin who last updated the site

softDeletedByAdminIdstring nullable

ID of the admin who deleted the site

canUseFormTermsboolean

Whether form terms are enabled and filled in

canUseCheckoutFormTermsboolean

Whether checkout form terms are enabled and filled in

viewStatsJsonstring nullable

::API.Modules.Sites.Site.ViewStatsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

segmentstring nullable

Segment

urlstring nullable

URL

shortDescriptionstring nullable

Short description

isPublishedboolean

Whether the page is published

redirectboolean

Whether the page redirects to another URL

positioninteger

Position

redirectUrlstring nullable

Redirect URL

redirectPermanentboolean

::API.Modules.Sites.SitePage.RedirectPermanent::

imageIdstring nullable

Image ID

hideFromSearchBotsboolean

Whether to hide the page from search engines

designHTMLstring nullable

Design HTML

designStylestring nullable

Design style

headHtmlstring nullable

Head HTML

bodyHtmlstring nullable

Body HTML

headHtmlPublishedstring nullable

::API.Modules.Sites.SitePage.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SitePage.BodyHtmlPublished::

headerIntegrationCodestring nullable

Integration code added to the head section of the page

bodyIntegrationCodestring nullable

Integration code added to the body of the page

layoutType'default' | 'custom'

Layout type

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SitePage.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SitePage.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SitePage.BrandStyleId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt' nullable

Language

customLangstring nullable

Custom language

headerIdstring nullable

Header ID

footerIdstring nullable

Footer ID

parentIdstring nullable

Parent page ID

parentAccelModelProjectModulesSitesSitePage circular
siteIdstring required

Site ID

createdByAdminIdstring required

ID of the admin who created the page

updatedByAdminIdstring nullable

ID of the admin who last updated the page

softDeletedByAdminIdstring nullable

ID of the admin who deleted the page

variationTestIdstring nullable

::API.Modules.Sites.SitePage.VariationTestId::

childrenAccelModelProjectModulesSitesSitePage[] circular
aiDialogIdstring nullable

::API.Modules.Sites.SitePage.AiDialogId::

screenshotFileIdstring nullable

::API.Modules.Sites.SitePage.ScreenshotFileId::

hasHeaderIdboolean

Whether a header is assigned to the page

hasFooterIdboolean

Whether a footer is assigned to the page

hasImageIdboolean

Whether an image is assigned to the page

viewStatsJsonstring nullable

::API.Modules.Sites.SitePage.ViewStatsJson::

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sitePageIdstring required

::API.Modules.Sites.SitePageRevision.SitePageId::

createdByAdminIdstring nullable

::API.Modules.Sites.SitePageRevision.CreatedByAdminId::

source'manual' | 'ai' | 'publish' | 'rollback'

::API.Modules.Sites.SitePageRevision.Source::

titlestring nullable

::API.Modules.Sites.SitePageRevision.Title::

commentstring nullable

::API.Modules.Sites.SitePageRevision.Comment::

headHtmlstring nullable

::API.Modules.Sites.SitePageRevision.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageRevision.BodyHtml::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Sites.SitePageVariation.Name::

shortDescriptionstring nullable

::API.Modules.Sites.SitePageVariation.ShortDescription::

headHtmlstring nullable

::API.Modules.Sites.SitePageVariation.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageVariation.BodyHtml::

headHtmlPublishedstring nullable

::API.Modules.Sites.SitePageVariation.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SitePageVariation.BodyHtmlPublished::

layoutType'default' | 'custom'

::API.Modules.Sites.SitePageVariation.LayoutType::

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SitePageVariation.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SitePageVariation.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SitePageVariation.BrandStyleId::

trafficPercentnumber double

::API.Modules.Sites.SitePageVariation.TrafficPercent::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pageIdstring required

::API.Modules.Sites.SitePageVariation.PageId::

testIdstring required

::API.Modules.Sites.SitePageVariation.TestId::

aiDialogIdstring nullable

::API.Modules.Sites.SitePageVariation.AiDialogId::

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

sitePageVariationIdstring required

::API.Modules.Sites.SitePageVariationRevision.SitePageVariationId::

createdByAdminIdstring nullable

::API.Modules.Sites.SitePageVariationRevision.CreatedByAdminId::

source'manual' | 'ai' | 'publish' | 'rollback'

::API.Modules.Sites.SitePageVariationRevision.Source::

titlestring nullable

::API.Modules.Sites.SitePageVariationRevision.Title::

commentstring nullable

::API.Modules.Sites.SitePageVariationRevision.Comment::

headHtmlstring nullable

::API.Modules.Sites.SitePageVariationRevision.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Sites.SitePageVariationRevision.BodyHtml::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

beginDatestring date-time nullable

::API.Modules.Sites.SitePageVariationTest.BeginDate::

endDatestring date-time nullable

::API.Modules.Sites.SitePageVariationTest.EndDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currentVariationIdstring nullable

::API.Modules.Sites.SitePageVariationTest.CurrentVariationId::

winnedVariationIdstring nullable

::API.Modules.Sites.SitePageVariationTest.WinnedVariationId::

pageIdstring required

::API.Modules.Sites.SitePageVariationTest.PageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Domain name

redirectTostring nullable

Redirect target

movedPermanentlyboolean

Whether the redirect is permanent (301)

isSslCertIssuedboolean

Whether the SSL certificate is issued

isConfirmedboolean

Whether the domain is verified

isMainboolean

Whether this is the primary domain

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

dnsTarget'unknown' | 'current' | 'legacy' | 'external' | 'none'

::API.Modules.Sites.SiteDomain.DnsTarget::

dnsCheckedDatestring date-time nullable

::API.Modules.Sites.SiteDomain.DnsCheckedDate::

createdByAdminIdstring required

ID of the admin who created the domain

updatedByAdminIdstring nullable

ID of the admin who last updated the domain

softDeletedByAdminIdstring nullable

ID of the admin who deleted the domain

hasSiteboolean

Whether the domain is linked to a site

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

type'header' | 'footer'

Type

bodyHtmlstring nullable

::API.Modules.Sites.SiteComponent.BodyHtml::

bodyHtmlPublishedstring nullable

::API.Modules.Sites.SiteComponent.BodyHtmlPublished::

layoutType'default' | 'custom'

::API.Modules.Sites.SiteComponent.LayoutType::

layoutTypePublished'default' | 'custom' nullable

::API.Modules.Sites.SiteComponent.LayoutTypePublished::

previewTokenstring nullable

::API.Modules.Sites.SiteComponent.PreviewToken::

brandStyleIdstring nullable

::API.Modules.Sites.SiteComponent.BrandStyleId::

aiDialogIdstring nullable

::API.Modules.Sites.SiteComponent.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

siteIdstring required

Site ID

createdByAdminIdstring required

ID of the admin who created the component

updatedByAdminIdstring nullable

ID of the admin who last updated the component

softDeletedByAdminIdstring nullable

ID of the admin who deleted the component

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

pathstring nullable

Path

type'content' | 'file'

Type

contentstring nullable

Content

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fileIdstring nullable

File ID

siteIdstring required

Site ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

type'pageVisited' | 'conversionFormSubmitted' | 'conversionWebinarRegistration' | 'conversionProductAddedToCart' | 'conversionChatBotRegistration' | 'conversionOrderPayment' | 'conversionOrderCreated' | 'conversionContactCreated' | 'conversionOrderPaid' | 'conversionOrderPaymentRefund' | 'conversionQuizFormSubmitted' | 'conversionPipelineDealCompleted' | 'conversionPipelineDealNotCompleted' | 'conversionPartnerLinkNavigation' | 'conversionOrderSubscriptionTrial' | 'conversionMeetingBooked'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

positioninteger

Position

funnelIdstring required

Funnel ID

pageIdstring required

Page ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

paymentButtonTextstring nullable

Payment button text

externalIdstring nullable

External ID

type'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay'

Type

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

settingsstring nullable

Settings

webhookSettingsstring nullable

Webhook settings

isPrimaryboolean

Primary gateway

showOnSiteboolean

Show on website

saveCardEnabledboolean

Save card details for future payments where applicable

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

hasSettingsboolean

Has settings

isSupportSaveCardboolean

Supports saved cards

needRegisterWebhookboolean

Webhook registration required

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

descriptionstring nullable

Description

paymentOverridesJsonstring nullable

Payment overrides (JSON)

type'digital' | 'physical' | 'service' | 'material' | 'subscription' | 'cohort'

Type

freeDownloadboolean

Free download

isPublishedboolean

Published

preventSystemEmailboolean

Don't send system emails

installmentDisabledboolean

Installments disabled

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

oneTimePricenumber double nullable

One-time price

useOneTimeDisplayPriceboolean

Show price before discount

oneTimeDisplayPricenumber double

Price before discount

durationinteger nullable

Duration

durationType'day' | 'month'

Duration type

beginDatestring date-time nullable

Start date

endDatestring date-time nullable

End date

subsPricenumber double

Subscription price

subsDurationinteger

Subscription duration

subsDurationType'day' | 'month'

Subscription duration type

subsRenewalCreditDayCountinteger nullable

Days of access kept after a failed renewal payment

subsRenewalSettingsJsonstring nullable

Subscription renewal settings (JSON)

useTrialSubsboolean

Offer a trial subscription

trialSubsPricenumber double

Trial subscription price

trialSubsDurationinteger

Trial subscription duration

trialSubsDurationType'day' | 'month'

Trial subscription duration type

useBonusPaymentboolean

Allow payment with bonuses

bonusPaymentAmountnumber double

Bonus payment amount

bonusPaymentType'percent' | 'value'

Bonus payment type

orderCountinteger

Number of orders

contactCountinteger

Number of contacts

limitOrderLifetimeboolean

Limit how long orders stay valid

limitOrderLifetimeDurationinteger nullable

Order validity period

limitOrderLifetimeDatestring date-time nullable

Date until which the order is valid

limitOrderLifetimeMode'duration' | 'date'

Order validity limit mode

useDonationPaymentboolean

Use donation pricing

minDonationPaymentAmountnumber double

Minimum donation amount

primaryImageIdstring nullable

Primary image ID

imageIdstring nullable

Image ID

flowDateIdstring nullable

Cohort date ID

categoryIdstring nullable

Category ID

isSubscriptionboolean

Subscription

supportsContentboolean

Supports content

pricenumber double nullable

Price

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

sourceIdstring required

Source ID

targetIdstring required

Target ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

::API.Modules.Products.ProductRelatedProductCategoryLink.ProductId::

categoryIdstring required

::API.Modules.Products.ProductRelatedProductCategoryLink.CategoryId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

amountinteger

::API.Modules.Products.ProductShoppingCartItem.Amount::

siteGuestIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.SiteGuestId::

trialboolean nullable

::API.Modules.Products.ProductShoppingCartItem.Trial::

productIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.ProductId::

studentIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.StudentId::

siteIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.SiteId::

widgetIdstring nullable

::API.Modules.Products.ProductShoppingCartItem.WidgetId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

type'course' | 'coursePlan' | 'library' | 'allCourses' | 'allLibraries' | 'meeting'

Type

productIdstring required

Product ID

courseIdstring nullable

Course ID

coursePlanIdstring nullable

Course plan ID

libraryAccessIdstring nullable

Library access ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

Product ID

gatewayIdstring required

Payment gateway ID

type'onlineKassa' | 'paymentMethodGroups'

Type

tax'none' | 'vat0' | 'vat10' | 'vat12' | 'vat18' | 'vat20' | 'vat110' | 'vat118' | 'vat120' | 'vat5' | 'vat7' | 'vat105' | 'vat107' nullable

Tax

paymentObject'commodity' | 'excise' | 'job' | 'service' | 'gamblingBet' | 'gamblingPrize' | 'lottery' | 'lotteryPrize' | 'intellectualActivity' | 'payment' | 'agentCommission' | 'composite' | 'another' | 'propertyRight' | 'nonOperatingGain' | 'insurancePremium' | 'salesTax' | 'resortFee' | 'unknown' nullable

Payment object

paymentMethod'fullPayment' | 'partialPayment' | 'fullPrepayment' | 'partialPrepayment' | 'advance' | 'credit' | 'creditPayment' | 'unknown' nullable

Payment method

paymentMethodGroupsJsonstring nullable

Payment method groups as JSON

paymentMethodGroupsstring[] nullable

Payment method groups

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

productIdstring required

Product ID

gatewayIdstring required

Payment gateway ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

paidDatestring date-time nullable

Payment date

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

isDigitalDeliveryboolean

Digital delivery

isQuickboolean

Quick payment

fullyPaidboolean

Fully paid

completedboolean

Completed

termsAcceptedboolean nullable

Terms accepted

offSessionboolean

Off-session payment

isPartnerByPromoCodeboolean nullable

Affiliate assigned via promo code

shippingPricenumber double nullable

Shipping cost

totalAmountnumber double

Total amount

paidAmountnumber double

Paid amount

paidBonusAmountnumber double

Amount paid with bonuses

savingsAmountnumber double

Discount amount

feeAmountnumber double

Fee amount

partnerFeeAmountnumber double

Affiliate commission amount

incomenumber double

Income

donationAmountnumber double nullable

Donation amount

deductionAmountnumber double

Deduction amount

payAmountnumber double

Amount due

hasShippingPriceboolean

Has shipping price

needShippingboolean

Requires shipping

partiallyPaidboolean

Partially paid

shippingPriceUsdnumber double nullable

Shipping cost in USD

totalAmountUsdnumber double nullable

Total amount in USD

paidAmountUsdnumber double nullable

Paid amount in USD

savingsAmountUsdnumber double nullable

Discount amount in USD

feeAmountUsdnumber double nullable

Fee amount in USD

status'created' | 'checkoutData' | 'payment' | 'partiallyPaid' | 'paid' | 'preparingShipment' | 'shipped' | 'fulfilled' | 'canceled' | 'refund'

Status

subscriptionAction'trial' | 'trialUpgrade' | 'fullPurchase' | 'fullPurchaseUpdate' nullable

Subscription action

shippingEmailstring nullable

Recipient email

shippingFirstNamestring nullable

Recipient first name

shippingLastNamestring nullable

Recipient last name

shippingPhonestring nullable

Recipient phone

shippingAddressstring nullable

Shipping address

shippingCitystring nullable

Shipping city

shippingStatestring nullable

Shipping state or region

shippingZipstring nullable

Shipping ZIP code

shippingCountrystring nullable

Shipping country

shippingCommentstring nullable

Shipping comment

shippingTrackingCodestring nullable

Tracking number

siteGuestIdstring nullable

Website visitor ID

siteSessionIdstring nullable

Website session ID

siteSessionEnterViewIdstring nullable

Website session page view ID

stepsJsonstring nullable

Steps in JSON

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

expirationDatestring date-time nullable

Expiration date

parentIdstring nullable

Parent order ID

studentIdstring nullable

Contact ID

voiceCallIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.VoiceCallId::

partnerIdstring nullable

Affiliate ID

adminIdstring nullable

Admin ID

responsibleIdstring nullable

Owner ID

paymentGatewayIdstring nullable

Payment gateway ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

sitePageVariationTestIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.SitePageVariationTestId::

sitePageVariationIdstring nullable

::API.Modules.Products.ProductPurchaseOrder.SitePageVariationId::

widgetIdstring nullable

Widget ID

promoCodeIdstring nullable

Promo code ID

lastPaymentMethodIdstring nullable

Last payment method ID

lastPaymentIdstring nullable

Last payment ID

numberinteger

Order number

renewalLicenseIdstring nullable

Renewed license ID

pipelineItemIdstring nullable

Deal ID

emailIdstring nullable

Email ID

emailTemplateIdstring nullable

Email template ID

broadcastIdstring nullable

Broadcast ID

webinarIdstring nullable

Webinar ID

scenarioNodeIdstring nullable

Automation step ID

scenarioNodePortIdstring nullable

Automation step port ID

childOrdersAccelModelProjectModulesProductsProductPurchaseOrder[] circular
hasSiteIdboolean

Has website ID

hasSitePageIdboolean

Has website page ID

hasWidgetIdboolean

Has widget ID

hasStudentIdboolean

Has contact ID

hasShippingEmailboolean

Has shipping email

hasShippingPhoneboolean

Has shipping phone

hasShippingFirstNameboolean

Has shipping first name

hasShippingLastNameboolean

Has shipping last name

hasGatewayIdboolean

Has payment gateway ID

hasPipelineItemIdboolean

Has deal ID

hasWebinarIdboolean

Has webinar ID

hasAdminIdboolean

Has admin ID

hasLastPaymentMethodIdboolean

Has last payment method ID

hasUsdCurrencyboolean

Has USD currency

isUpSellboolean

Upsell

hasResponsibleIdboolean

Has owner ID

responsibleNamestring nullable

Owner name

promoCodeNamestring nullable

Promo code name

isSubsRenewalboolean

Subscription renewal

hasUtmTagsboolean

Has UTM parameters

hasUpsellStepboolean

Has upsell step

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

keyNamestring nullable

Key name

requiredboolean

Required

positioninteger

Position

additionalDatastring nullable

Additional data

type'text' | 'textArea' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String

valueNumericnumber double nullable

Number

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time

valueDatestring date-time nullable

Date

valueListstring nullable

List

valueMultiListstring nullable

Multi-value list

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

orderIdstring required

Order ID

fieldIdstring required

Field ID

hasValueListboolean

Has value list

hasValueMultiListboolean

Has a multi-value list

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

quantityinteger

Quantity

priceEachnumber double

Price

savingsEachnumber double

Discount

finalPriceEachnumber double

Final price

createdDatestring date-time

Creation date

trialboolean nullable

Trial

productIdstring required

Product ID

purchaseOrderIdstring required

Order ID

partnershipOfferIdstring nullable

Affiliate offer ID

partnerFeenumber double nullable

Affiliate commission

totalPriceNoSavingsnumber double

Total price before discount

totalSavingsnumber double

Total discount

totalPriceFinalnumber double

Total price

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'money' | 'bonus'

Type

saveCardboolean nullable

Save card

saveCardErrorstring nullable

Error saving card

amountnumber double

Amount

feenumber double nullable

Fee

deductionnumber double

Deduction

incomenumber double

Income

amountUsdnumber double nullable

Amount in USD

feeUsdnumber double nullable

Fee in USD

status'pending' | 'waitingForCapture' | 'success' | 'canceled' | 'fail' | 'refund'

Status

installmentStatus'pending' | 'approved' | 'canceled' | 'denied' | 'success' nullable

Installment status

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

createdDatestring date-time

Creation date

paymentDatestring date-time nullable

Payment date

waitingForCaptureUntilDatestring date-time nullable

Date until which the payment awaits capture

updatedDatestring date-time nullable

Date the record was last updated.

gatewayAmountnumber double nullable

Gateway amount

gatewayCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Gateway currency

gatewayExchangeRatenumber double

Gateway exchange rate

errorMessagestring nullable

Error message

additionalPaymentDatastring nullable

Additional payment data

additionalPaymentMethodNamestring nullable

Additional payment method name

additionalPaymentMethodDatastring nullable

Additional payment method data

externalIdstring nullable

External ID

isTestboolean

Test payment

purchaseOrderIdstring required

Order ID

paymentGatewayIdstring nullable

Payment gateway ID

refundPaymentIdstring nullable

Refund payment ID

refundPaymentAccelModelProjectModulesProductsProductPurchaseOrderPayment circular
paymentMethodIdstring nullable

Payment method ID

adminIdstring nullable

Admin ID

isSuccessboolean

Successful payment

isRefundboolean

Refund

isFailboolean

Failed payment

isManualboolean

Manual payment

hasUsdCurrencyboolean

Whether the payment is in USD

offSessionboolean

Off-session payment

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

orderIdstring required

Order ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

internalNamestring nullable

Internal name

shortNamestring nullable

Short name

descriptionstring nullable

Description

commentstring nullable

Comment

afterwordstring nullable

Closing message

streamSourcesJsonstring nullable

Stream sources as JSON

blockedIPsJsonstring nullable

Blocked IP addresses as JSON

chatChannelsJsonstring nullable

Chat channels as JSON

isTemplateboolean

Whether the webinar is a template

hasEventsboolean

Whether the webinar has events

firstEventStartDelayMsnumber double

Delay before the first event starts, in milliseconds

templateDurationMsinteger nullable

Template duration, in milliseconds

useActiveAsNearestboolean

Treat an in-progress webinar as the nearest one

afterCompletionRedirectboolean

Redirect after the webinar ends

afterCompletionRedirectUrlstring nullable

URL to redirect attendees to after the webinar ends

firstStartEventDelayMsnumber double nullable

Delay before the first start event, in milliseconds

firstStartEventDelaystring date-span

Delay before the first start event

lastCompletionEventDelayMsnumber double nullable

Delay before the last completion event, in milliseconds

lastCompletionEventDelaystring date-span

Delay before the last completion event

scheduledStartDatestring date-time nullable

Scheduled start date

scheduledCompletionDatestring date-time nullable

Scheduled completion date

useContactFilterboolean nullable

Use contact filter

contactFilterJsonstring nullable

Contact filter as JSON

initialStatestring nullable

Initial state

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

startedDatestring date-time nullable

Actual start date

precompletedDatestring date-time nullable

Pre-completion date

completedDatestring date-time nullable

Completion date

scheduledDatestring date-time

Scheduled date

scheduledTimezoneIdstring nullable

Time zone ID for the scheduled date

scheduleCronstring nullable

Schedule as a cron expression

scheduleTimezoneIdstring nullable

Schedule time zone ID

durationinteger nullable

Duration

closeRegistrationBeforeStartboolean

Close registration before the start

closeRegistrationBeforeStartInHoursinteger

Hours before the start when registration closes

templateDurationstring date-span

Template duration

currentDurationMsnumber double

Current duration, in milliseconds

numberinteger

Number

userCountinteger

User count

userTotalCountinteger

Total number of users

registrationSettingsJsonstring nullable

Registration settings as JSON

designSettingsJsonstring nullable

Design settings as JSON

roomSettingsJsonstring nullable

Room settings as JSON

integrationSettingsJsonstring nullable

Integration settings as JSON

statsJsonstring nullable

Statistics as JSON

startScenarioEventProcessedboolean

Whether the start event for automations has been processed

completeScenarioEventProcessedboolean

Whether the completion event for automations has been processed

cleanupDateTimestring date-time nullable

Cleanup date and time

siteDomainIdstring nullable

Website domain ID

sourceIdstring nullable

Source ID

sourceAccelModelProjectModulesWebinarsWebinar circular
templateIdstring nullable

Template ID

templateAccelModelProjectModulesWebinarsWebinar circular
createdByAdminIdstring nullable

ID of the admin who created the webinar

chatBotIdstring nullable

Chatbot ID

status'notStarted' | 'inProgress' | 'completed'

Status

hasAfterCompletionRedirectUrlboolean

Whether a redirect URL is set for after the webinar ends

сanRedirectAfterCompletionboolean

Whether attendees can be redirected after the webinar ends

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

Webinar ID

fileIdstring nullable

File ID

conversionIdstring nullable

Conversion ID

widgetIdstring nullable

Widget ID

videoIdstring nullable

Video ID

urlstring nullable

URL

metaJsonstring nullable

::API.Modules.Webinars.WebinarContent.MetaJson::

type'file' | 'presentation' | 'video' | 'stream' | 'widget' | 'live' | 'poll'

Type

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

::API.Modules.Webinars.WebinarPage.WebinarId::

kind'registration' | 'waiting'

::API.Modules.Webinars.WebinarPage.Kind::

fixedThemeboolean

::API.Modules.Webinars.WebinarPage.FixedTheme::

templateKeystring nullable

::API.Modules.Webinars.WebinarPage.TemplateKey::

headHtmlstring nullable

::API.Modules.Webinars.WebinarPage.HeadHtml::

bodyHtmlstring nullable

::API.Modules.Webinars.WebinarPage.BodyHtml::

headHtmlPublishedstring nullable

::API.Modules.Webinars.WebinarPage.HeadHtmlPublished::

bodyHtmlPublishedstring nullable

::API.Modules.Webinars.WebinarPage.BodyHtmlPublished::

previewTokenstring nullable

::API.Modules.Webinars.WebinarPage.PreviewToken::

designConcurrencyStampstring nullable

Data change indicator

brandStyleIdstring nullable

::API.Modules.Webinars.WebinarPage.BrandStyleId::

aiDialogIdstring nullable

::API.Modules.Webinars.WebinarPage.AiDialogId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

publishedDatestring date-time nullable

::API.Modules.Webinars.WebinarPage.PublishedDate::

createdByAdminIdstring nullable

::API.Modules.Webinars.WebinarPage.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.Webinars.WebinarPage.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

shortDescriptionstring nullable

Short description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

Language

viewsCountinteger

View count

isAccessAnywhereboolean

Whether the video can be accessed from anywhere

accessJsonstring nullable

Access settings in JSON format

settingsJsonstring nullable

Video settings in JSON format

primaryImageIdstring nullable

Primary image ID

currentVideoStreamIdstring nullable

Current video stream ID

createdByAdminIdstring nullable

ID of the admin who created the video

updatedByAdminIdstring nullable

ID of the admin who last updated the video

videoAccessIdstring nullable

Video access ID

isNotCompletedStreamExistboolean

Whether the video has a stream that hasn't finished processing

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

attemptsinteger

Attempts

axlModerationStatestring nullable

::API.Modules.Videos.VideoStream.AxlModerationState::

axlPackageJsonstring nullable

::API.Modules.Videos.VideoStream.AxlPackageJson::

axlJobIdstring nullable

::API.Modules.Videos.VideoStream.AxlJobId::

state'cloudUploading' | 'cloudUploaded' | 'converting' | 'completed' | 'failure' | 'aborted' | 'deleteFailure' | 'prepareConverting' | 'providerUploading' | 'providerUploaded' | 'deleting' | 'downloading'

State

subState'default' | 'reconvert' | 'reconverting' | 'completed' | 'failure'

Substate

provider'cloudVideo' | 'museVideo' | 'custom' | 'kinescope' | 'axl'

Provider

durationinteger

Duration in seconds

widthinteger

Width

heightinteger

Height

mp4string nullable

MP4 file URL

dashstring nullable

MPEG-DASH stream URL

hlsfmp4string nullable

HLS (fMP4) stream URL

hlsstring nullable

HLS stream URL

originalSizeinteger

Original file size in bytes

progressinteger

Progress

createdDatestring date-time

Creation date

convertBeginDatestring date-time nullable

Conversion start date

convertCompleteDatestring date-time nullable

Conversion completion date

providerIdstring nullable

Video ID at the provider

providerAdditionalDatastring nullable

Additional provider data

providerAssetsSizeinteger nullable

Size of converted files at the provider, in bytes

errorMessagestring nullable

Error message

videoIdstring required

Video ID

fileIdstring nullable

File ID

storyboardIdstring nullable

Storyboard ID

createdByAdminIdstring nullable

ID of the admin who created the video stream

parentIdstring nullable

Parent stream ID

parentAccelModelProjectModulesVideosVideoStream circular
childrenAccelModelProjectModulesVideosVideoStream[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

seenThroughDatestring date-time

::API.Modules.Videos.AxlVideoModeratorInbox.SeenThroughDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

::API.Modules.Videos.AxlVideoJob.VideoStreamId::

statestring required

::API.Modules.Videos.AxlVideoJob.State::

remoteIdstring nullable

::API.Modules.Videos.AxlVideoJob.RemoteId::

stagestring nullable

::API.Modules.Videos.AxlVideoJob.Stage::

errorCodestring nullable

::API.Modules.Videos.AxlVideoJob.ErrorCode::

attemptinteger

::API.Modules.Videos.AxlVideoJob.Attempt::

progressinteger

::API.Modules.Videos.AxlVideoJob.Progress::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

leaseUntilstring date-time nullable

::API.Modules.Videos.AxlVideoJob.LeaseUntil::

retryAfterstring date-time nullable

::API.Modules.Videos.AxlVideoJob.RetryAfter::

cleanedDatestring date-time nullable

::API.Modules.Videos.AxlVideoJob.CleanedDate::

resultJsonstring nullable

::API.Modules.Videos.AxlVideoJob.ResultJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

::API.Modules.Videos.AxlVideoReview.VideoStreamId::

adminIdstring nullable

::API.Modules.Videos.AxlVideoReview.AdminId::

managerIdstring nullable

::API.Modules.Videos.AxlVideoReview.ManagerId::

loginSessionIdstring nullable

::API.Modules.Videos.AxlVideoReview.LoginSessionId::

decisionstring required

::API.Modules.Videos.AxlVideoReview.Decision::

reasonstring required

::API.Modules.Videos.AxlVideoReview.Reason::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoStreamIdstring required

Video stream ID

fileIdstring required

File ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'vimeo'

::API.Modules.Videos.VideoProvider.Type::

namestring required

::API.Modules.Videos.VideoProvider.Name::

tokenstring required

::API.Modules.Videos.VideoProvider.Token::

createdDatestring date-time

Creation date

createdByAdminIdstring nullable

::API.Modules.Videos.VideoProvider.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring required

::API.Modules.Videos.VideoImport.ExternalId::

createdDatestring date-time

Creation date

state'default' | 'downloading' | 'uploading' | 'completed' | 'wrongCompleted'

::API.Modules.Videos.VideoImport.State::

errorMessagestring nullable

::API.Modules.Videos.VideoImport.ErrorMessage::

providerIdstring required

::API.Modules.Videos.VideoImport.ProviderId::

videoStreamIdstring nullable

::API.Modules.Videos.VideoImport.VideoStreamId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

Text

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

coursesAccessboolean

Course access

sitesAccessboolean

Website access

linkAccessboolean

Access via link

videoIdstring required

Video ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

videoAccessIdstring required

Video access ID

videoDomainIdstring required

Video domain ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

publishedDatestring date-time nullable

Publication date

viewCountinteger

View count

quizIdstring nullable

Quiz ID

meetingIdstring nullable

::API.Modules.Widgets.Widget.MeetingId::

screenshotFileIdstring nullable

::API.Modules.Widgets.Widget.ScreenshotFileId::

hasHtmlboolean

Whether the widget contains HTML.

designSettingsstring nullable

Design settings

designSettingsPublishedstring nullable

Published design settings

designHTMLPublishedstring nullable

Published HTML design

designStylePublishedstring nullable

Published design style

designConcurrencyStampstring nullable

Data change indicator

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

state'created' | 'uploaded' | 'processing' | 'completed' | 'failure' | 'aborted'

State

source'salesJet'

Source

lastImportedEntity'tag' | 'paymentGateway' | 'course' | 'courseImage' | 'courseCategory' | 'courseCategoryLink' | 'coursePlan' | 'courseItem' | 'courseItemPlanLink' | 'student' | 'studentCourse' | 'studentCourseAccess' | 'studentCourseItemProgress' | 'studentProduct' | 'studentTagLink' | 'product' | 'productPackage' | 'productPackageCourseLink' | 'productPurchaseOrder' | 'productPurchaseOrderContent' | 'productPurchaseOrderPayment' | 'productImageLink' | 'leadAttribute' | 'leadAttributeValue' | 'courseItemTest' | 'courseItemTestQuestion' | 'courseItemTestAnswer' | 'accelFile' | 'schoolContentItem' | 'courseItemFileLink' nullable

Last imported entity

totalCountinteger

Total count

processedCountinteger

Processed count

errorstring nullable

Error

fileIdstring required

File ID

createdByAdminIdstring required

ID of the admin who created it

updatedByAdminIdstring nullable

ID of the admin who updated it

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ExternalId::

source'salesJet'

::API.Modules.Imports.ExternalImportEntity.Source::

type'tag' | 'paymentGateway' | 'course' | 'courseImage' | 'courseCategory' | 'courseCategoryLink' | 'coursePlan' | 'courseItem' | 'courseItemPlanLink' | 'student' | 'studentCourse' | 'studentCourseAccess' | 'studentCourseItemProgress' | 'studentProduct' | 'studentTagLink' | 'product' | 'productPackage' | 'productPackageCourseLink' | 'productPurchaseOrder' | 'productPurchaseOrderContent' | 'productPurchaseOrderPayment' | 'productImageLink' | 'leadAttribute' | 'leadAttributeValue' | 'courseItemTest' | 'courseItemTestQuestion' | 'courseItemTestAnswer' | 'accelFile' | 'schoolContentItem' | 'courseItemFileLink'

::API.Modules.Imports.ExternalImportEntity.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time

Date the record was last updated.

accelFileIdstring nullable

::API.Modules.Imports.ExternalImportEntity.AccelFileId::

tagIdstring nullable

::API.Modules.Imports.ExternalImportEntity.TagId::

paymentGatewayIdstring nullable

::API.Modules.Imports.ExternalImportEntity.PaymentGatewayId::

courseIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseId::

courseImageIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseImageId::

courseCategoryIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseCategoryId::

courseCategoryLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseCategoryLinkId::

coursePlanIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CoursePlanId::

courseItemIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemId::

courseItemPlanLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemPlanLinkId::

courseItemFileLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemFileLinkId::

courseItemTestIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestId::

courseItemTestAnswerIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestAnswerId::

courseItemTestQuestionIdstring nullable

::API.Modules.Imports.ExternalImportEntity.CourseItemTestQuestionId::

schoolContentItemIdstring nullable

::API.Modules.Imports.ExternalImportEntity.SchoolContentItemId::

studentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentId::

studentCourseIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseId::

studentCourseAccessIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseAccessId::

studentCourseItemProgressIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentCourseItemProgressId::

studentProductIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentProductId::

studentTagLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.StudentTagLinkId::

productIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductId::

productPackageIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPackageId::

productPackageCourseLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPackageCourseLinkId::

productPurchaseOrderIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderId::

productPurchaseOrderContentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderContentId::

productPurchaseOrderPaymentIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductPurchaseOrderPaymentId::

productImageLinkIdstring nullable

::API.Modules.Imports.ExternalImportEntity.ProductImageLinkId::

leadAttributeIdstring nullable

::API.Modules.Imports.ExternalImportEntity.LeadAttributeId::

leadAttributeValueIdstring nullable

::API.Modules.Imports.ExternalImportEntity.LeadAttributeValueId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

codestring required

Code

beginDatestring date-time

Start date

endDatestring date-time nullable

End date

actionType'allProducts' | 'selectedProducts'

Action type

discountType'percent' | 'fixed'

Discount type

discountAmountnumber double

Discount amount

useAvailableCountboolean

Use quantity limit

availableCountinteger nullable

Available quantity

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn' nullable

Currency

subsRenewalDisabledboolean

Subscription renewal disabled

ignoreCaseboolean

Ignore case

isAutoboolean

Applied automatically

mode'students' | 'filter'

Mode

extendedFilterJsonstring nullable

Extended filter JSON

partnerIdstring nullable

Affiliate ID

status'active' | 'inactive' | 'expired' | 'ended'

Status

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

productIdstring required

Product ID

promoCodeIdstring required

Promo code ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

Contact ID

promoCodeIdstring required

Promo code ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.Title::

descriptionstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.Description::

type'folder' | 'item'

::API.Modules.SchoolContentItems.SchoolContentItem.Type::

sectionType'course' | 'library'

::API.Modules.SchoolContentItems.SchoolContentItem.SectionType::

positioninteger

::API.Modules.SchoolContentItems.SchoolContentItem.Position::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

parentIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.ParentId::

parentAccelModelProjectModulesSchoolContentItemsSchoolContentItem circular
coverIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.CoverId::

courseIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.CourseId::

libraryIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.LibraryId::

createdByAdminIdstring required

::API.Modules.SchoolContentItems.SchoolContentItem.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.UpdatedByAdminId::

softDeletedByAdminIdstring nullable

::API.Modules.SchoolContentItems.SchoolContentItem.SoftDeletedByAdminId::

hasCourseIdboolean

::API.Modules.SchoolContentItems.SchoolContentItem.HasCourseId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

currency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

Currency

billingPlanPriceJsonstring nullable

Plan price JSON

isPrimaryboolean

Primary

isThirdPartyboolean

Third-party

isAgreementRequiredboolean

Agreement required

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

defaultCreditAmountnumber double

Default credit amount

minimumExpensesAmountnumber double

Minimum spend

baseFeeAmountnumber double

::API.Modules.Billings.BillingPlan.BaseFeeAmount::

defaultTrialDaysCountinteger

Default trial days

fallbackPlanIdstring nullable

Fallback plan ID

fallbackPlanAccelModelProjectModulesBillingsBillingPlan circular
familyIdstring nullable

::API.Modules.Billings.BillingPlan.FamilyId::

tierinteger

::API.Modules.Billings.BillingPlan.Tier::

isUpgradableboolean

::API.Modules.Billings.BillingPlan.IsUpgradable::

stripeProductIdstring nullable

::API.Modules.Billings.BillingPlan.StripeProductId::

stripePriceIdstring nullable

::API.Modules.Billings.BillingPlan.StripePriceId::

hasFallbackPlanIdboolean

Has fallback plan ID

hasFamilyIdboolean

::API.Modules.Billings.BillingPlan.HasFamilyId::

hasBaseFeeboolean

::API.Modules.Billings.BillingPlan.HasBaseFee::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Billings.BillingPlanFamily.Name::

descriptionstring nullable

::API.Modules.Billings.BillingPlanFamily.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

schoolBillingIdstring required

::API.Modules.Billings.BillingPlanUsage.SchoolBillingId::

planIdstring required

::API.Modules.Billings.BillingPlanUsage.PlanId::

fallbackPlanIdstring required

::API.Modules.Billings.BillingPlanUsage.FallbackPlanId::

invoiceIdstring required

::API.Modules.Billings.BillingPlanUsage.InvoiceId::

fallbackInvoiceIdstring required

::API.Modules.Billings.BillingPlanUsage.FallbackInvoiceId::

fallbackAmountnumber double

::API.Modules.Billings.BillingPlanUsage.FallbackAmount::

feenumber double

::API.Modules.Billings.BillingPlanUsage.Fee::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingPlanUsage.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingPlanUsage.ExchangeRate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

::API.Modules.Billings.BillingPlanUsage.SyncDate::

completedDatestring date-time nullable

::API.Modules.Billings.BillingPlanUsage.CompletedDate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

cardNumberstring required

Card number

externalIdstring nullable

External ID

last4string nullable

Last 4 digits

typestring nullable

Type

expYearinteger nullable

Expiration year

expMonthinteger nullable

Expiration month

gatewayType'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay'

Payment gateway type

settingsJsonstring nullable

Settings JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

requiresActionboolean

::API.Modules.Billings.BillingPaymentMethod.RequiresAction::

requiresActionDatestring date-time nullable

::API.Modules.Billings.BillingPaymentMethod.RequiresActionDate::

adminIdstring nullable

Admin ID

addressIdstring nullable

Address ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

reasonMessagestring nullable

::API.Modules.Billings.BillingTransaction.ReasonMessage::

amountnumber double

::API.Modules.Billings.BillingTransaction.Amount::

bonusAmountnumber double

::API.Modules.Billings.BillingTransaction.BonusAmount::

overdraftAmountnumber double

::API.Modules.Billings.BillingTransaction.OverdraftAmount::

isHiddenboolean

::API.Modules.Billings.BillingTransaction.IsHidden::

isAutopayboolean

::API.Modules.Billings.BillingTransaction.IsAutopay::

gatewayType'yandexCheckout' | 'roboKassa' | 'stripe' | 'payPal' | 'cash' | 'cloudPayments' | 'wireTransfer' | 'newStripe' | 'midtrans' | 'tinkoff' | 'prodamus' | 'sberbank' | 'fondy' | 'squareUp' | 'bePaid' | 'authorizeNet' | 'smartGlocal' | 'bitPay' | 'ecPay' | 'tinkoffInstallment' | 'mercadopago' | 'cyberSource' | 'wayForPay' | 'mobbex' | 'prontoPaga' | 'nmi' | 'cashfree' | 'redsys' | 'payPalV2' | 'dlocalgo' | 'affirm' | 'axlStripe' | 'revolutPay' nullable

::API.Modules.Billings.BillingTransaction.GatewayType::

status'success' | 'fail' | 'pending' | 'cancel'

::API.Modules.Billings.BillingTransaction.Status::

errorMessagestring nullable

::API.Modules.Billings.BillingTransaction.ErrorMessage::

savePaymentMethodboolean

::API.Modules.Billings.BillingTransaction.SavePaymentMethod::

isPaymentMethodTestboolean

::API.Modules.Billings.BillingTransaction.IsPaymentMethodTest::

invoiceIdstring nullable

::API.Modules.Billings.BillingTransaction.InvoiceId::

managerIdstring nullable

::API.Modules.Billings.BillingTransaction.ManagerId::

externalIdstring nullable

::API.Modules.Billings.BillingTransaction.ExternalId::

externalPayloadstring nullable

::API.Modules.Billings.BillingTransaction.ExternalPayload::

paymentMethodCardJsonstring nullable

::API.Modules.Billings.BillingTransaction.PaymentMethodCardJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingTransaction.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingTransaction.ExchangeRate::

numberinteger

::API.Modules.Billings.BillingTransaction.Number::

billingPlanIdstring nullable

::API.Modules.Billings.BillingTransaction.BillingPlanId::

paymentMethodIdstring nullable

::API.Modules.Billings.BillingTransaction.PaymentMethodId::

addressIdstring nullable

::API.Modules.Billings.BillingTransaction.AddressId::

billingPromoCodeIdstring nullable

::API.Modules.Billings.BillingTransaction.BillingPromoCodeId::

exchangeAmountnumber double

::API.Modules.Billings.BillingTransaction.ExchangeAmount::

exchangeBonusAmountnumber double

::API.Modules.Billings.BillingTransaction.ExchangeBonusAmount::

isSuccessboolean

::API.Modules.Billings.BillingTransaction.IsSuccess::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

from'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingCurrencyExchangeRate.From::

to'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingCurrencyExchangeRate.To::

ratenumber double

::API.Modules.Billings.BillingCurrencyExchangeRate.Rate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Billings.BillingPromoCode.Name::

codestring required

::API.Modules.Billings.BillingPromoCode.Code::

descriptionstring nullable

::API.Modules.Billings.BillingPromoCode.Description::

bonusBalancenumber double

::API.Modules.Billings.BillingPromoCode.BonusBalance::

trialDaysCountinteger

::API.Modules.Billings.BillingPromoCode.TrialDaysCount::

beginDatestring date-time nullable

::API.Modules.Billings.BillingPromoCode.BeginDate::

endDatestring date-time nullable

::API.Modules.Billings.BillingPromoCode.EndDate::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'registration' | 'addFunds'

::API.Modules.Billings.BillingPromoCode.Type::

activationCountinteger

::API.Modules.Billings.BillingPromoCode.ActivationCount::

billingPlanIdstring nullable

::API.Modules.Billings.BillingPromoCode.BillingPlanId::

status'active' | 'inactive' | 'expired' | 'ended'

::API.Modules.Billings.BillingPromoCode.Status::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

companystring nullable

Company

firstNamestring nullable

First name

lastNamestring nullable

Last name

addressstring nullable

Address

statestring nullable

State

countrystring nullable

Country

citystring nullable

City

zipCodestring nullable

ZIP code

notestring nullable

Note

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

monthinteger

::API.Modules.Billings.BillingInvoice.Month::

yearinteger

::API.Modules.Billings.BillingInvoice.Year::

periodStartstring date-time nullable

::API.Modules.Billings.BillingInvoice.PeriodStart::

periodEndExclusivestring date-time nullable

::API.Modules.Billings.BillingInvoice.PeriodEndExclusive::

numberstring nullable

::API.Modules.Billings.BillingInvoice.Number::

transferredboolean nullable

::API.Modules.Billings.BillingInvoice.Transferred::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fallbackIdstring nullable

::API.Modules.Billings.BillingInvoice.FallbackId::

fallbackAccelModelProjectModulesBillingsBillingInvoice circular
amountnumber double

::API.Modules.Billings.BillingInvoice.Amount::

correctionToMinimumExpensesAmountnumber double

::API.Modules.Billings.BillingInvoice.CorrectionToMinimumExpensesAmount::

trialPeriodBonusAmountnumber double

::API.Modules.Billings.BillingInvoice.TrialPeriodBonusAmount::

baseFeeAmountnumber double

::API.Modules.Billings.BillingInvoice.BaseFeeAmount::

aiBonusCoveredAmountnumber double

::API.Modules.Billings.BillingInvoice.AiBonusCoveredAmount::

discountOnMainServicesnumber double

::API.Modules.Billings.BillingInvoice.DiscountOnMainServices::

discountOnExtraServicesnumber double

::API.Modules.Billings.BillingInvoice.DiscountOnExtraServices::

exchangeCurrency'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Billings.BillingInvoice.ExchangeCurrency::

exchangeRatenumber double nullable

::API.Modules.Billings.BillingInvoice.ExchangeRate::

isClosedboolean

::API.Modules.Billings.BillingInvoice.IsClosed::

isFallbackboolean

::API.Modules.Billings.BillingInvoice.IsFallback::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

eventIdstring required

::API.Modules.Billings.AxlStripeEvent.EventId::

eventTypestring nullable

::API.Modules.Billings.AxlStripeEvent.EventType::

schoolIdstring nullable

::API.Modules.Billings.AxlStripeEvent.SchoolId::

createdDatestring date-time

Creation date

processedDatestring date-time nullable

::API.Modules.Billings.AxlStripeEvent.ProcessedDate::

errorMessagestring nullable

::API.Modules.Billings.AxlStripeEvent.ErrorMessage::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

eventKeystring required

::API.Modules.Marketing.MarketingConversion.EventKey::

kindstring required

::API.Modules.Marketing.MarketingConversion.Kind::

occurredDatestring date-time

::API.Modules.Marketing.MarketingConversion.OccurredDate::

createdDatestring date-time

Creation date

payloadJsonstring required

::API.Modules.Marketing.MarketingConversion.PayloadJson::

statestring required

::API.Modules.Marketing.MarketingConversion.State::

attemptsinteger

::API.Modules.Marketing.MarketingConversion.Attempts::

nextAttemptDatestring date-time

::API.Modules.Marketing.MarketingConversion.NextAttemptDate::

leaseTokenstring nullable

::API.Modules.Marketing.MarketingConversion.LeaseToken::

leaseUntilstring date-time nullable

::API.Modules.Marketing.MarketingConversion.LeaseUntil::

sentDatestring date-time nullable

::API.Modules.Marketing.MarketingConversion.SentDate::

lastErrorCodestring nullable

::API.Modules.Marketing.MarketingConversion.LastErrorCode::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

fromBillingPlanIdstring nullable

::API.Modules.Billings.SchoolBillingPlanChange.FromBillingPlanId::

toBillingPlanIdstring required

::API.Modules.Billings.SchoolBillingPlanChange.ToBillingPlanId::

changedDatestring date-time

::API.Modules.Billings.SchoolBillingPlanChange.ChangedDate::

reason'manual' | 'autoUpgrade' | 'initial' | 'scheduledDowngrade'

::API.Modules.Billings.SchoolBillingPlanChange.Reason::

previousPlanRemainderAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.PreviousPlanRemainderAmount::

newPlanRemainderAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.NewPlanRemainderAmount::

immediateChargeAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.ImmediateChargeAmount::

nextFullChargeDatestring date-time

::API.Modules.Billings.SchoolBillingPlanChange.NextFullChargeDate::

nextFullChargeAmountnumber double

::API.Modules.Billings.SchoolBillingPlanChange.NextFullChargeAmount::

transactionIdstring nullable

::API.Modules.Billings.SchoolBillingPlanChange.TransactionId::

createdDatestring date-time

Creation date

isUpgradeboolean

::API.Modules.Billings.SchoolBillingPlanChange.IsUpgrade::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

::API.Modules.UserNotifications.UserNotification.Type::

createdDatestring date-time

Creation date

seenDatestring date-time nullable

::API.Modules.UserNotifications.UserNotification.SeenDate::

textstring nullable

::API.Modules.UserNotifications.UserNotification.Text::

payloadJsonstring nullable

::API.Modules.UserNotifications.UserNotification.PayloadJson::

subscriberAdminIdstring nullable

::API.Modules.UserNotifications.UserNotification.SubscriberAdminId::

subscriberStudentIdstring nullable

::API.Modules.UserNotifications.UserNotification.SubscriberStudentId::

adminIdstring nullable

::API.Modules.UserNotifications.UserNotification.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotification.StudentId::

adminTaskIdstring nullable

::API.Modules.UserNotifications.UserNotification.AdminTaskId::

courseIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseId::

libraryIdstring nullable

::API.Modules.UserNotifications.UserNotification.LibraryId::

schoolContentItemCommentIdstring nullable

::API.Modules.UserNotifications.UserNotification.SchoolContentItemCommentId::

schoolContentItemProgressRatingIdstring nullable

::API.Modules.UserNotifications.UserNotification.SchoolContentItemProgressRatingId::

libraryItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.LibraryItemId::

courseItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseItemId::

courseItemTaskIdstring nullable

::API.Modules.UserNotifications.UserNotification.CourseItemTaskId::

orderIdstring nullable

::API.Modules.UserNotifications.UserNotification.OrderId::

orderPaymentIdstring nullable

::API.Modules.UserNotifications.UserNotification.OrderPaymentId::

pipelineItemIdstring nullable

::API.Modules.UserNotifications.UserNotification.PipelineItemId::

scenarioIdstring nullable

::API.Modules.UserNotifications.UserNotification.ScenarioId::

chatChannelIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatChannelId::

chatConversationIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatConversationId::

studentBonusTransactionIdstring nullable

::API.Modules.UserNotifications.UserNotification.StudentBonusTransactionId::

partnershipTransactionIdstring nullable

::API.Modules.UserNotifications.UserNotification.PartnershipTransactionId::

partnershipTransactionRequestIdstring nullable

::API.Modules.UserNotifications.UserNotification.PartnershipTransactionRequestId::

chatMessageIdstring nullable

::API.Modules.UserNotifications.UserNotification.ChatMessageId::

emailMessageIdstring nullable

::API.Modules.UserNotifications.UserNotification.EmailMessageId::

communityPostIdstring nullable

::API.Modules.UserNotifications.UserNotification.CommunityPostId::

communityCommentIdstring nullable

::API.Modules.UserNotifications.UserNotification.CommunityCommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'individual' | 'global'

Type

notificationType'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

Notification type

createdDatestring date-time

Creation date

subscriberAdminIdstring nullable

Subscriber admin ID

subscriberStudentIdstring nullable

Subscriber user ID

adminIdstring nullable

Admin ID

studentIdstring nullable

Contact ID

adminTaskIdstring nullable

Task ID

pipelineItemIdstring nullable

Deal ID

hasSubscriberAdminIdboolean

Whether a subscriber admin ID is set.

hasSubscriberStudentIdboolean

Whether a subscriber user ID is set.

hasSubscriberIdboolean

Whether a subscriber ID is set.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.StudentId::

emailstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.Email::

customEmailstring nullable

::API.Modules.UserNotifications.UserNotificationSettings.CustomEmail::

telegramIdinteger nullable

::API.Modules.UserNotifications.UserNotificationSettings.TelegramId::

useEmailboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseEmail::

useTelegramboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseTelegram::

useWebPushboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseWebPush::

useSmsboolean

::API.Modules.UserNotifications.UserNotificationSettings.UseSms::

canUseEmailboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseEmail::

canUseTgboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseTg::

canUseSmsboolean

::API.Modules.UserNotifications.UserNotificationSettings.CanUseSms::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

useSiteboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseSite::

useEmailboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseEmail::

useTgboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseTg::

useWebPushboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseWebPush::

useSmsboolean

::API.Modules.UserNotifications.UserNotificationChannel.UseSms::

notificationType'courseTaskAnswer' | 'orderPayment' | 'adminTaskStatus' | 'courseTaskAnswerStatus' | 'customNotification' | 'passwordChanged' | 'courseTaskComment' | 'adminTaskCreated' | 'pipelineDealCreated' | 'pipelineDealCompleted' | 'accountLoginSuccess' | 'accountLoginPrevented' | 'courseItemComment' | 'adminEmailConfirmed' | 'studentEmailConfirmed' | 'adminTaskReminder' | 'receivedNewEmailMessage' | 'receivedNewChatMessage' | 'libraryItemComment' | 'adminPartnershipTransactionRequest' | 'studentPartnershipTransaction' | 'studentPartnershipRegistration' | 'studentBonusTransaction' | 'order' | 'communityPostComment' | 'communityCommentReply' | 'meetingBookingCreated' | 'meetingBookingCancelled' | 'meetingBookingRescheduled' | 'meetingBookingOutcomeCheck'

::API.Modules.UserNotifications.UserNotificationChannel.NotificationType::

adminIdstring nullable

::API.Modules.UserNotifications.UserNotificationChannel.AdminId::

studentIdstring nullable

::API.Modules.UserNotifications.UserNotificationChannel.StudentId::

hasAdminIdboolean

::API.Modules.UserNotifications.UserNotificationChannel.HasAdminId::

hasStudentIdboolean

::API.Modules.UserNotifications.UserNotificationChannel.HasStudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

datestring date-time

::API.Modules.Others.CurrencyExchangeRate.Date::

from'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Others.CurrencyExchangeRate.From::

to'usd' | 'eur' | 'rub' | 'idr' | 'uah' | 'gbp' | 'pln' | 'byn' | 'kzt' | 'twd' | 'try' | 'ars' | 'aud' | 'bgn' | 'brl' | 'clp' | 'cop' | 'mxn' | 'pen' | 'uyu' | 'myr' | 'cad' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'bsd' | 'btn' | 'bwp' | 'byr' | 'bzd' | 'cdf' | 'chf' | 'clf' | 'cny' | 'cou' | 'crc' | 'csk' | 'cuc' | 'cup' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gwp' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pgk' | 'php' | 'pkr' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'ssp' | 'std' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'ttd' | 'tzs' | 'ugx' | 'uzs' | 'vef' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwl' | 'mru' | 'stn'

::API.Modules.Others.CurrencyExchangeRate.To::

ratenumber double

::API.Modules.Others.CurrencyExchangeRate.Rate::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

settingsJsonstring nullable

Settings in JSON format

additionalHtmlstring nullable

Additional HTML

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

snapshotDatestring date-time nullable

Snapshot date

sentCountinteger

Number of submissions

isPublishedboolean

Published

snapshotIdstring nullable

Snapshot ID

aiDialogIdstring nullable

::API.Modules.Quizzes.Quiz.AiDialogId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

descriptionstring nullable

Description

settingsJsonstring nullable

Settings in JSON format

positioninteger

Position

type'textField' | 'textArea' | 'number' | 'phone' | 'email' | 'url' | 'checkbox' | 'dropdownList' | 'multiSelect' | 'monoSelect' | 'hiddenField' | 'rating' | 'uploadFile' | 'dateTime' | 'slider' | 'header' | 'paragraph' | 'separator' | 'indent' | 'picture' | 'video' | 'socialButton' | 'nameField'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pageIdstring required

Page ID

leadAttributeIdstring nullable

Lead attribute ID

systemLeadAttribute'email' | 'phone' | 'firstName' | 'lastName' | 'middleName' | 'city' | 'country' | 'comment' | 'birthday' | 'gender' | 'fullName' | 'region' nullable

System lead attribute

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

positioninteger

Position

settingsJsonstring nullable

Settings in JSON format

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

quizIdstring required

Quiz ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

quizIdstring required

::API.Modules.Quizzes.QuizSnapshot.QuizId::

transferredboolean nullable

::API.Modules.Quizzes.QuizSnapshot.Transferred::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

descriptionstring nullable

Description

type'crm'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivitystring date-time nullable

Last activity

stageCountinteger

Number of stages

itemCountinteger

Number of deals

autocompleteDealAfterCompleteOrdersboolean

Automatically complete deals when their orders are completed

removeTasksAfterCompleteDealboolean

Delete tasks when a deal is completed

designSettingsJsonstring nullable

::API.Modules.Pipelines.Pipeline.DesignSettingsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

colorstring nullable

Color

type'custom' | 'crmCompleted' | 'crmNotCompleted'

Type

positioninteger

Position

lexorankPositionstring nullable

LexoRank position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

itemCountinteger

Number of deals

inArchiveboolean

Archived

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

positioninteger

Position

dealAmountnumber double

Deal amount

revenuenumber double

Revenue

outdatedboolean

Has overdue tasks

inArchiveboolean

Archived

lexorankPositionstring nullable

LexoRank position

orderCountinteger

Number of orders

adminTaskCountinteger

Number of tasks

numberinteger

Deal number

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

completedDatestring date-time nullable

Date the deal was completed

takenDatestring date-time nullable

::API.Modules.Pipelines.PipelineItem.TakenDate::

firstUTMSourcestring nullable

First UTM source

firstUTMMediumstring nullable

First UTM medium

firstUTMCampaignstring nullable

First UTM campaign

firstUTMTermstring nullable

First UTM term

firstUTMContentstring nullable

First UTM content

lastUTMSourcestring nullable

Last UTM source

lastUTMMediumstring nullable

Last UTM medium

lastUTMCampaignstring nullable

Last UTM campaign

lastUTMTermstring nullable

Last UTM term

lastUTMContentstring nullable

Last UTM content

autoArchivedboolean nullable

Archived automatically

pipelineIdstring required

Pipeline ID

stageIdstring required

Stage ID

contactIdstring nullable

Contact ID

responsibleIdstring nullable

Owner ID

webinarIdstring nullable

Webinar ID

siteIdstring nullable

Website ID

sitePageIdstring nullable

Website page ID

sitePageVariationTestIdstring nullable

::API.Modules.Pipelines.PipelineItem.SitePageVariationTestId::

sitePageVariationIdstring nullable

::API.Modules.Pipelines.PipelineItem.SitePageVariationId::

widgetIdstring nullable

Widget ID

chatBotIdstring nullable

Chatbot ID

quizIdstring nullable

Quiz ID

broadcastIdstring nullable

Broadcast ID

adminIdstring nullable

Admin ID

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

flowIdstring nullable

Cohort ID

productIdstring nullable

Product ID

scenarioIdstring nullable

::API.Modules.Pipelines.PipelineItem.ScenarioId::

scenarioNodeIdstring nullable

::API.Modules.Pipelines.PipelineItem.ScenarioNodeId::

emailMessageIdstring nullable

Email message ID

hasContactIdboolean

Has contact ID

hasResponsibleIdboolean

Has owner ID

hasAdminTasksboolean

Has tasks

isCompletedboolean

Completed

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

colorstring nullable

Color

positioninteger

Position

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

itemIdstring required

Deal ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

Name

keystring nullable

Key

additionalDatastring nullable

Additional data

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

Type

positioninteger

Position

requiredboolean

Required

visibleboolean

Visible

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pipelineIdstring required

Pipeline ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

String value

valueNumericnumber double nullable

Numeric value

valueBooleanboolean nullable

Boolean value

valueDateTimestring date-time nullable

Date and time value

valueDatestring date-time nullable

Date value

valueListstring nullable

List value

valueMultiListstring nullable

Multi-select value

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

itemIdstring required

Deal ID

fieldIdstring required

Field ID

hasValueListboolean

Has list value

hasValueMultiListboolean

Has multi-select value

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

stageIdstring required

Stage ID

fieldIdstring required

Field ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.SharedSettings.SharedSettingsExport.Name::

descriptionstring nullable

::API.Modules.SharedSettings.SharedSettingsExport.Description::

accessType'free' | 'contact'

::API.Modules.SharedSettings.SharedSettingsExport.AccessType::

reexportProhibitedboolean

::API.Modules.SharedSettings.SharedSettingsExport.ReexportProhibited::

contactFilterJsonstring nullable

::API.Modules.SharedSettings.SharedSettingsExport.ContactFilterJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.SharedSettings.SharedSettingsExport.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage'

::API.Modules.SharedSettings.SharedSettingsExportEntity.Type::

createdDatestring date-time

Creation date

exportIdstring required

::API.Modules.SharedSettings.SharedSettingsExportEntity.ExportId::

sitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsExportEntity.SitePageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

status'created' | 'processing' | 'completed' | 'error'

::API.Modules.SharedSettings.SharedSettingsImport.Status::

errorMsgstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.ErrorMsg::

emailstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.Email::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

exportIdstring required

::API.Modules.SharedSettings.SharedSettingsImport.ExportId::

createdByAdminIdstring required

::API.Modules.SharedSettings.SharedSettingsImport.CreatedByAdminId::

siteIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImport.SiteId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage'

::API.Modules.SharedSettings.SharedSettingsImportEntity.Type::

createdDatestring date-time

Creation date

importIdstring required

::API.Modules.SharedSettings.SharedSettingsImportEntity.ImportId::

sitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportEntity.SitePageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'sitePage' | 'siteComponent' | 'file' | 'fileManagerItem'

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.Type::

fromSitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromSitePageId::

toSitePageIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToSitePageId::

fromSiteComponentIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromSiteComponentId::

toSiteComponentIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToSiteComponentId::

fromFileIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromFileId::

toFileIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToFileId::

fromFileManagerItemIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.FromFileManagerItemId::

toFileManagerItemIdstring nullable

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ToFileManagerItemId::

importIdstring required

::API.Modules.SharedSettings.SharedSettingsImportMappedEntity.ImportId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring required

Title

descriptionstring nullable

Description

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

wordsJsonstring nullable

Words JSON

wordsCountinteger

Word count

wordsstring[] nullable

Words

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

glossaryIdstring required

Glossary ID

webinarIdstring nullable

Webinar ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

keystring required

::API.Modules.GlobalVariables.GlobalVariable.Key::

valuestring required

::API.Modules.GlobalVariables.GlobalVariable.Value::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.GlobalVariables.GlobalVariable.CreatedByAdminId::

updatedByAdminIdstring nullable

::API.Modules.GlobalVariables.GlobalVariable.UpdatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

Title

shortDescriptionstring nullable

Short description

descriptionstring nullable

Description

pricingJsonstring nullable

Pricing JSON

settingsJsonstring nullable

Settings JSON

enabledboolean

Enabled

type'custom' | 'telegramGroups' | 'metaConversions' | 'yandexMetrika' | 'googleAnalytics' | 'facebookForms' | 'googleMeet' | 'zoom' | 'aiCurator' | 'aiAssistant' | 'retell'

Type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

titlestring nullable

Title

type'custom' | 'telegramGroups' | 'metaConversions' | 'yandexMetrika' | 'googleAnalytics' | 'facebookForms' | 'googleMeet' | 'zoom' | 'aiCurator' | 'aiAssistant' | 'retell'

Type

settingsJsonstring nullable

Settings JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

applicationIdstring required

App ID

oAuthTokenIdstring nullable

::API.Modules.Applications.ApplicationSchoolLink.OAuthTokenId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

schoolLinkIdstring required

Account link ID

siteIdstring nullable

Website ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

External ID

externalNamestring nullable

External name

excludeNonExistingUsersboolean

Exclude nonexistent users

type'group' | 'channel'

Type

namestring required

Name

keyPhrasestring required

Key phrase

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

Sync date

ownerIdstring nullable

Owner ID

schoolLinkIdstring required

Account link ID

imageIdstring nullable

Image ID

status'connecting' | 'connected'

Status

descriptionstring nullable

Description

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

state'requested' | 'invited' | 'approved' | 'rejected' | 'left' | 'removed' | 'banned'

State

reasonstring nullable

Reason

isBotboolean

Is a bot

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

addedDatestring date-time nullable

Date added

syncDatestring date-time nullable

Sync date

groupIdstring required

Group ID

studentCommunicationIdstring required

Contact channel ID

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.Applications.FacebookForm.ExternalId::

externalNamestring nullable

::API.Modules.Applications.FacebookForm.ExternalName::

fieldsJsonstring nullable

::API.Modules.Applications.FacebookForm.FieldsJson::

utmFieldsJsonstring nullable

::API.Modules.Applications.FacebookForm.UtmFieldsJson::

namestring required

::API.Modules.Applications.FacebookForm.Name::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

syncDatestring date-time nullable

::API.Modules.Applications.FacebookForm.SyncDate::

schoolLinkIdstring required

::API.Modules.Applications.FacebookForm.SchoolLinkId::

descriptionstring nullable

::API.Modules.Applications.FacebookForm.Description::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

answersJsonstring nullable

::API.Modules.Applications.FacebookFormLead.AnswersJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

addedDatestring date-time nullable

::API.Modules.Applications.FacebookFormLead.AddedDate::

formIdstring required

::API.Modules.Applications.FacebookFormLead.FormId::

studentCommunicationIdstring required

::API.Modules.Applications.FacebookFormLead.StudentCommunicationId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'assistant' | 'curator' | 'voice'

::API.Modules.AiAgents.AiAgent.Type::

namestring required

::API.Modules.AiAgents.AiAgent.Name::

descriptionstring nullable

::API.Modules.AiAgents.AiAgent.Description::

ownerAdminIdstring nullable

::API.Modules.AiAgents.AiAgent.OwnerAdminId::

enabledboolean

::API.Modules.AiAgents.AiAgent.Enabled::

settingsJsonstring nullable

::API.Modules.AiAgents.AiAgent.SettingsJson::

vectorStoreIdstring nullable

::API.Modules.AiAgents.AiAgent.VectorStoreId::

state'registering' | 'registered' | 'unregistered' | 'error' | 'pending'

::API.Modules.AiAgents.AiAgent.State::

errorstring nullable

::API.Modules.AiAgents.AiAgent.Error::

hasFileSyncedboolean

::API.Modules.AiAgents.AiAgent.HasFileSynced::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

studentIdstring required

::API.Modules.LeadScoring.LeadScore.StudentId::

stage'm15' | 'h1' | 'h3' | 'h24' | 'd1' | 'd2' | 'd3' | 'd5' | 'd7' | 'd10' | 'd14' | 'e1' | 'e2' | 'e3' | 'e4' | 'e5' | 'e6' | 'e7' | 'e8' | 'e9' | 'e10' | 'e11' | 'e12' | 'e13' | 'e14'

::API.Modules.LeadScoring.LeadScore.Stage::

mode'shadow' | 'live'

::API.Modules.LeadScoring.LeadScore.Mode::

contactCreatedDatestring date-time

::API.Modules.LeadScoring.LeadScore.ContactCreatedDate::

probabilitynumber double

::API.Modules.LeadScoring.LeadScore.Probability::

ruleScorenumber double

::API.Modules.LeadScoring.LeadScore.RuleScore::

percentileinteger nullable

::API.Modules.LeadScoring.LeadScore.Percentile::

tier'none' | 'cold' | 'warm' | 'hot'

::API.Modules.LeadScoring.LeadScore.Tier::

liftnumber double nullable

::API.Modules.LeadScoring.LeadScore.Lift::

modelTrustedboolean nullable

::API.Modules.LeadScoring.LeadScore.ModelTrusted::

reasonsJsonstring nullable

::API.Modules.LeadScoring.LeadScore.ReasonsJson::

modelVersionstring nullable

::API.Modules.LeadScoring.LeadScore.ModelVersion::

originSourcestring nullable

::API.Modules.LeadScoring.LeadScore.OriginSource::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

provider'latitude'

::API.Modules.Live.LiveMachine.Provider::

providerServerIdstring nullable

::API.Modules.Live.LiveMachine.ProviderServerId::

planstring nullable

::API.Modules.Live.LiveMachine.Plan::

sitestring nullable

::API.Modules.Live.LiveMachine.Site::

region'us' | 'latam' | 'eu'

::API.Modules.Live.LiveMachine.Region::

hostnamestring nullable

::API.Modules.Live.LiveMachine.Hostname::

ipv4string nullable

::API.Modules.Live.LiveMachine.Ipv4::

status'requested' | 'provisioning' | 'booting' | 'ready' | 'draining' | 'deleted' | 'failed'

::API.Modules.Live.LiveMachine.Status::

capacityinteger

::API.Modules.Live.LiveMachine.Capacity::

hourlyPriceUsdnumber double

::API.Modules.Live.LiveMachine.HourlyPriceUsd::

userDataIdstring nullable

::API.Modules.Live.LiveMachine.UserDataId::

dnsRecordCreatedboolean

::API.Modules.Live.LiveMachine.DnsRecordCreated::

createdDatestring date-time

Creation date

provisionedDatestring date-time nullable

::API.Modules.Live.LiveMachine.ProvisionedDate::

serverOnDatestring date-time nullable

::API.Modules.Live.LiveMachine.ServerOnDate::

readyDatestring date-time nullable

::API.Modules.Live.LiveMachine.ReadyDate::

lastSampleDatestring date-time nullable

::API.Modules.Live.LiveMachine.LastSampleDate::

idleSinceDatestring date-time nullable

::API.Modules.Live.LiveMachine.IdleSinceDate::

deletedDatestring date-time nullable

::API.Modules.Live.LiveMachine.DeletedDate::

bootStepstring nullable

::API.Modules.Live.LiveMachine.BootStep::

errorstring nullable

::API.Modules.Live.LiveMachine.Error::

readyInfoJsonstring nullable

::API.Modules.Live.LiveMachine.ReadyInfoJson::

currentParticipantsinteger

::API.Modules.Live.LiveMachine.CurrentParticipants::

pressurenumber double

::API.Modules.Live.LiveMachine.Pressure::

isActiveboolean

::API.Modules.Live.LiveMachine.IsActive::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

webinarIdstring required

::API.Modules.Live.LiveRun.WebinarId::

webinarContentIdstring required

::API.Modules.Live.LiveRun.WebinarContentId::

machineIdstring nullable

::API.Modules.Live.LiveRun.MachineId::

region'us' | 'latam' | 'eu'

::API.Modules.Live.LiveRun.Region::

roomNamestring nullable

::API.Modules.Live.LiveRun.RoomName::

status'pending' | 'ready' | 'live' | 'ended' | 'failed'

::API.Modules.Live.LiveRun.Status::

expectedViewersinteger

::API.Modules.Live.LiveRun.ExpectedViewers::

requestedBystring nullable

::API.Modules.Live.LiveRun.RequestedBy::

createdDatestring date-time

Creation date

readyDatestring date-time nullable

::API.Modules.Live.LiveRun.ReadyDate::

liveStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.LiveStartedDate::

lastPublishDatestring date-time nullable

::API.Modules.Live.LiveRun.LastPublishDate::

endRequestedDatestring date-time nullable

::API.Modules.Live.LiveRun.EndRequestedDate::

endedDatestring date-time nullable

::API.Modules.Live.LiveRun.EndedDate::

ingressIdstring nullable

::API.Modules.Live.LiveRun.IngressId::

ingressUrlstring nullable

::API.Modules.Live.LiveRun.IngressUrl::

ingressStreamKeystring nullable

::API.Modules.Live.LiveRun.IngressStreamKey::

egressIdstring nullable

::API.Modules.Live.LiveRun.EgressId::

recordingStatus'none' | 'starting' | 'recording' | 'stopping' | 'uploaded' | 'imported' | 'failed'

::API.Modules.Live.LiveRun.RecordingStatus::

recordingFileIdstring nullable

::API.Modules.Live.LiveRun.RecordingFileId::

recordingVideoIdstring nullable

::API.Modules.Live.LiveRun.RecordingVideoId::

recordingStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.RecordingStartedDate::

recordingSizeinteger nullable

::API.Modules.Live.LiveRun.RecordingSize::

recordingDurationSecnumber double nullable

::API.Modules.Live.LiveRun.RecordingDurationSec::

recordingErrorstring nullable

::API.Modules.Live.LiveRun.RecordingError::

hlsLowEgressIdstring nullable

::API.Modules.Live.LiveRun.HlsLowEgressId::

hlsStatus'none' | 'starting' | 'live' | 'stopped' | 'failed' | 'purged'

::API.Modules.Live.LiveRun.HlsStatus::

hlsStartedDatestring date-time nullable

::API.Modules.Live.LiveRun.HlsStartedDate::

currentHlsViewersinteger

::API.Modules.Live.LiveRun.CurrentHlsViewers::

peakHlsViewersinteger

::API.Modules.Live.LiveRun.PeakHlsViewers::

layoutstring nullable

::API.Modules.Live.LiveRun.Layout::

simulcastEgressIdstring nullable

::API.Modules.Live.LiveRun.SimulcastEgressId::

simulcastTargetsstring nullable

::API.Modules.Live.LiveRun.SimulcastTargets::

simulcastStatusstring nullable

::API.Modules.Live.LiveRun.SimulcastStatus::

currentViewersinteger

::API.Modules.Live.LiveRun.CurrentViewers::

peakViewersinteger

::API.Modules.Live.LiveRun.PeakViewers::

publishersinteger

::API.Modules.Live.LiveRun.Publishers::

errorstring nullable

::API.Modules.Live.LiveRun.Error::

isActiveboolean

::API.Modules.Live.LiveRun.IsActive::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

machineIdstring nullable

::API.Modules.Live.LiveEvent.MachineId::

runIdstring nullable

::API.Modules.Live.LiveEvent.RunId::

schoolIdstring nullable

::API.Modules.Live.LiveEvent.SchoolId::

webinarIdstring nullable

::API.Modules.Live.LiveEvent.WebinarId::

level'info' | 'warning' | 'error'

::API.Modules.Live.LiveEvent.Level::

typestring required

::API.Modules.Live.LiveEvent.Type::

messagestring nullable

::API.Modules.Live.LiveEvent.Message::

dataJsonstring nullable

::API.Modules.Live.LiveEvent.DataJson::

sourcestring nullable

::API.Modules.Live.LiveEvent.Source::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

machineIdstring required

::API.Modules.Live.LiveMachineSample.MachineId::

createdDatestring date-time

Creation date

cpuPercentnumber double

::API.Modules.Live.LiveMachineSample.CpuPercent::

load1number double

::API.Modules.Live.LiveMachineSample.Load1::

memUsedMbinteger

::API.Modules.Live.LiveMachineSample.MemUsedMb::

memTotalMbinteger

::API.Modules.Live.LiveMachineSample.MemTotalMb::

txMbpsnumber double

::API.Modules.Live.LiveMachineSample.TxMbps::

rxMbpsnumber double

::API.Modules.Live.LiveMachineSample.RxMbps::

txPpsinteger

::API.Modules.Live.LiveMachineSample.TxPps::

rxPpsinteger

::API.Modules.Live.LiveMachineSample.RxPps::

udpErrorsinteger

::API.Modules.Live.LiveMachineSample.UdpErrors::

roomsinteger

::API.Modules.Live.LiveMachineSample.Rooms::

participantsinteger

::API.Modules.Live.LiveMachineSample.Participants::

publishersinteger

::API.Modules.Live.LiveMachineSample.Publishers::

ingressesinteger

::API.Modules.Live.LiveMachineSample.Ingresses::

egressesinteger

::API.Modules.Live.LiveMachineSample.Egresses::

roomsJsonstring nullable

::API.Modules.Live.LiveMachineSample.RoomsJson::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Active

agreementRequiredboolean

Agreement required

agreementTextstring nullable

Agreement text

agreementUrlstring nullable

Agreement URL

partnerAssigningCookieDurationDaysinteger

Referral cookie lifetime, in days

partnerAssigningDurationType'endless' | 'days'

Attribution period type

partnerAssigningDurationDaysinteger

Number of days a contact stays attributed to the affiliate

transferBonusPartnerboolean

Credit the affiliate's bonus account

transferBonusPartnerAmountnumber double

Amount credited to the affiliate's bonus account

transferBonusReferralboolean

Credit the bonus account of the contact (referral)

transferBonusReferralAmountnumber double

Amount credited to the bonus account of the contact (referral)

transferFeeMethod'referral' | 'partner'

Commission transfer method

transferFeeAllowedboolean

Allow commission withdrawals

transferFeeMinAmountnumber double

Minimum withdrawal amount

transferFeeAllowedToBonusboolean

Allow commission transfers to the bonus account

transferFeeHoldingPeriodDaysinteger

Holding period, in days, before commissions become available for withdrawal

partnershipVisibleboolean

Show the affiliate dashboard in the Student Portal

partnershipPaidOrdersVisibleboolean

Show affiliates their order list

partnershipAllOrdersVisibleboolean

Show created and unpaid orders

partnershipOrdersContactVisibleboolean

Show contact details of referred buyers

partnershipCommissionDetailsVisibleboolean

Show commission breakdown

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

activatedDatestring date-time nullable

Activation date

paymentGatewayFeeEnabledboolean

Account for payment gateway fees in commission calculations

deductionEnabledboolean

Account for deductions in commission calculations

levelCountinteger

Number of levels

partnershipVisibleToGroupIdstring nullable

Show the affiliate dashboard only to contacts in this group

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'deposit' | 'withdrawal'

Type

amountnumber double

Amount

feenumber double

Commission

deductionnumber double

Deduction

commentstring nullable

Comment

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

validAfterDatestring date-time nullable

Date after which the transaction becomes valid

useBonusboolean

Bonuses used

levelinteger nullable

Level

levelPartnerIdstring nullable

ID of the affiliate at this commission level

partnerIdstring required

Affiliate ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

orderIdstring nullable

Order ID

requestIdstring nullable

Withdrawal request ID

scenarioNodeIdstring nullable

Automation step ID

studentCreatorIdstring nullable

ID of the contact who created the transaction

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

amountnumber double

Amount

partnerCommentstring nullable

Affiliate comment

adminCommentstring nullable

Admin comment

status'requested' | 'approved' | 'declined'

Status

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

partnerIdstring required

Affiliate ID

adminIdstring nullable

Admin ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring required

Name

descriptionstring nullable

Description

isActiveboolean

Active

feeType'percent' | 'value'

Commission type

productType'all' | 'selected' | 'categories'

Product type

partnerType'all' | 'selected' | 'group'

Affiliate type

purchaseType'any' | 'first' | 'repeat'

Purchase type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

levelsJsonstring nullable

Levels as JSON

urlsJsonstring nullable

URLs as JSON

levelsnumber[] nullable

Levels

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

partnerIdstring required

Affiliate ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

groupIdstring required

Group ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

Offer ID

productIdstring required

Product ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

offerIdstring required

::API.Modules.Partnerships.PartnershipOfferProductCategoryLink.OfferId::

categoryIdstring required

::API.Modules.Partnerships.PartnershipOfferProductCategoryLink.CategoryId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isActiveboolean

Active

codestring required

Code

navigationCountinteger

Number of referral link clicks

registrationCountinteger

Number of sign-ups

amountnumber double

Amount

feenumber double

Commission

availableFeenumber double

Available commission

createdDatestring date-time

Creation date

acceptedDatestring date-time nullable

Acceptance date

studentIdstring required

Contact ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

serialNumberstring nullable

Series

nextNumberinteger

Next number

settingsJsonstring nullable

Settings JSON

releasedCountinteger

Number of certificates issued

usePadLeftboolean

Use fixed number length

padLeftLengthinteger

Fixed number length

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'text' | 'image'

Type

subTypestring nullable

Subtype

valuestring nullable

Value

zIndexinteger

z-index

settingsJsonstring nullable

Settings JSON

metaJsonstring nullable

Metadata JSON

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

certIdstring required

Certificate ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

numberstring required

Certificate number

createdDatestring date-time

Creation date

contactIdstring required

Contact ID

certIdstring required

Certificate ID

imageIdstring required

Image ID

courseIdstring nullable

Course ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Announcements.Tables.Announcement.Name::

textstring required

::API.Modules.Announcements.Tables.Announcement.Text::

lang'ru' | 'en' | 'id' | 'uk' | 'es' | 'zhtw' | 'zhcn' | 'lt' | 'pt'

::API.Modules.Announcements.Tables.Announcement.Lang::

isPublishedboolean

::API.Modules.Announcements.Tables.Announcement.IsPublished::

showOnlyForMigratedSchoolboolean

::API.Modules.Announcements.Tables.Announcement.ShowOnlyForMigratedSchool::

isAdminboolean

::API.Modules.Announcements.Tables.Announcement.IsAdmin::

isSchoolboolean

::API.Modules.Announcements.Tables.Announcement.IsSchool::

createdDatestring date-time

Creation date

beginDatestring date-time nullable

::API.Modules.Announcements.Tables.Announcement.BeginDate::

endDatestring date-time

::API.Modules.Announcements.Tables.Announcement.EndDate::

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

adminIdstring nullable

::API.Modules.Announcements.Tables.UserAnnouncement.AdminId::

studentIdstring nullable

::API.Modules.Announcements.Tables.UserAnnouncement.StudentId::

announcementIdstring required

::API.Modules.Announcements.Tables.UserAnnouncement.AnnouncementId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

shopEnabledboolean

Points shop enabled

leaderboardEnabledboolean

Leaderboard enabled

leaderboardTakeCountinteger

Number of entries shown on the leaderboard

leaderboardDurationinteger

Length of the period the leaderboard covers

leaderboardDurationType'day' | 'month' | 'year'

Unit of the leaderboard period: day, month, or year

pointsNamestring nullable

Points name

pointsShortNamestring nullable

Abbreviated points name

pointsExpireDurationinteger

Points validity period

pointsExpireDurationType'day' | 'month' | 'year' | 'endless'

Unit of the points validity period: day, month, year, or unlimited

pointsIconType'system' | 'custom'

Points icon type

pointsIconCloudKeystring nullable

Cloud storage key of the points icon

achievementStyle'one' | 'two' | 'three' | 'four'

Achievement style

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pointsCustomIconIdstring nullable

ID of the custom points icon

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

pointsinteger

Points

titlestring nullable

Title

descriptionstring nullable

Description

type'system' | 'custom'

Type

subtype'student' | 'activeStudent' | 'serialStudent' | 'earlyBird' | 'nightStudent' | 'firstStep' | 'firstTest' | 'firstTask' | 'buyer1' | 'buyer2' | 'buyer3' | 'sprint' | 'halfMarathonRunner' | 'marathonRunner' nullable

Subtype

imageType'system' | 'custom'

Image type

systemImagestring nullable

System image

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

customImageIdstring nullable

ID of the custom image

systemAchievementIdstring nullable

System achievement ID

systemAchievementAccelModelProjectModulesGamificationsGamificationAchievement circular
gamificationIdstring nullable

Gamification ID

gamificationStyle'one' | 'two' | 'three' | 'four' nullable

Gamification style

imageCloudKeystring nullable

Cloud storage key of the image

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

Enabled

titlestring required

Name

descriptionstring nullable

Description

pointsinteger

Points

useAvailableCountboolean

Whether the quantity is limited

availableCountinteger

Quantity available

contentType'noContent' | 'product' | 'bonusBalance'

Content type

bonusAmountnumber double

Bonus amount

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

imageIdstring nullable

Image ID

productIdstring nullable

Product ID

gamificationIdstring required

Gamification ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

pointsinteger

Points

type'deposit' | 'withdrawal'

Type

commentstring nullable

Comment

isManualboolean

Created manually

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expiredDatestring date-time nullable

Expiration date

studentIdstring required

Contact ID

adminCreatorIdstring nullable

ID of the admin who created the transaction

studentAchievementIdstring nullable

ID of the achievement earned by the contact

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library step ID

productIdstring nullable

Product ID

scenarioNodeIdstring nullable

Automation step ID

gamificationIdstring required

Gamification ID

burnedTransactionIdstring nullable

ID of the transaction whose points expired

burnedTransactionAccelModelProjectModulesGamificationsGamificationTransaction circular
burnedPointsinteger nullable

Expired points

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

pointsinteger

Points

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

studentIdstring required

Contact ID

achievementIdstring required

Achievement ID

courseIdstring nullable

Course ID

courseItemIdstring nullable

Course step ID

libraryIdstring nullable

Library ID

libraryItemIdstring nullable

Library step ID

scenarioNodeIdstring nullable

Automation step ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

Name

descriptionstring nullable

Description

textstring nullable

Text

generatedCountinteger

Generated count

isPublicboolean

Public

type'chatQuickReply' | 'taskQuickAnswer'

Type

contentType'normal' | 'voice'

Content type

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

positioninteger

Position

messageTemplateIdstring required

Message template ID

tagIdstring required

Tag ID

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.ManageableFilters.ManageableFilter.Name::

descriptionstring nullable

::API.Modules.ManageableFilters.ManageableFilter.Description::

isPublicboolean

::API.Modules.ManageableFilters.ManageableFilter.IsPublic::

type'order' | 'payment' | 'pipelineItem'

::API.Modules.ManageableFilters.ManageableFilter.Type::

filterJsonstring nullable

::API.Modules.ManageableFilters.ManageableFilter.FilterJson::

orderJsonstring nullable

::API.Modules.ManageableFilters.ManageableFilter.OrderJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

creatorIdstring required

::API.Modules.ManageableFilters.ManageableFilter.CreatorId::

adminIdstring nullable

::API.Modules.ManageableFilters.ManageableFilter.AdminId::

pipelineIdstring nullable

::API.Modules.ManageableFilters.ManageableFilter.PipelineId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.Organizations.Organization.Name::

domainstring required

::API.Modules.Organizations.Organization.Domain::

textAgreementstring nullable

::API.Modules.Organizations.Organization.TextAgreement::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring required

::API.Modules.TeamDepartments.TeamDepartment.Name::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

poststring required

::API.Modules.TeamDepartments.TeamDepartmentMember.Post::

role'employee' | 'manager'

::API.Modules.TeamDepartments.TeamDepartmentMember.Role::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

adminIdstring required

::API.Modules.TeamDepartments.TeamDepartmentMember.AdminId::

teamDepartmentIdstring required

::API.Modules.TeamDepartments.TeamDepartmentMember.TeamDepartmentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

additionalDataJsonstring nullable

::API.Modules.DeletedEntities.DeletedEntity.AdditionalDataJson::

createdDatestring date-time

Creation date

studentIdstring nullable

::API.Modules.DeletedEntities.DeletedEntity.StudentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Dashboards.Dashboard.Title::

descriptionstring nullable

::API.Modules.Dashboards.Dashboard.Description::

privacyType'public' | 'private'

::API.Modules.Dashboards.Dashboard.PrivacyType::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

createdByAdminIdstring required

::API.Modules.Dashboards.Dashboard.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Dashboards.DashboardItem.Title::

type'number' | 'table' | 'chart' | 'pie' | 'text'

::API.Modules.Dashboards.DashboardItem.Type::

settingsJsonstring nullable

::API.Modules.Dashboards.DashboardItem.SettingsJson::

dataSourceType'contact' | 'order' | 'payment' | 'webinarUser' | 'site' | 'adminTask' | 'pipelineDeal' | 'conversion' | 'email' | 'call' | 'custom'

::API.Modules.Dashboards.DashboardItem.DataSourceType::

dataSettingsJsonstring nullable

::API.Modules.Dashboards.DashboardItem.DataSettingsJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

customDataSourceIdstring nullable

::API.Modules.Dashboards.DashboardItem.CustomDataSourceId::

dashboardIdstring required

::API.Modules.Dashboards.DashboardItem.DashboardId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Dashboards.DashboardDataSource.Name::

descriptionstring nullable

::API.Modules.Dashboards.DashboardDataSource.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

type'contact' | 'order' | 'payment' | 'webinarUser' | 'site' | 'adminTask' | 'pipelineDeal' | 'conversion' | 'email' | 'call' | 'custom'

::API.Modules.Dashboards.DashboardDataSource.Type::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Dashboards.DashboardDataSourceField.Name::

keyNamestring nullable

::API.Modules.Dashboards.DashboardDataSourceField.KeyName::

additionalDatastring nullable

::API.Modules.Dashboards.DashboardDataSourceField.AdditionalData::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.Dashboards.DashboardDataSourceField.Type::

positioninteger

::API.Modules.Dashboards.DashboardDataSourceField.Position::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sourceIdstring required

::API.Modules.Dashboards.DashboardDataSourceField.SourceId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

sourceIdstring required

::API.Modules.Dashboards.DashboardDataSourceRow.SourceId::

createdByAdminIdstring required

::API.Modules.Dashboards.DashboardDataSourceRow.CreatedByAdminId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

valueStringstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueString::

valueNumericnumber double nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueNumeric::

valueBooleanboolean nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueBoolean::

valueDateTimestring date-time nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueDateTime::

valueDatestring date-time nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueDate::

valueListstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueList::

valueMultiListstring nullable

::API.Modules.Dashboards.DashboardDataSourceRowValue.ValueMultiList::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

rowIdstring required

::API.Modules.Dashboards.DashboardDataSourceRowValue.RowId::

fieldIdstring required

::API.Modules.Dashboards.DashboardDataSourceRowValue.FieldId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Name::

descriptionstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Description::

detailsstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Details::

type'online' | 'offline'

::API.Modules.EventCalendars.EventCalendarEvent.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

beginDatestring date-time

::API.Modules.EventCalendars.EventCalendarEvent.BeginDate::

endDatestring date-time

::API.Modules.EventCalendars.EventCalendarEvent.EndDate::

duration'min10' | 'min15' | 'min30' | 'hour' | 'hour2' | 'day' | 'custom'

::API.Modules.EventCalendars.EventCalendarEvent.Duration::

timezoneIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.TimezoneId::

urlstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Url::

addressstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.Address::

contactFilterEnabledboolean

::API.Modules.EventCalendars.EventCalendarEvent.ContactFilterEnabled::

contactFilterJsonstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.ContactFilterJson::

creatorByAdminIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.CreatorByAdminId::

webinarIdstring nullable

::API.Modules.EventCalendars.EventCalendarEvent.WebinarId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

eventIdstring required

::API.Modules.EventCalendars.EventCalendarEventMember.EventId::

contactIdstring required

::API.Modules.EventCalendars.EventCalendarEventMember.ContactId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

enabledboolean

::API.Modules.Communities.Tables.Community.Enabled::

popupEnabledboolean

::API.Modules.Communities.Tables.Community.PopupEnabled::

popupTextstring nullable

::API.Modules.Communities.Tables.Community.PopupText::

popupJoinTextstring nullable

::API.Modules.Communities.Tables.Community.PopupJoinText::

sortType'createdDate' | 'likesCount' | 'commentsCount'

::API.Modules.Communities.Tables.Community.SortType::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

popularPostsWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.PopularPostsWidgetEnabled::

popularPostsWidgetSortType'createdDate' | 'likesCount' | 'commentsCount'

::API.Modules.Communities.Tables.Community.PopularPostsWidgetSortType::

calendarWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.CalendarWidgetEnabled::

leaderboardWidgetEnabledboolean

::API.Modules.Communities.Tables.Community.LeaderboardWidgetEnabled::

structureVersionIdstring nullable

::API.Modules.Communities.Tables.Community.StructureVersionId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

contactIdstring nullable

::API.Modules.Communities.Tables.CommunityMember.ContactId::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

lastActivityDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityMember.LastActivityDate::

role'user' | 'moderator'

::API.Modules.Communities.Tables.CommunityMember.Role::

viewRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.ViewRestrictionEnabled::

likesRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.LikesRestrictionEnabled::

commentsRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.CommentsRestrictionEnabled::

publishRestrictionEnabledboolean

::API.Modules.Communities.Tables.CommunityMember.PublishRestrictionEnabled::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Communities.Tables.CommunityBadge.Name::

emojistring nullable

::API.Modules.Communities.Tables.CommunityBadge.Emoji::

descriptionstring nullable

::API.Modules.Communities.Tables.CommunityBadge.Description::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

triggersJsonstring nullable

::API.Modules.Communities.Tables.CommunityBadge.TriggersJson::

imageIdstring nullable

::API.Modules.Communities.Tables.CommunityBadge.ImageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'like' | 'unlike'

::API.Modules.Communities.Tables.CommunityMemberReaction.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberReaction.MemberId::

spaceIdstring required

::API.Modules.Communities.Tables.CommunityMemberReaction.SpaceId::

postIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReaction.PostId::

commentIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReaction.CommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.Text::

type'custom'

::API.Modules.Communities.Tables.CommunityMemberReport.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberReport.MemberId::

postIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.PostId::

commentIdstring nullable

::API.Modules.Communities.Tables.CommunityMemberReport.CommentId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

memberIdstring required

::API.Modules.Communities.Tables.CommunityMemberBadge.MemberId::

badgeIdstring required

::API.Modules.Communities.Tables.CommunityMemberBadge.BadgeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Communities.Tables.CommunityPost.Title::

bodystring nullable

::API.Modules.Communities.Tables.CommunityPost.Body::

status'default' | 'pending' | 'approved' | 'rejected'

::API.Modules.Communities.Tables.CommunityPost.Status::

likesCountinteger

::API.Modules.Communities.Tables.CommunityPost.LikesCount::

commentsCountinteger

::API.Modules.Communities.Tables.CommunityPost.CommentsCount::

viewsCountinteger

::API.Modules.Communities.Tables.CommunityPost.ViewsCount::

reportsCountinteger

::API.Modules.Communities.Tables.CommunityPost.ReportsCount::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

pinDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityPost.PinDate::

lastModerationDatestring date-time nullable

::API.Modules.Communities.Tables.CommunityPost.LastModerationDate::

pinPositioninteger nullable

::API.Modules.Communities.Tables.CommunityPost.PinPosition::

numberinteger

::API.Modules.Communities.Tables.CommunityPost.Number::

spaceIdstring required

::API.Modules.Communities.Tables.CommunityPost.SpaceId::

authorIdstring required

::API.Modules.Communities.Tables.CommunityPost.AuthorId::

isLikedByCurrentUserboolean

::API.Modules.Communities.Tables.CommunityPost.IsLikedByCurrentUser::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.Name::

positioninteger

::API.Modules.Communities.Tables.CommunityPostAttachment.Position::

urlstring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.Url::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

fileIdstring nullable

::API.Modules.Communities.Tables.CommunityPostAttachment.FileId::

postIdstring required

::API.Modules.Communities.Tables.CommunityPostAttachment.PostId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

textstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.Text::

likesCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.LikesCount::

reportsCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.ReportsCount::

childrenCountinteger

::API.Modules.Communities.Tables.CommunityPostComment.ChildrenCount::

status'default' | 'pending' | 'approved' | 'rejected'

::API.Modules.Communities.Tables.CommunityPostComment.Status::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

postIdstring required

::API.Modules.Communities.Tables.CommunityPostComment.PostId::

authorIdstring required

::API.Modules.Communities.Tables.CommunityPostComment.AuthorId::

replyIdstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.ReplyId::

replyAccelModelProjectModulesCommunitiesTablesCommunityPostComment circular
parentIdstring nullable

::API.Modules.Communities.Tables.CommunityPostComment.ParentId::

parentAccelModelProjectModulesCommunitiesTablesCommunityPostComment circular
childrenAccelModelProjectModulesCommunitiesTablesCommunityPostComment[] circular
isLikedByCurrentUserboolean

::API.Modules.Communities.Tables.CommunityPostComment.IsLikedByCurrentUser::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

titlestring nullable

::API.Modules.Communities.Tables.CommunitySpace.Title::

titleEmojistring nullable

::API.Modules.Communities.Tables.CommunitySpace.TitleEmoji::

positioninteger

::API.Modules.Communities.Tables.CommunitySpace.Position::

segmentstring nullable

::API.Modules.Communities.Tables.CommunitySpace.Segment::

showIfNoAccessboolean

::API.Modules.Communities.Tables.CommunitySpace.ShowIfNoAccess::

showPaymentLinkboolean

::API.Modules.Communities.Tables.CommunitySpace.ShowPaymentLink::

paymentUrlstring nullable

::API.Modules.Communities.Tables.CommunitySpace.PaymentUrl::

viewAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.ViewAccessType::

viewAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.ViewAccessExtendedFilterJson::

likesAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.LikesAccessType::

likesAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.LikesAccessExtendedFilterJson::

commentsAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.CommentsAccessType::

commentsAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.CommentsAccessExtendedFilterJson::

publishAccessType'public' | 'filter'

::API.Modules.Communities.Tables.CommunitySpace.PublishAccessType::

publishAccessExtendedFilterJsonstring nullable

::API.Modules.Communities.Tables.CommunitySpace.PublishAccessExtendedFilterJson::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

parentIdstring nullable

::API.Modules.Communities.Tables.CommunitySpace.ParentId::

parentAccelModelProjectModulesCommunitiesTablesCommunitySpace circular
childrenAccelModelProjectModulesCommunitiesTablesCommunitySpace[] circular
idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

externalIdstring nullable

::API.Modules.OAuthTokens.OAuthToken.ExternalId::

redirectUristring nullable

::API.Modules.OAuthTokens.OAuthToken.RedirectUri::

settingsJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.SettingsJson::

tokenJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.TokenJson::

detailsJsonstring nullable

::API.Modules.OAuthTokens.OAuthToken.DetailsJson::

renewalAttemptsinteger

::API.Modules.OAuthTokens.OAuthToken.RenewalAttempts::

renewalErrorstring nullable

::API.Modules.OAuthTokens.OAuthToken.RenewalError::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

expireDatestring date-time nullable

::API.Modules.OAuthTokens.OAuthToken.ExpireDate::

type'ringCentral' | 'googleMeet' | 'zoom' | 'instagram' | 'facebook' | 'googleBusiness' | 'threads'

::API.Modules.OAuthTokens.OAuthToken.Type::

source'callAccount' | 'chatChannel' | 'application' | 'socialConnection' | 'adConnection'

::API.Modules.OAuthTokens.OAuthToken.Source::

adminIdstring nullable

::API.Modules.OAuthTokens.OAuthToken.AdminId::

encryptedboolean

::API.Modules.OAuthTokens.OAuthToken.Encrypted::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.CustomDataFields.CustomDataField.Name::

keystring nullable

::API.Modules.CustomDataFields.CustomDataField.Key::

additionalDatastring nullable

::API.Modules.CustomDataFields.CustomDataField.AdditionalData::

positioninteger

::API.Modules.CustomDataFields.CustomDataField.Position::

entityType'scenario'

::API.Modules.CustomDataFields.CustomDataField.EntityType::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.CustomDataFields.CustomDataField.Type::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

scenarioIdstring nullable

::API.Modules.CustomDataFields.CustomDataField.ScenarioId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

adminIdstring required

::API.Modules.AI.AiDialog.AdminId::

sitePageIdstring nullable

::API.Modules.AI.AiDialog.SitePageId::

dialogIdstring nullable

::API.Modules.AI.AiDialog.DialogId::

createdDatestring date-time

Creation date

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

namestring nullable

::API.Modules.Meetings.Meeting.Name::

internalNamestring nullable

::API.Modules.Meetings.Meeting.InternalName::

subtitlestring nullable

::API.Modules.Meetings.Meeting.Subtitle::

descriptionstring nullable

::API.Modules.Meetings.Meeting.Description::

slugstring nullable

::API.Modules.Meetings.Meeting.Slug::

type'oneToOne' | 'roundRobin'

::API.Modules.Meetings.Meeting.Type::

format'googleMeet' | 'zoom' | 'phoneCall' | 'offline'

::API.Modules.Meetings.Meeting.Format::

imageFit'cover' | 'contain'

::API.Modules.Meetings.Meeting.ImageFit::

maxGuestinteger

::API.Modules.Meetings.Meeting.MaxGuest::

addressstring nullable

::API.Modules.Meetings.Meeting.Address::

timezoneIdstring nullable

::API.Modules.Meetings.Meeting.TimezoneId::

scheduleSettingsJsonstring nullable

::API.Modules.Meetings.Meeting.ScheduleSettingsJson::

bufferTimeMinutesinteger

::API.Modules.Meetings.Meeting.BufferTimeMinutes::

minBookingNoticeMinutesinteger

::API.Modules.Meetings.Meeting.MinBookingNoticeMinutes::

startTimeIntervalMinutesinteger

::API.Modules.Meetings.Meeting.StartTimeIntervalMinutes::

autoCreateTaskForHostboolean

::API.Modules.Meetings.Meeting.AutoCreateTaskForHost::

showTermsCheckboxboolean

::API.Modules.Meetings.Meeting.ShowTermsCheckbox::

termsTextstring nullable

::API.Modules.Meetings.Meeting.TermsText::

confirmationMessagestring nullable

::API.Modules.Meetings.Meeting.ConfirmationMessage::

isPublishedboolean

::API.Modules.Meetings.Meeting.IsPublished::

publishedDatestring date-time nullable

::API.Modules.Meetings.Meeting.PublishedDate::

createdDatestring date-time

Creation date

siteDomainIdstring nullable

::API.Modules.Meetings.Meeting.SiteDomainId::

oAuthTokenIdstring nullable

::API.Modules.Meetings.Meeting.OAuthTokenId::

imageIdstring nullable

::API.Modules.Meetings.Meeting.ImageId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

isEnabledboolean

::API.Modules.Meetings.MeetingAvailability.IsEnabled::

dayOfWeek'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' nullable

::API.Modules.Meetings.MeetingAvailability.DayOfWeek::

specificDatestring date-time nullable

::API.Modules.Meetings.MeetingAvailability.SpecificDate::

dateIntervalsJsonstring nullable

::API.Modules.Meetings.MeetingAvailability.DateIntervalsJson::

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingAvailability.MeetingId::

type'dayOfWeek' | 'date'

::API.Modules.Meetings.MeetingAvailability.Type::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

durationMinutesinteger

::API.Modules.Meetings.MeetingDuration.DurationMinutes::

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingDuration.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

labelstring nullable

::API.Modules.Meetings.MeetingFormField.Label::

placeholderstring nullable

::API.Modules.Meetings.MeetingFormField.Placeholder::

isRequiredboolean

::API.Modules.Meetings.MeetingFormField.IsRequired::

positioninteger

::API.Modules.Meetings.MeetingFormField.Position::

type'text' | 'dateTime' | 'number' | 'boolean' | 'list' | 'multiList' | 'date' | 'textArea'

::API.Modules.Meetings.MeetingFormField.Type::

systemLeadAttribute'email' | 'phone' | 'firstName' | 'lastName' | 'middleName' | 'city' | 'country' | 'comment' | 'birthday' | 'gender' | 'fullName' | 'region' nullable

::API.Modules.Meetings.MeetingFormField.SystemLeadAttribute::

createdDatestring date-time

Creation date

updatedDatestring date-time nullable

Date the record was last updated.

leadAttributeIdstring nullable

::API.Modules.Meetings.MeetingFormField.LeadAttributeId::

meetingIdstring required

::API.Modules.Meetings.MeetingFormField.MeetingId::

hasSystemLeadAttributeboolean

::API.Modules.Meetings.MeetingFormField.HasSystemLeadAttribute::

hasAttributeIdboolean

::API.Modules.Meetings.MeetingFormField.HasAttributeId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

priorityinteger

::API.Modules.Meetings.MeetingHost.Priority::

createdDatestring date-time

Creation date

adminIdstring required

::API.Modules.Meetings.MeetingHost.AdminId::

meetingIdstring required

::API.Modules.Meetings.MeetingHost.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

startDatestring date-time

::API.Modules.Meetings.MeetingBooking.StartDate::

endDatestring date-time

::API.Modules.Meetings.MeetingBooking.EndDate::

guestNamestring nullable

::API.Modules.Meetings.MeetingBooking.GuestName::

guestEmailstring nullable

::API.Modules.Meetings.MeetingBooking.GuestEmail::

guestPhonestring nullable

::API.Modules.Meetings.MeetingBooking.GuestPhone::

guestTimezoneIdstring nullable

::API.Modules.Meetings.MeetingBooking.GuestTimezoneId::

locationstring nullable

::API.Modules.Meetings.MeetingBooking.Location::

status'pending' | 'confirmed' | 'cancelled' | 'completed' | 'noShow'

::API.Modules.Meetings.MeetingBooking.Status::

cancellationReasonstring nullable

::API.Modules.Meetings.MeetingBooking.CancellationReason::

cancelledDatestring date-time nullable

::API.Modules.Meetings.MeetingBooking.CancelledDate::

fieldsJsonstring nullable

::API.Modules.Meetings.MeetingBooking.FieldsJson::

referrerUrlstring nullable

::API.Modules.Meetings.MeetingBooking.ReferrerUrl::

siteHoststring nullable

::API.Modules.Meetings.MeetingBooking.SiteHost::

guestCountinteger

::API.Modules.Meetings.MeetingBooking.GuestCount::

utmSourcestring nullable

Identifies the site that sent the traffic.

utmMediumstring nullable

Identifies the marketing medium, such as cpc or email.

utmCampaignstring nullable

Identifies a specific advertising campaign

utmTermstring nullable

Identifies a keyword from an ad campaign, regardless of where the click came from

utmContentstring nullable

Identifies the specific content a user clicked before arriving at the site, such as a banner ad or text link. Often used for A/B testing and to measure the performance of pay-per-click ads.

createdDatestring date-time

Creation date

externalLinkIdstring nullable

::API.Modules.Meetings.MeetingBooking.ExternalLinkId::

adminTaskIdstring nullable

::API.Modules.Meetings.MeetingBooking.AdminTaskId::

adminIdstring required

::API.Modules.Meetings.MeetingBooking.AdminId::

studentIdstring nullable

::API.Modules.Meetings.MeetingBooking.StudentId::

meetingIdstring required

::API.Modules.Meetings.MeetingBooking.MeetingId::

durationIdstring required

::API.Modules.Meetings.MeetingBooking.DurationId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

type'zoom' | 'googleMeet' | 'ringCentral'

::API.Modules.Meetings.MeetingExternalLink.Type::

externalIdstring nullable

::API.Modules.Meetings.MeetingExternalLink.ExternalId::

externalUrlstring nullable

::API.Modules.Meetings.MeetingExternalLink.ExternalUrl::

resultJsonstring nullable

::API.Modules.Meetings.MeetingExternalLink.ResultJson::

updatedDatestring date-time nullable

Date the record was last updated.

createdDatestring date-time

Creation date

meetingIdstring required

::API.Modules.Meetings.MeetingExternalLink.MeetingId::

idstring nullable

Unique ID

softDeletedboolean

Whether the record is soft-deleted (marked as deleted but kept in the database).

softDeletedDatestring date-time nullable

Date the record was soft-deleted.

queryAccelContext.database.currentTransaction.transactionIdstring uuid

::API.EntityFrameworkCore.Storage.IDbContextTransaction.TransactionId::

queryAccelContext.database.currentTransaction.supportsSavepointsboolean

::API.EntityFrameworkCore.Storage.IDbContextTransaction.SupportsSavepoints::

queryAccelContext.database.autoTransactionsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionsEnabled::

queryAccelContext.database.autoTransactionBehavior'whenNeeded' | 'always' | 'never'

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionBehavior::

queryAccelContext.database.autoSavepointsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoSavepointsEnabled::

queryAccelContext.database.providerNamestring

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.ProviderName::

queryAccelContext.changeTracker.autoDetectChangesEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.AutoDetectChangesEnabled::

queryAccelContext.changeTracker.lazyLoadingEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.LazyLoadingEnabled::

queryAccelContext.changeTracker.queryTrackingBehavior'trackAll' | 'noTracking' | 'noTrackingWithIdentityResolution'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.QueryTrackingBehavior::

queryAccelContext.changeTracker.deleteOrphansTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.DeleteOrphansTiming::

queryAccelContext.changeTracker.cascadeDeleteTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.CascadeDeleteTiming::

queryAccelContext.changeTracker.context.database.currentTransaction.transactionIdstring uuid

::API.EntityFrameworkCore.Storage.IDbContextTransaction.TransactionId::

queryAccelContext.changeTracker.context.database.currentTransaction.supportsSavepointsboolean

::API.EntityFrameworkCore.Storage.IDbContextTransaction.SupportsSavepoints::

queryAccelContext.changeTracker.context.database.autoTransactionsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionsEnabled::

queryAccelContext.changeTracker.context.database.autoTransactionBehavior'whenNeeded' | 'always' | 'never'

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoTransactionBehavior::

queryAccelContext.changeTracker.context.database.autoSavepointsEnabledboolean

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.AutoSavepointsEnabled::

queryAccelContext.changeTracker.context.database.providerNamestring

::API.EntityFrameworkCore.Infrastructure.DatabaseFacade.ProviderName::

queryAccelContext.changeTracker.context.changeTracker.autoDetectChangesEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.AutoDetectChangesEnabled::

queryAccelContext.changeTracker.context.changeTracker.lazyLoadingEnabledboolean

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.LazyLoadingEnabled::

queryAccelContext.changeTracker.context.changeTracker.queryTrackingBehavior'trackAll' | 'noTracking' | 'noTrackingWithIdentityResolution'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.QueryTrackingBehavior::

queryAccelContext.changeTracker.context.changeTracker.deleteOrphansTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.DeleteOrphansTiming::

queryAccelContext.changeTracker.context.changeTracker.cascadeDeleteTiming'immediate' | 'onSaveChanges' | 'never'

::API.EntityFrameworkCore.ChangeTracking.ChangeTracker.CascadeDeleteTiming::

modelMicrosoftEntityFrameworkCoreMetadataIModel (unresolved $ref)
contextIdMicrosoftEntityFrameworkCoreDbContextId (unresolved $ref)
queryAccelContext.changeTracker.context.changeTracker.debugView.longViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.LongView::

queryAccelContext.changeTracker.context.changeTracker.debugView.shortViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.ShortView::

queryAccelContext.changeTracker.context.model.modelDependencies.typeMappingSourceMicrosoftEntityFrameworkCoreStorageITypeMappingSource (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.TypeMappingSource::

queryAccelContext.changeTracker.context.model.modelDependencies.constructorBindingFactoryMicrosoftEntityFrameworkCoreMetadataIConstructorBindingFactory (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ConstructorBindingFactory::

queryAccelContext.changeTracker.context.model.modelDependencies.parameterBindingFactoriesMicrosoftEntityFrameworkCoreMetadataIParameterBindingFactories (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ParameterBindingFactories::

queryAccelContext.changeTracker.context.model.modelIdstring uuid

::API.EntityFrameworkCore.Metadata.IModel.ModelId::

queryAccelContext.changeTracker.context.contextId.instanceIdstring uuid

::API.EntityFrameworkCore.DbContextId.InstanceId::

queryAccelContext.changeTracker.context.contextId.leaseinteger

::API.EntityFrameworkCore.DbContextId.Lease::

queryAccelContext.changeTracker.debugView.longViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.LongView::

queryAccelContext.changeTracker.debugView.shortViewstring

::API.EntityFrameworkCore.Infrastructure.DebugView.ShortView::

queryAccelContext.model.modelDependencies.typeMappingSourceMicrosoftEntityFrameworkCoreStorageITypeMappingSource (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.TypeMappingSource::

queryAccelContext.model.modelDependencies.constructorBindingFactoryMicrosoftEntityFrameworkCoreMetadataIConstructorBindingFactory (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ConstructorBindingFactory::

queryAccelContext.model.modelDependencies.parameterBindingFactoriesMicrosoftEntityFrameworkCoreMetadataIParameterBindingFactories (unresolved $ref)

::API.EntityFrameworkCore.Infrastructure.RuntimeModelDependencies.ParameterBindingFactories::

queryAccelContext.model.modelIdstring uuid

::API.EntityFrameworkCore.Metadata.IModel.ModelId::

queryAccelContext.contextId.instanceIdstring uuid

::API.EntityFrameworkCore.DbContextId.InstanceId::

queryAccelContext.contextId.leaseinteger

::API.EntityFrameworkCore.DbContextId.Lease::

hasExtendedFilterJsonboolean

Has extended filter JSON

hasExtendedFilterIdboolean

Has extended filter ID

timezoneOffsetMininteger

Time zone offset in minutes

itemsTotalinteger

Total items

takeinteger

Number of results per page

skipinteger

Number of records to skip

searchstring

Search phrase

sortNamestring

Property to sort by

sortType'asc' | 'desc'

Sort order

useSortboolean

Apply sorting

useBaseFilterboolean

Use base filter

useItemsTotalboolean

Count total records

softDeletedboolean

Soft-deleted

idsstring[]

List of unique identifiers

fieldsstring

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the sample server response for the full list of fields.

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.