Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

البداية

نظرة عامة
البداية السريعة
المصادقة

أدلة

الترقيم الصفحي
Webhooks
الأخطاء

جرّب

ساحة GraphQL

Queries

QRY
activityEvents
QRY
activityEventsByContentType
QRY
appDetail
QRY
apps
QRY
automationByNs
QRY
automationCatalog
QRY
automationConstants
QRY
automationDetail
QRY
automationDetailByNs
QRY
automationExportPAF
QRY
automationHistories
QRY
automationHistoriesTotalCount
QRY
automationHistoryDetail
QRY
automationImportPreview
QRY
automationNotes
QRY
automations
QRY
automationsMain
QRY
automationsTotalCount
QRY
automationTemplates
QRY
automationVersions
QRY
branchDetail
QRY
branches
QRY
companies
QRY
companyCounts
QRY
companyDetail
QRY
contacts
QRY
conversationCounts
QRY
conversationDetail
QRY
conversationMessage
QRY
conversationMessages
QRY
conversations
QRY
currentUser
QRY
customerBehavioralSummary
QRY
customerCounts
QRY
customerDetail
QRY
customers
QRY
customerTimeline
QRY
departmentDetail
QRY
departments
QRY
emailTemplate
QRY
emailTemplates
QRY
engageAudienceUniqueCount
QRY
engageEmailPercentages
QRY
engageLogs
QRY
engageMessageCounts
QRY
engageMessageDetail
QRY
engageMessages
QRY
engageMessagesTotalCount
QRY
engageReportsList
QRY
engageWhatsappDeliveries
QRY
engageWhatsappPercentages
QRY
fieldsCombinedByContentType
QRY
fieldsDefaultColumnsConfig
QRY
fieldsGetDetail
QRY
fieldsGetTypes
QRY
fieldsGroups
QRY
formDetail
QRY
forms
QRY
formsTotalCount
QRY
formSubmissionDetail
QRY
formSubmissions
QRY
formSubmissionsTotalCount
QRY
inboxFields
QRY
integrationDetail
QRY
integrations
QRY
integrationsGetUsedTypes
QRY
integrationsTotalCount
QRY
listMiniAppsGeneralInfo
QRY
liveAutomations
QRY
macros
QRY
miniAppDashboardConfig
QRY
miniAppDetail
QRY
miniAppGeneralInfo
QRY
miniAppGetConfigs
QRY
miniApps
QRY
miniAppsActionSources
QRY
myMiniApps
QRY
nodeByNs
QRY
nodeDetail
QRY
nodes
QRY
nodesMain
QRY
productCategories
QRY
productCategoryDetail
QRY
productCountByTags
QRY
productDetail
QRY
products
QRY
responseTemplates
QRY
segmentsV2
QRY
segmentV2
QRY
segmentV2AssertReadyForCampaign
QRY
segmentV2Count
QRY
segmentV2IsInSegment
QRY
segmentV2MembershipsByCustomer
QRY
segmentV2VersionRule
QRY
tagDetail
QRY
tags
QRY
tagsQueryCount
QRY
teamChatActivities
QRY
teamChatActivityUnreadCounts
QRY
teamChatDetail
QRY
teamChatPublicChannels
QRY
teamChats
QRY
teamChatUnreadCount
QRY
teamMessages
QRY
teamThreadMessages
QRY
triggerDetail
QRY
triggers
QRY
userDetail
QRY
users
QRY
whatsappAnalyticsByField
QRY
whatsappBusinessDetails
QRY
whatsappBusinessesList
QRY
whatsappCallHistories
QRY
whatsappCatalogPermissionStatus
QRY
whatsappCatalogSyncStatus
QRY
whatsappConversationMessages
QRY
whatsappGenerateFlowPreview
QRY
whatsappGetAllFlows
QRY
whatsappGetCallPermission
QRY
whatsappGetCallSettings
QRY
whatsappGetFlowById
QRY
whatsappGetMessageTemplateDetail
QRY
whatsappGetOBAStatus
QRY
whatsappGetQRCodes
QRY
whatsappGetSyncStatus
QRY
whatsappGetTemplates
QRY
whatsappIntegrationById
QRY
whatsappValidateFlowSchema

Mutations

MUT
appsAdd
MUT
appsEdit
MUT
appsRemove
MUT
archiveAutomations
MUT
automationImportFromPAF
MUT
automationsAdd
MUT
automationsAddNote
MUT
automationsCreateFromTemplate
MUT
automationsDiscardDraft
MUT
automationsDuplicate
MUT
automationsEdit
MUT
automationsEditNote
MUT
automationsPublish
MUT
automationsReconcileImportIssues
MUT
automationsRemoveNote
MUT
automationsRevert
MUT
automationsSaveAsTemplate
MUT
automationsSetTags
MUT
automationsToggleOffline
MUT
batchSavePositions
MUT
companiesAdd
MUT
companiesEdit
MUT
companiesEditByField
MUT
companiesMerge
MUT
companiesRemove
MUT
conformityAdd
MUT
conformityEdit
MUT
conversationConvertToCard
MUT
conversationEditCustomFields
MUT
conversationMarkAsRead
MUT
conversationMessageAdd
MUT
conversationMessageUpdate
MUT
conversationResolveAll
MUT
conversationsAssign
MUT
conversationsChangeStatus
MUT
conversationsUnassign
MUT
customersAdd
MUT
customersChangeState
MUT
customersEdit
MUT
customersEditByField
MUT
customersMerge
MUT
customersRemove
MUT
draftAutomationDetail
MUT
emailTemplatesAdd
MUT
emailTemplatesChangeStatus
MUT
emailTemplatesDuplicate
MUT
emailTemplatesEdit
MUT
emailTemplatesRemove
MUT
engageMessageAdd
MUT
engageMessageCopy
MUT
engageMessageEdit
MUT
engageMessagePause
MUT
engageMessageRemove
MUT
engageMessageResume
MUT
engageMessageRetry
MUT
engageMessageSendTestEmail
MUT
engageMessageSendTestWhatsapp
MUT
engageMessageStart
MUT
engageMessageStop
MUT
fieldsAdd
MUT
fieldsEdit
MUT
fieldsGroupsAdd
MUT
fieldsGroupsEdit
MUT
fieldsGroupsRemove
MUT
fieldsRemove
MUT
formSubmissionsSave
MUT
nodesAdd
MUT
nodesEdit
MUT
nodesRemove
MUT
productCategoriesAdd
MUT
productCategoriesEdit
MUT
productCategoriesRemove
MUT
productsAdd
MUT
productsEdit
MUT
productsRemove
MUT
responseTemplatesAdd
MUT
responseTemplatesEdit
MUT
responseTemplatesRemove
MUT
runFlow
MUT
segmentV2AddStaticMembers
MUT
segmentV2Archive
MUT
segmentV2PreviewCount
MUT
segmentV2PublishVersion
MUT
segmentV2RemoveStaticMembers
MUT
segmentV2RequestCustomerDeletion
MUT
segmentV2SaveDraft
MUT
segmentV2Unarchive
MUT
tagsAdd
MUT
tagsEdit
MUT
tagsMerge
MUT
tagsRemove
MUT
tagsTag
MUT
teamChatActivityMarkAsRead
MUT
teamChatAddMembers
MUT
teamChatArchive
MUT
teamChatCreate
MUT
teamChatDelete
MUT
teamChatJoin
MUT
teamChatLeave
MUT
teamChatMarkAsRead
MUT
teamChatMute
MUT
teamChatPin
MUT
teamChatRemoveMembers
MUT
teamChatSetRole
MUT
teamChatShareInboxMessage
MUT
teamChatUnarchive
MUT
teamChatUpdate
MUT
teamMessageDelete
MUT
teamMessageEdit
MUT
teamMessagePin
MUT
teamMessageReact
MUT
teamMessageSend
MUT
teamMessageUnpin
MUT
triggersAdd
MUT
triggersEdit
MUT
triggersRemove
MUT
whatsappBulkDeleteFlows
MUT
whatsappBulkDeleteTemplates
MUT
whatsappBulkDeprecateFlows
MUT
whatsappBulkPublishFlows
MUT
whatsappCheckIntegrationHealth
MUT
whatsappCreateFlow
MUT
whatsappCreateQRCode
MUT
whatsappDeleteFlow
MUT
whatsappDeleteQRCode
MUT
whatsappDeleteTemplate
MUT
whatsappDeprecateFlow
MUT
whatsappDuplicateFlow
MUT
whatsappPublishFlow
MUT
whatsappSendCallButtonMessage
MUT
whatsappSendCallPermissionRequest
MUT
whatsappSendTemplateMessage
MUT
whatsappSyncCatalogProducts
MUT
whatsappSyncFlows
MUT
whatsappSyncMessageTemplates
MUT
whatsappTemplatesAdd
MUT
whatsappTemplatesUpdate
MUT
whatsappUpdateBusinessProfile
MUT
whatsappUpdateCallSettings
MUT
whatsappUpdateFlow
MUT
whatsappUpdateQRCode

Types

ActionsPayload
UNION
actionsResponse
OBJECT
ActivityEvent
OBJECT
ActivityEventList
OBJECT
App
OBJECT
AppListResponse
OBJECT
AppTokenResult
OBJECT
AssignedPayload
OBJECT
Attachment
OBJECT
AuthResponse
OBJECT
Automation
OBJECT
AutomationCatalogView
ENUM
AutomationHistoriesPaginated
OBJECT
AutomationHistory
OBJECT
AutomationHistoryDetail
OBJECT
AutomationNote
OBJECT
AutomationsListResponse
OBJECT
AutomationsPaginatedResponse
OBJECT
automationsTotalCountResponse
OBJECT
AutomationVersion
OBJECT
AutomationVersionList
OBJECT
AvgEmailStats
OBJECT
AvgWhatsappStats
OBJECT
BatchSavePositionsResponse
OBJECT
Branch
OBJECT
BranchListQueryResponse
OBJECT
BulkFlowResponse
OBJECT
BulkFlowResult
OBJECT
ColumnConfigItem
OBJECT
CompaniesListResponse
OBJECT
Company
OBJECT
Conformity
OBJECT
Contacts
OBJECT
ContactsResponse
OBJECT
Conversation
OBJECT
ConversationListResponse
OBJECT
ConversationMessage
OBJECT
ConversationMessageListResponse
OBJECT
ConversationStatus
ENUM
ConvertedToCardPayload
OBJECT
createFlowResponse
OBJECT
Customer
OBJECT
CustomerBehavioralSummary
OBJECT
CustomerPhoneChangedPayload
OBJECT
CustomerSegmentV2Membership
OBJECT
CustomersListResponse
OBJECT
CustomerTimelineResponse
OBJECT
DateRange
OBJECT
DeliveryReport
OBJECT
DeliveryReportPaginatedResponse
OBJECT
Department
OBJECT
DepartmentListQueryResponse
OBJECT
EmailAddress
OBJECT
EmailAttachment
OBJECT
EmailTemplate
OBJECT
EmailTemplateListResponse
OBJECT
EngageAudienceTag
OBJECT
EngageLog
OBJECT
EngageLogPaginatedResponse
OBJECT
EngageMessage
OBJECT
EngageMessagePaginatedResponse
OBJECT
EngageMessageWhatsapp
OBJECT
EngagePushStats
OBJECT
EngageRunSummary
OBJECT
EngageScheduleDate
OBJECT
EngageSegment
OBJECT
ExecutionStep
OBJECT
Field
OBJECT
FieldsGroup
OBJECT
FlowAsset
OBJECT
FlowCategories
ENUM
FlowPagination
OBJECT
FlowPreview
OBJECT
FlowPreviewResponse
OBJECT
FlowRuntimeConfig
OBJECT
FlowStatus
ENUM
FlowSyncResponse
OBJECT
FlowValidationError
OBJECT
FlowValidationPointer
OBJECT
Form
OBJECT
FormsResponse
OBJECT
FormsTotalCount
OBJECT
FormSubmission
OBJECT
FormSubmissionListResponse
OBJECT
HealthEntity
OBJECT
ImportIssueReconcileResult
OBJECT
InboxField
OBJECT
Integration
OBJECT
IntegrationListResponse
OBJECT
integrationsGetUsedTypes
OBJECT
integrationsTotalCount
OBJECT
LeadStageHistoryEntry
OBJECT
LinkClickedPayload
OBJECT
LocationData
OBJECT
LocationOption
OBJECT
Logic
OBJECT
MessageContext
OBJECT
MessageDelivery
OBJECT
MessageEditEntry
OBJECT
MessageEmail
OBJECT
MessageEngage
OBJECT
MessageForm
OBJECT
MessageInteractive
OBJECT
MessageMedia
OBJECT
MessageOrder
OBJECT
MessageOrderProductItem
OBJECT
MessageOrigin
OBJECT
MessageReaction
OBJECT
MessageSender
OBJECT
MessageSystem
OBJECT
MessageTemplate
OBJECT
MessageText
OBJECT
MessageVideoCall
OBJECT
MessageWhatsappCall
OBJECT
MessengerApp
OBJECT
MiniAppDashboardAction
OBJECT
MiniAppDashboardConfig
OBJECT
miniAppDetailResponse
OBJECT
MiniAppGeneralInfoResponse
OBJECT
MiniAppRegistry
OBJECT
Node
OBJECT
NodesPaginatedResponse
OBJECT
ObjectListConfig
OBJECT
OnboardingHistory
OBJECT
OnboardingSection
OBJECT
OnboardingSections
OBJECT
OnceSchedule
OBJECT
PAFCandidate
OBJECT
PAFEntityDescriptor
OBJECT
PAFExportResult
OBJECT
PAFImportEntity
OBJECT
PAFImportPreview
OBJECT
PAFImportResult
OBJECT
PaginationInfo
OBJECT
ParticipantAddedPayload
OBJECT
ParticipantRemovedPayload
OBJECT
Position
OBJECT
PriceRange
OBJECT
PriorityChangedPayload
OBJECT
Product
OBJECT
ProductCategory
OBJECT
ProductCategoryListResponse
OBJECT
ProductDimensions
OBJECT
ProductInventory
OBJECT
ProductListResponse
OBJECT
ProductOption
OBJECT
ProductOptionValue
OBJECT
ProductSEO
OBJECT
ProductVariant
OBJECT
RecurrenceOn
OBJECT
RecurringSchedule
OBJECT
ResponseTemplate
OBJECT
ResponseTemplateListResponse
OBJECT
ScoreCategories
OBJECT
ScoreCategoryEntry
OBJECT
SegmentV2
OBJECT
SegmentV2Count
OBJECT
SegmentV2EvaluatorState
OBJECT
SegmentV2List
OBJECT
SegmentV2Membership
OBJECT
SortDirection
ENUM
StatusChangedPayload
OBJECT
Submission
OBJECT
SuccessResult
OBJECT
Tag
OBJECT
TaggedPayload
OBJECT
TagsChangedPayload
OBJECT
TagsPaginatedResponse
OBJECT
TeamChat
OBJECT
TeamChatActivity
OBJECT
TeamChatActivityListResponse
OBJECT
TeamChatActivityType
ENUM
TeamChatActivityUnreadCounts
OBJECT
TeamChatAttachment
OBJECT
TeamChatListResponse
OBJECT
TeamChatMember
OBJECT
TeamChatReaction
OBJECT
TeamChatType
ENUM
TeamMessage
OBJECT
TeamMessageListResponse
OBJECT
TeamMessageQuote
OBJECT
TeamMessageSharedInbox
OBJECT
TemplateAnalytics
OBJECT
TemplateAnalyticsData
OBJECT
TemplateBenchmarks
OBJECT
TemplateClickData
OBJECT
TemplateConversions
OBJECT
TemplateCostData
OBJECT
TemplateDataPoint
OBJECT
TemplatePerformanceRates
OBJECT
TemplateRendered
OBJECT
TemplateRenderedButton
OBJECT
TemplateRenderedCarouselCard
OBJECT
TemplateRenderedHeader
OBJECT
TemplateRenderedLTO
OBJECT
Throughput
OBJECT
TimelineEntry
OBJECT
TimelineEntrySource
ENUM
TimeOfDay
OBJECT
TimeWindow
OBJECT
Trigger
OBJECT
TriggerAutomation
OBJECT
TriggersPaginated
OBJECT
UnassignedPayload
OBJECT
UntaggedPayload
OBJECT
User
OBJECT
UserChatStatus
ENUM
UserDetailsType
OBJECT
UserListResponse
OBJECT
VariantOptionValue
OBJECT
WAContact
OBJECT
WAContactName
OBJECT
WALocation
OBJECT
WAReferral
OBJECT
WAReferralWelcomeMessage
OBJECT
WASticker
OBJECT
WhatsappAnalyticsField
ENUM
WhatsappAnalyticsGranularity
ENUM
WhatsappAnalyticsProductType
ENUM
WhatsappBusinessPhone
OBJECT
WhatsappBusinessProfile
OBJECT
WhatsappCallCenterConfig
OBJECT
WhatsappCallDirection
ENUM
WhatsappCallHistory
OBJECT
WhatsappCallHistoryList
OBJECT
WhatsappCallHoursConfig
OBJECT
WhatsappCallHoursHoliday
OBJECT
WhatsappCallHoursSlot
OBJECT
WhatsappCallingRestriction
OBJECT
WhatsappCallParticipant
OBJECT
WhatsappCallPermission
OBJECT
WhatsappCallPermissionAction
OBJECT
WhatsappCallPermissionLimit
OBJECT
WhatsappCallRecordingConfig
OBJECT
WhatsappCallSettings
OBJECT
WhatsappCallTranscript
OBJECT
WhatsappCallTranscriptionConfig
OBJECT
WhatsappCallTranscriptSegment
OBJECT
WhatsappConversationCategory
ENUM
WhatsappConversationDirection
ENUM
WhatsappConversationMessageListResponse
OBJECT
WhatsappConversationType
ENUM
WhatsappDeliveryReport
OBJECT
WhatsappDeliveryReportPaginatedResponse
OBJECT
WhatsappFlow
OBJECT
WhatsappFlowList
OBJECT
WhatsappHealthStatus
OBJECT
WhatsappHistorySync
OBJECT
WhatsappIntegration
OBJECT
whatsappIntegrationByIdResponse
OBJECT
WhatsappMessageTemplateResponse
OBJECT
WhatsappOBAStatusResponse
OBJECT
WhatsappPricingCategory
ENUM
WhatsappPricingType
ENUM
WhatsappQRCode
OBJECT
WhatsappQRCodeListResponse
OBJECT
WhatsappTemplate
OBJECT
WhatsappTemplateList
OBJECT
WhatsappTemplateMapping
OBJECT
Workspace
OBJECT

الدعم

Karzoun Chat Docs home page

الدعم

Types

Throughput

Meta-assigned messaging throughput tier for the phone number.

objectThroughput

Fields

level

String

آخر تعديل في ١١ أغسطس ٢٠٢٦

هل كانت هذه الصفحة مفيدة؟

A single entry in a customer's unified activity timeline, returned by [`customerTimeline`](/api-reference/queries/customerTimeline). Fields populated depend on `source`: `activity` entries use `action` / `contentType` / `contentId` / `performer` / `payload`; `behavioral` entries use `eventName` / `eventType` / `sessionId` / `pageUrl` / `device` / `campaign` / `properties`; `note` entries use `noteContent` / `noteCreatedBy` / `noteUpdatedAt` / `noteIsEdited`.

Karzoun Chat Docs home page

المنتج

حساب كرزون ساحة GraphQL

ابنِ

GraphQL API MCP SDK MiniApps الشركاء

تعلّم

مركز المساعدة البداية السريعة Webhooks سجل التغييرات

الشركة

الدعم صحة الخدمة شريك ميتا للأعمال الشروط الاستخدام المسؤول

مدعوم منThis documentation is built and hosted on Mintlify, a developer documentation platform