Schemas
The 609 component schemas of the public API (components.schemas): fields, types, required flags and constraints.
Every object schema used in request and response bodies. Field names are snake_case, timestamps are ISO 8601 UTC and IDs are prefixed ULIDs. Schema names match the "Schema:" links on the operation pages.
Index
AcceptInviteResult · Account · AccountExport · AdAccount · AdAccountList · AdAttributionReport · AdAudience · AdAudienceList · AdAudienceSyncList · AdAudienceSyncQueued · AdBudgetAlertList · AdBudgetAlertRule · AdBudgetAlertRuleList · AdCampaignCreated · AdCampaignPreview · AdCapiConfig · AdCapiConfigList · AdCapiDelivery · AdCapiDeliveryList · AdCapiTestResult · AdCreative · AddAliasDto · AddSubscriptionDto · AdEntity · AdEntityList · AdLtvReport · AdOAuthPending · AdOAuthStartResult · AdOk · AdPageList · AdPlatformList · AdRefreshQueued · AdReportingSettings · AdReportingSettingsInputDto · AdSpendReport · AffinityConfig · AffinityOverview · AgentUpdateDto · AiAgent · AiAgentList · AiAgentMetrics · AiAgentRunList · AiAgentWithSecret · AiConversationSummary · AiGlossaryEntry · AiGlossaryList · AiPanelApplyResult · AiPanelResult · AiReplySuggestions · AiSettings · AiStatus · AiSubjectScoreResult · AiSuggestions · AiTranslateResult · AiTranslation · AiTranslationList · AiUsageReport · AiVariantsResult · AndroidDeliveryReport · ApiEventsDto · ApiKey · ApiKeyList · App · AppFlag · AppFlagEvaluation · AppFlagList · AppList · AppTransfer · AppTransferList · AssignmentRule · AssignmentRuleInputDto · AssignmentRuleList · AssignmentRuleUpdateDto · AuditActions · AuditEntry · AuditPage · AuthConfig · BatchMembersDto · BatchUpsertCompaniesDto · BillingStatus · Branding · BrandKitExtract · BrandResolution · BulkReplayDto · Campaign · CampaignAgentConfig · CampaignEmailRisk · CampaignPage · CampaignPreflightReport · CampaignProposal · CampaignProposalDraft · CampaignProposalList · CampaignStats · CampaignVariantStats · CannedInputDto · CannedResponse · CannedResponseList · CannedResponseRender · CannedUpdateDto · Catalog · CatalogItem · CatalogItemsPage · CatalogList · CatalogUpsertResult · CellHandoff · CellHandoffResult · CellList · CellOrgList · ChannelConfig · ChannelHook · ChannelList · ChannelScoreConfig · ChannelScoreOverview · ChannelScoreUser · ChannelScoreUsersPage · ChannelStatusList · ChannelValidation · CheckoutResult · CheckVerifyDto · CleanupResult · Company · CompanyBatchResult · CompanyList · CompanyMember · CompanyMemberBatchResult · CompanyMemberList · ContentCard · ContentCardList · ContentTable · ContentTableList · ContentTableRows · Conversation · ConversationActivity · ConversationAssignDto · ConversationContact · ConversationMessagePage · ConversationPage · ConversationReplyDto · ConversationReplyResult · ConversationTagsDto · ConversationTagsResult · ConversationUpdateDto · ConversionsReport · CopyTemplateDto · CreateAdAudienceDto · CreateAdCampaignDto · CreateAiAgentDto · CreateAppApiKeyDto · CreateAppDto · CreateAppFlagDto · CreateBudgetAlertRuleDto · CreateCatalogDto · CreateCategoryDto · CreateCustomAgentDto · CreatedApiKey · CreateDataFeedDto · CreateDataSourceDto · CreateDataTransformDto · CreateDecisionAgentDto · CreateExportDto · CreateFormDto · CreateGeofenceDto · CreateIdentityKeyDto · CreateInAppDto · CreateKeywordDto · CreateLandingPageDto · CreateLiveActivityTypeDto · CreateLookalikeDto · CreateMessengerLinkDto · CreateNotificationDto · CreateNotificationResult · CreatePredictionDto · CreatePromoCodeListDto · CreateSavedReportDto · CreateSetupAppDto · CreateSiteSearchSourceDto · CreateSqlSegmentDto · CreateSuppressionDto · CreateSurveyDto · CreateTemplateDto · CreateWalletTemplateDto · CreateWarehouseConnectionDto · CreateWarehouseSegmentDto · CreateWarmupPlanDto · CreateWebCampaignDto · CreateWebhookDto · CreateWebPersonalizationDto · CustomAgent · CustomAgentDraft · CustomAgentDraftList · CustomAgentList · CustomAgentRun · CustomAgentRunList · CustomDomain · CustomDomainList · DataFeed · DataFeedList · DataFeedTestResult · DataQuarantineDiscardResult · DataQuarantineList · DataQuarantineReprocessResult · DataSource · DataSourceList · DataSourceRunResult · DataSourceWithSecret · DataTransform · DataTransformList · DataTransformPreview · DecideDto · DecisionAgent · DecisionAgentList · DecisionReport · DecisionResult · DeliverabilitySettingsDto · Delivery · DeliveryList · DiscardQuarantineDto · EmailAddressCheck · EmailBounceStats · EmailDeliverabilitySettings · EmailDesign · EmailDesignPage · EmailDesignPreview · EmailHygieneRun · EmailHygieneStart · EmailHygieneStatus · EmailHygieneSuppress · EmailProviderInsights · EmailSavedBlock · EmailSavedBlockList · EmailWarmupPlan · EmailWarmupPlanList · EmailWarmupUsage · EndLiveActivityDto · EngagementReport · EstimateAudienceDto · EstimateAudienceResult · EvaluateAppFlagsDto · EventDefinition · EventDefinitionDetail · EventDefinitionList · EventList · EventsAccepted · EventsReport · Export · ExportList · Form · FormPage · FormSubmission · FormSubmissionPage · FormSubmitResult · FunnelBodyDto · FunnelReport · Geofence · GeofenceList · GlobalControl · GlobalControlReport · IdentityKey · IdentityKeyList · Import · ImportList · InAppMessage · InAppMessagePage · InAppStatusDto · InAppTemplate · InAppTemplateList · InAppWinnerDto · InboxAgent · InboxAgentList · InboxItem · InboxMetrics · InboxPage · InboxReadAllResult · InboxSettings · InboxSettingsUpdateDto · InboxTeam · InboxTeamList · Integration · IntegrationList · IntegrationOk · IntegrationRunList · IntegrationSyncResult · IntegrationTestResult · Invite · InviteList · InvitePreview · InvoiceList · IssueWalletPassDto · Journey · JourneyDetail · JourneyPage · JourneyPublishResult · JourneyRun · JourneyRunDetail · JourneyRunPage · JourneyStats · JourneyTriggerResult · JourneyVersionList · LandingPage · LandingPageList · LandingPageVersions · LandingPreviewResult · LiveActivitySendResult · LiveActivityTokenResult · LiveActivityType · LiveActivityTypeList · LoginResult · Me · Member · MemberList · Message · MessageCategory · MessageCategoryList · MessageList · MessagesReport · MessengerLink · MfaSetup · OAuthApproveResult · OAuthConsentContext · Ok · OpenedDto · Org · OrgDataExport · OrgList · OrgNotificationList · OverageChargeList · OverviewStats · PatchEventDefinitionDto · PatchSubscriptionDto · PatchUserDto · PathBodyDto · PathReport · PlanList · PortalResult · PostmasterStats · PredictionModel · PredictionModelList · PredictionUsersPage · PreviewDataTransformDto · PreviewWarehouseQueryDto · PromoCodeList · PromoCodeListList · PromoCodesPage · PromoCodeUploadResult · ProvidersReport · PublicCleanupSubscriptionsDto · PublicFormSubmitDto · PublicSurveyResponseDto · PutSiteSearchDocumentDto · ReceivedDto · RecentEvents · RecommendationConfig · Recommendations · RecoveryCodes · RenderPreview · RenderTemplateDto · ReportResult · ReportRunBodyDto · ReprocessQuarantineDto · RequestLog · RequestLogPage · ResellerChildOrg · ResellerChildOrgList · ResellerStatement · RetentionReport · ReverseEtlConnectionTest · ReverseEtlCreate · ReverseEtlRun · ReverseEtlRunPage · ReverseEtlSync · ReverseEtlSyncList · RfmConfig · RfmOverview · RfmTransitions · RfmUsersPage · RunSqlQueryDto · SavedReport · SavedReportList · ScheduleCampaignDto · ScimTokenCreated · ScimTokenList · SdkAttributionAccepted · SdkAttributionDto · SdkChatAckDto · SdkChatConfig · SdkChatConversation · SdkChatIdentifyDto · SdkChatIdentifyResult · SdkChatMessagePage · SdkChatOfflineDto · SdkChatSendDto · SdkChatSendResult · SdkChatTypingDto · SdkConfig · SdkErrorPage · SdkErrorsAccepted · SdkErrorsDto · SdkEventsDto · SdkFeatureFlags · SdkFlagsEvaluateDto · SdkFormSubmitDto · SdkGeofenceEventsDto · SdkGeofenceList · SdkIdentityDto · SdkIdentityResult · SdkInAppEventDto · SdkInAppList · SdkInboxActionDto · SdkLiveActivityTokenDeleteDto · SdkLiveActivityTokenDto · SdkLoginDto · SdkLogoutDto · SdkPreferences · SdkRegisterDto · SdkRegisterResult · SdkSecret · SdkSessionDto · SdkSetPreferencesDto · SdkSnippet · SdkSubscriptionPatchDto · SdkSurveyResponseDto · SdkUserPatchDto · SdkUserResult · SdkWebCampaignEventDto · SdkWebCampaignList · SdkWebPersonalizationEventDto · SdkWebPersonalizationList · Segment · SegmentCampaigns · SegmentEstimate · SegmentPage · SegmentPreview · SelectWinnerDto · SessionList · SessionVolume · SetMemberDto · SetOwnerDto · SetPreferencesDto · SetupStatus · ShopifyWebhookStatus · SiteSearchCrawlRequest · SiteSearchDocument · SiteSearchDocumentPage · SiteSearchDocumentResult · SiteSearchEventDto · SiteSearchOverview · SiteSearchPreview · SiteSearchReport · SiteSearchRequestDto · SiteSearchResponse · SiteSearchSource · SiteSearchSourceList · SmsKeyword · SmsKeywordList · SmsVerification · SmsVerificationCheck · SqlQueryResult · SqlRunList · SqlSchema · SqlSegmentList · SsoConnection · SsoConnectionList · SsoDiscoverResult · SsoDomain · SsoDomainList · SsoSettings · SsoTestResult · SsoTestStart · StartHygieneDto · StartLiveActivityDto · StartVerifyDto · StatusTokenResult · Subscription · SubscriptionList · SubscriptionsReport · Suppression · SuppressionPage · Survey · SurveyInAppDto · SurveyPage · SurveyReport · SurveyResponse · SurveyResponsePage · SurveyResponseResult · SurveyStatusDto · SyncAdAudienceDto · TeamInputDto · TeamUpdateDto · Template · TemplatePage · TemplateStats · TemplateVersionList · TestDataFeedDto · TestPushDto · TraceResult · TriggerRunDto · UninstallReport · UpdateAdAudienceDto · UpdateAdCampaignDto · UpdateAffinityConfigDto · UpdateAiAgentDto · UpdateApiKeyDto · UpdateAppDto · UpdateAppFlagDto · UpdateBudgetAlertRuleDto · UpdateCatalogDto · UpdateCategoryDto · UpdateChannelScoreConfigDto · UpdateCompanyDto · UpdateContentTableDto · UpdateCustomAgentDto · UpdateDataFeedDto · UpdateDataSourceDto · UpdateDataTransformDto · UpdateDecisionAgentDto · UpdateFormDto · UpdateGeofenceDto · UpdateGlobalControlDto · UpdateInAppDto · UpdateJourneyDto · UpdateKeywordDto · UpdateLandingPageDto · UpdateLiveActivityDto · UpdateLiveActivityTypeDto · UpdateNodeDto · UpdatePredictionDto · UpdatePromoCodeListDto · UpdateRecommendationConfigDto · UpdateReverseEtlDto · UpdateRfmConfigDto · UpdateSavedReportDto · UpdateSiteSearchSettingsDto · UpdateSiteSearchSourceDto · UpdateSqlSegmentDto · UpdateSurveyDto · UpdateTemplateDto · UpdateWalletConfigDto · UpdateWalletPassDto · UpdateWalletTemplateDto · UpdateWarehouseConnectionDto · UpdateWarehouseExportDto · UpdateWarehouseSegmentDto · UpdateWarmupPlanDto · UpdateWebCampaignDto · UpdateWebhookDto · UpdateWebPersonalizationDto · UpsertCatalogItemsDto · UpsertCompanyDto · UpsertUserDto · UsageReport · User · UserAffinity · UserCompanyList · UserDetail · UserExport · UserIdentity · UserJourneyRuns · UserList · UserMessageList · UserPreferences · UserTimeline · VerifyAddressDto · WalletConfig · WalletPass · WalletPassPage · WalletTemplate · WalletTemplateList · WarehouseConnectionResult · WarehouseConnectionTest · WarehouseExport · WarehouseExportCreate · WarehouseExportList · WarehouseExportRun · WarehouseExportRunPage · WarehouseSegmentConnection · WarehouseSegmentConnectionList · WarehouseSegmentConnectionTest · WarehouseSegmentList · WarehouseSegmentOptions · WarehouseSegmentPreview · WarehouseSegmentRunList · WarehouseTables · WebCampaign · WebCampaignPage · WebCampaignReport · WebCampaignStatusDto · WebCampaignWinnerDto · Webhook · WebhookBulkReplayResult · WebhookDeliveryDetail · WebhookDeliveryPage · WebhookEventTypes · WebhookList · WebhookPreviewDto · WebhookPreviewResult · WebhookSecret · WebhookWithSecret · WebPersonalization · WebPersonalizationPage · WebPersonalizationReport · WebPersonalizationStatusDto · WebPersonalizationWinnerDto · WhatsAppTemplateList · WhatsAppTemplateSync · ZapierHook · ZapierHookList · ZapierMe · ZapierSamples · ZapierSubscribeDto
AcceptInviteResult
| Field | Type | Required | Description |
|---|---|---|---|
org_id | string | Yes | |
org_slug | string | Yes | |
role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
Account
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
email | string | Yes | |
name | string | Yes | |
locale | string | Yes | |
timezone | string | Yes | |
email_verified | boolean | Yes | |
mfa_enabled | boolean | Yes | |
is_platform_admin | boolean | Yes | |
has_password | boolean | Yes | |
marketing_opt_in | boolean | Yes | |
preferences | object | Yes | |
preferences.date_format | enum | Yes | Values: "auto", "dmy", "mdy", "iso" |
preferences.time_format | enum | Yes | Values: "auto", "24h", "12h" |
preferences.table_density | enum | Yes | Values: "comfortable", "compact" |
created_at | string | Yes |
AccountExport
| Field | Type | Required | Description |
|---|---|---|---|
format_version | integer | Yes | |
generated_at | string | Yes | |
account | object | Yes | |
account.id | string | Yes | |
account.email | string | Yes | |
account.name | string | Yes | |
account.locale | string | Yes | |
account.timezone | string | Yes | |
account.status | string | Yes | |
account.email_verified_at | string | null | Yes | |
account.has_password | boolean | Yes | |
account.mfa_enabled | boolean | Yes | |
account.is_platform_admin | boolean | Yes | |
account.last_login_at | string | null | Yes | |
account.preferences | object | Yes | |
account.preferences.date_format | enum | Yes | Values: "auto", "dmy", "mdy", "iso" |
account.preferences.time_format | enum | Yes | Values: "auto", "24h", "12h" |
account.preferences.table_density | enum | Yes | Values: "comfortable", "compact" |
account.created_at | string | Yes | |
account.updated_at | string | Yes | |
consents | object | Yes | |
consents.terms_accepted_at | string | null | Yes | |
consents.terms_version | string | null | Yes | |
consents.marketing_opt_in | boolean | Yes | |
consents.marketing_opt_in_at | string | null | Yes | |
memberships | array<object> | Yes | |
memberships[].org_id | string | Yes | |
memberships[].org_name | string | Yes | |
memberships[].org_slug | string | Yes | |
memberships[].role | string | Yes | |
memberships[].is_primary_owner | boolean | Yes | |
memberships[].app_scopes | array<string> | Yes | |
memberships[].joined_at | string | Yes | |
sessions | array<object> | Yes | |
sessions[].id | string | Yes | |
sessions[].ip | string | null | Yes | |
sessions[].user_agent | string | null | Yes | |
sessions[].auth_method | string | Yes | |
sessions[].persistent | boolean | Yes | |
sessions[].created_at | string | Yes | |
sessions[].last_seen_at | string | Yes | |
sessions[].expires_at | string | Yes | |
sessions[].revoked_at | string | null | Yes | |
identities | array<object> | Yes | |
identities[].provider | string | Yes | |
identities[].provider_user_id | string | Yes | |
identities[].email | string | null | Yes | |
identities[].created_at | string | Yes | |
mfa_factors | array<object> | Yes | |
mfa_factors[].type | string | Yes | |
mfa_factors[].verified_at | string | null | Yes | |
mfa_factors[].last_used_at | string | null | Yes | |
mfa_factors[].created_at | string | Yes | |
oauth_grants | array<object> | Yes | |
oauth_grants[].client_name | string | Yes | |
oauth_grants[].org_id | string | Yes | |
oauth_grants[].app_id | string | null | Yes | |
oauth_grants[].scopes | array<string> | Yes | |
oauth_grants[].created_at | string | Yes | |
oauth_grants[].revoked_at | string | null | Yes | |
audit_entries | array<object> | Yes | |
audit_entries[].org_id | string | Yes | |
audit_entries[].app_id | string | null | Yes | |
audit_entries[].action | string | Yes | |
audit_entries[].target_type | string | null | Yes | |
audit_entries[].target_id | string | null | Yes | |
audit_entries[].metadata | map<string, any> | Yes | |
audit_entries[].ip | string | null | Yes | |
audit_entries[].created_at | string | Yes |
AdAccount
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
external_id | string | Yes | |
name | string | Yes | |
currency | string | null | Yes | |
timezone | string | null | Yes | |
status | enum | Yes | Values: "active", "error", "revoked" |
scopes | array<string> | Yes | |
login_customer_id | string | null | Yes | |
token_expires_at | string | null | Yes | |
last_refreshed_at | string | null | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
terms_accepted_at | string | null | Yes | |
terms_version | string | null | Yes | |
audiences | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
AdAccountList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].external_id | string | Yes | |
data[].name | string | Yes | |
data[].currency | string | null | Yes | |
data[].timezone | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "error", "revoked" |
data[].scopes | array<string> | Yes | |
data[].login_customer_id | string | null | Yes | |
data[].token_expires_at | string | null | Yes | |
data[].last_refreshed_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].terms_accepted_at | string | null | Yes | |
data[].terms_version | string | null | Yes | |
data[].audiences | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/accounts
AdAttributionReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
model | enum | Yes | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
currency | string | Yes | |
group_by | string | Yes | |
conversion_events | array<string> | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].channel | enum | Yes | Values: "meta", "google", "tiktok", "linkedin", "microsoft", "other_paid", "utm", "push", "email", "sms", "whatsapp", "rcs", "direct" |
rows[].label | string | Yes | |
rows[].paid | boolean | Yes | |
rows[].conversions | number | Yes | |
rows[].revenue | number | Yes | |
rows[].new_customers | number | Yes | |
rows[].spend | number | null | Yes | |
rows[].roas | number | null | Yes | |
rows[].cac | number | null | Yes | |
totals | object | Yes | |
totals.conversions | number | Yes | |
totals.revenue | number | Yes | |
totals.spend | number | Yes | |
totals.new_customers | number | Yes | |
totals.roas | number | null | Yes | |
totals.platform_roas | number | null | Yes | |
totals.cac | number | null | Yes | |
totals.paid_cac | number | null | Yes | |
truncated | boolean | Yes | |
fx_missing | array<string> | Yes |
Used by: GET /v1/apps/{appId}/ads/reports/attribution
AdAudience
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
source | enum | Yes | Values: "segment", "journey", "lookalike" |
segment_id | string | null | Yes | |
segment_name | string | null | Yes | |
name | string | Yes | |
description | string | null | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "pending", "active", "paused", "error" |
identifiers | array<enum> | Yes | |
sync_interval_minutes | integer | Yes | |
next_sync_at | string | null | Yes | |
last_synced_at | string | null | Yes | |
last_sync_status | enum | null | Yes | |
full_reload_requested | boolean | Yes | |
member_count | integer | Yes | |
estimated_size | integer | null | Yes | |
match_rate | number | null | Yes | |
size_updated_at | string | null | Yes | |
lookalike_source_id | string | null | Yes | |
lookalike_spec | object | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/ads/audiences, GET /v1/apps/{appId}/ads/audiences/{audienceId}, PATCH /v1/apps/{appId}/ads/audiences/{audienceId}, POST /v1/apps/{appId}/ads/audiences/{audienceId}/lookalikes
AdAudienceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].ad_account_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].source | enum | Yes | Values: "segment", "journey", "lookalike" |
data[].segment_id | string | null | Yes | |
data[].segment_name | string | null | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "active", "paused", "error" |
data[].identifiers | array<enum> | Yes | |
data[].sync_interval_minutes | integer | Yes | |
data[].next_sync_at | string | null | Yes | |
data[].last_synced_at | string | null | Yes | |
data[].last_sync_status | enum | null | Yes | |
data[].full_reload_requested | boolean | Yes | |
data[].member_count | integer | Yes | |
data[].estimated_size | integer | null | Yes | |
data[].match_rate | number | null | Yes | |
data[].size_updated_at | string | null | Yes | |
data[].lookalike_source_id | string | null | Yes | |
data[].lookalike_spec | object | null | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/audiences
AdAudienceSyncList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].audience_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual", "journey" |
data[].mode | enum | Yes | Values: "incremental", "full" |
data[].status | enum | Yes | Values: "running", "succeeded", "partial", "failed" |
data[].added | integer | Yes | |
data[].removed | integer | Yes | |
data[].failed | integer | Yes | |
data[].skipped_no_consent | integer | Yes | |
data[].skipped_no_identifier | integer | Yes | |
data[].batches | integer | Yes | |
data[].retries | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes |
Used by: GET /v1/apps/{appId}/ads/audiences/{audienceId}/syncs
AdAudienceSyncQueued
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes | |
mode | enum | Yes | Values: "incremental", "full" |
Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/sync
AdBudgetAlertList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].rule_id | string | Yes | |
data[].rule_name | string | Yes | |
data[].kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
data[].day | string | Yes | |
data[].value | number | Yes | |
data[].threshold | number | Yes | |
data[].details | map<string, any> | Yes | |
data[].emailed | integer | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/alerts
AdBudgetAlertRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
ad_account_id | string | null | Yes | |
campaign_external_id | string | null | Yes | |
threshold | number | Yes | |
window_days | integer | Yes | |
recipients | array<string> | Yes | |
enabled | boolean | Yes | |
last_value | number | null | Yes | |
last_evaluated_at | string | null | Yes | |
last_triggered_on | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/ads/alert-rules, PATCH /v1/apps/{appId}/ads/alert-rules/{ruleId}
AdBudgetAlertRuleList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
data[].ad_account_id | string | null | Yes | |
data[].campaign_external_id | string | null | Yes | |
data[].threshold | number | Yes | |
data[].window_days | integer | Yes | |
data[].recipients | array<string> | Yes | |
data[].enabled | boolean | Yes | |
data[].last_value | number | null | Yes | |
data[].last_evaluated_at | string | null | Yes | |
data[].last_triggered_on | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/alert-rules
AdCampaignCreated
| Field | Type | Required | Description |
|---|---|---|---|
campaign | object | Yes | |
campaign.id | string | Yes | |
campaign.app_id | string | Yes | |
campaign.ad_account_id | string | Yes | |
campaign.platform | enum | Yes | Values: "meta", "google", "tiktok" |
campaign.level | enum | Yes | Values: "campaign", "ad_set", "ad" |
campaign.external_id | string | Yes | |
campaign.campaign_external_id | string | Yes | |
campaign.ad_set_external_id | string | null | Yes | |
campaign.name | string | Yes | |
campaign.status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
campaign.platform_status | string | null | Yes | |
campaign.objective | string | null | Yes | |
campaign.optimization_goal | string | null | Yes | |
campaign.currency | string | null | Yes | |
campaign.daily_budget | string | null | Yes | |
campaign.lifetime_budget | string | null | Yes | |
campaign.start_at | string | null | Yes | |
campaign.end_at | string | null | Yes | |
campaign.audience_external_ids | array<string> | Yes | |
campaign.creative | object | null | Yes | |
campaign.budget_editable | boolean | Yes | |
campaign.created_by_pushizo | boolean | Yes | |
campaign.last_seen_at | string | null | Yes | |
campaign.platform_url | string | Yes | |
campaign.metrics | object | null | Yes | |
campaign.updated_at | string | Yes | |
ad_set_id | string | Yes | |
ad_id | string | null | Yes | |
warnings | array<string> | Yes | |
platform_url | string | Yes |
Used by: POST /v1/apps/{appId}/ads/campaigns
AdCampaignPreview
| Field | Type | Required | Description |
|---|---|---|---|
preview_url | string | null | Yes | |
platform_url | string | Yes | |
creative | object | null | Yes |
Used by: GET /v1/apps/{appId}/ads/campaigns/{entityId}/preview
AdCapiConfig
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
name | string | Yes | |
ad_account_id | string | null | Yes | |
enabled | boolean | Yes | |
settings | object | Yes | |
settings.pixel_id | string | null | Yes | |
settings.customer_id | string | null | Yes | |
settings.login_customer_id | string | null | Yes | |
settings.pixel_code | string | null | Yes | |
event_mappings | array<object> | Yes | |
event_mappings[].event_name | string | Yes | |
event_mappings[].platform_event | string | Yes | |
event_mappings[].value_property | string | null | Yes | |
event_mappings[].currency_property | string | null | Yes | |
test_event_code | string | null | Yes | |
test_mode | boolean | Yes | |
action_source | enum | Yes | Values: "website", "app" |
default_currency | string | Yes | |
has_access_token | boolean | Yes | |
last_sent_at | string | null | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
stats | object | Yes | |
stats.pending | integer | Yes | |
stats.sent | integer | Yes | |
stats.failed | integer | Yes | |
stats.skipped | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
AdCapiConfigList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].name | string | Yes | |
data[].ad_account_id | string | null | Yes | |
data[].enabled | boolean | Yes | |
data[].settings | object | Yes | |
data[].settings.pixel_id | string | null | Yes | |
data[].settings.customer_id | string | null | Yes | |
data[].settings.login_customer_id | string | null | Yes | |
data[].settings.pixel_code | string | null | Yes | |
data[].event_mappings | array<object> | Yes | |
data[].event_mappings[].event_name | string | Yes | |
data[].event_mappings[].platform_event | string | Yes | |
data[].event_mappings[].value_property | string | null | Yes | |
data[].event_mappings[].currency_property | string | null | Yes | |
data[].test_event_code | string | null | Yes | |
data[].test_mode | boolean | Yes | |
data[].action_source | enum | Yes | Values: "website", "app" |
data[].default_currency | string | Yes | |
data[].has_access_token | boolean | Yes | |
data[].last_sent_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.pending | integer | Yes | |
data[].stats.sent | integer | Yes | |
data[].stats.failed | integer | Yes | |
data[].stats.skipped | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/conversions-api/configs
AdCapiDelivery
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
config_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
event_id | string | Yes | |
event_name | string | Yes | |
platform_event | string | Yes | |
dedup_id | string | Yes | |
user_id | string | null | Yes | |
value | number | null | Yes | |
currency | string | null | Yes | |
status | enum | Yes | Values: "pending", "sent", "failed", "skipped" |
skip_reason | string | null | Yes | |
attempts | integer | Yes | |
next_attempt_at | string | null | Yes | |
last_error | string | null | Yes | |
test | boolean | Yes | |
event_occurred_at | string | Yes | |
sent_at | string | null | Yes | |
created_at | string | Yes |
Used by: POST /v1/apps/{appId}/ads/conversions-api/deliveries/{deliveryId}/retry
AdCapiDeliveryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].config_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].event_id | string | Yes | |
data[].event_name | string | Yes | |
data[].platform_event | string | Yes | |
data[].dedup_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].value | number | null | Yes | |
data[].currency | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "sent", "failed", "skipped" |
data[].skip_reason | string | null | Yes | |
data[].attempts | integer | Yes | |
data[].next_attempt_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].test | boolean | Yes | |
data[].event_occurred_at | string | Yes | |
data[].sent_at | string | null | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/conversions-api/deliveries
AdCapiTestResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
response | map<string, any> | Yes |
Used by: POST /v1/apps/{appId}/ads/conversions-api/configs/{configId}/test
AdCreative
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
file_name | string | null | Yes | |
content_type | string | Yes | |
bytes | integer | Yes | |
width | integer | null | Yes | |
height | integer | null | Yes | |
preview_url | string | Yes | |
created_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/creatives, POST /v1/apps/{appId}/ads/creatives
AddAliasDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Used by: PATCH /v1/apps/{appId}/users/by/{label}/{value}/identity
AddSubscriptionDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | Length: 1–4096 |
device | object | No | Default: {} |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
status | enum | No | Values: "subscribed", "unsubscribed" |
opt_in | object | No | |
opt_in.source | string | Yes | Length: 1–100 |
opt_in.at | string (date-time) | No |
Used by: POST /v1/apps/{appId}/users/by/{label}/{value}/subscriptions
AdEntity
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
level | enum | Yes | Values: "campaign", "ad_set", "ad" |
external_id | string | Yes | |
campaign_external_id | string | Yes | |
ad_set_external_id | string | null | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
platform_status | string | null | Yes | |
objective | string | null | Yes | |
optimization_goal | string | null | Yes | |
currency | string | null | Yes | |
daily_budget | string | null | Yes | |
lifetime_budget | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
audience_external_ids | array<string> | Yes | |
creative | object | null | Yes | |
budget_editable | boolean | Yes | |
created_by_pushizo | boolean | Yes | |
last_seen_at | string | null | Yes | |
platform_url | string | Yes | |
metrics | object | null | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ads/campaigns/{entityId}, PATCH /v1/apps/{appId}/ads/campaigns/{entityId}
AdEntityList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].ad_account_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].level | enum | Yes | Values: "campaign", "ad_set", "ad" |
data[].external_id | string | Yes | |
data[].campaign_external_id | string | Yes | |
data[].ad_set_external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
data[].platform_status | string | null | Yes | |
data[].objective | string | null | Yes | |
data[].optimization_goal | string | null | Yes | |
data[].currency | string | null | Yes | |
data[].daily_budget | string | null | Yes | |
data[].lifetime_budget | string | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].audience_external_ids | array<string> | Yes | |
data[].creative | object | null | Yes | |
data[].budget_editable | boolean | Yes | |
data[].created_by_pushizo | boolean | Yes | |
data[].last_seen_at | string | null | Yes | |
data[].platform_url | string | Yes | |
data[].metrics | object | null | Yes | |
data[].updated_at | string | Yes | |
from | string | Yes | |
to | string | Yes | |
accounts | array<object> | Yes | |
accounts[].id | string | Yes | |
accounts[].campaigns_synced_at | string | null | Yes | |
accounts[].insights_synced_at | string | null | Yes | |
accounts[].campaigns_sync_error | string | null | Yes | |
accounts[].insights_sync_error | string | null | Yes |
Used by: GET /v1/apps/{appId}/ads/campaigns
AdLtvReport
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | |
months | integer | Yes | |
conversion_events | array<string> | Yes | |
cohorts | array<object> | Yes | |
cohorts[].cohort | string | Yes | |
cohorts[].size | integer | Yes | |
cohorts[].revenue | array<number> | Yes | |
cohorts[].ltv | array<number> | Yes | |
average | array<number | null> | Yes | |
fx_missing | array<string> | Yes |
Used by: GET /v1/apps/{appId}/ads/reports/ltv
AdOAuthPending
| Field | Type | Required | Description |
|---|---|---|---|
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
scopes | array<string> | Yes | |
accounts | array<object> | Yes | |
accounts[].external_id | string | Yes | |
accounts[].name | string | Yes | |
accounts[].currency | string | null | Yes | |
accounts[].timezone | string | null | Yes | |
accounts[].status | string | null | Yes | |
accounts[].manager_id | string | null | Yes | |
accounts[].already_connected | boolean | Yes |
AdOAuthStartResult
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
AdOk
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Used by: DELETE /v1/apps/{appId}/ads/audiences/{audienceId}, DELETE /v1/apps/{appId}/ads/alert-rules/{ruleId}
AdPageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes |
Used by: GET /v1/apps/{appId}/ads/accounts/{accountId}/pages
AdPlatformList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].enabled | boolean | Yes | |
data[].mock | boolean | Yes | |
data[].identifiers | array<enum> | Yes | |
data[].lookalike | boolean | Yes | |
data[].batch_size | integer | Yes |
Used by: GET /v1/apps/{appId}/ads/platforms
AdRefreshQueued
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes |
Used by: POST /v1/apps/{appId}/ads/accounts/{accountId}/refresh
AdReportingSettings
| Field | Type | Required | Description |
|---|---|---|---|
reporting_currency | string | Yes | |
attribution_model | enum | Yes | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
conversion_events | array<string> | Yes | |
effective_conversion_events | array<string> | Yes | |
fx | object | Yes | |
fx.latest_day | string | null | Yes | |
fx.source | string | null | Yes |
Used by: GET /v1/apps/{appId}/ads/settings, PUT /v1/apps/{appId}/ads/settings
AdReportingSettingsInputDto
| Field | Type | Required | Description |
|---|---|---|---|
reporting_currency | string | No | |
attribution_model | enum | No | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | No | Range: 1–90 |
half_life_days | integer | No | Range: 1–30 |
conversion_events | array<string> | No | Items: 0–20 |
Used by: PUT /v1/apps/{appId}/ads/settings
AdSpendReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
currency | string | Yes | |
group_by | string | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].label | string | Yes | |
rows[].platform | string | null | Yes | |
rows[].impressions | number | Yes | |
rows[].clicks | number | Yes | |
rows[].spend | number | Yes | |
rows[].conversions | number | Yes | |
rows[].conversion_value | number | Yes | |
rows[].ctr | number | null | Yes | |
rows[].cpc | number | null | Yes | |
rows[].cpa | number | null | Yes | |
rows[].roas | number | null | Yes | |
totals | object | Yes | |
totals.impressions | number | Yes | |
totals.clicks | number | Yes | |
totals.spend | number | Yes | |
totals.conversions | number | Yes | |
totals.conversion_value | number | Yes | |
totals.ctr | number | null | Yes | |
totals.cpc | number | null | Yes | |
totals.cpa | number | null | Yes | |
totals.roas | number | null | Yes | |
fx_missing | array<string> | Yes | |
store | enum | Yes | Values: "postgres", "clickhouse" |
Used by: GET /v1/apps/{appId}/ads/reports/spend
AffinityConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
attributes | array<string> | Yes | |
events | map<string, number> | Yes | |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Used by: GET /v1/apps/{appId}/affinity/config, PUT /v1/apps/{appId}/affinity/config, POST /v1/apps/{appId}/affinity/compute
AffinityOverview
| Field | Type | Required | Description |
|---|---|---|---|
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
attributes | array<object> | Yes | |
attributes[].attribute | string | Yes | |
attributes[].values | array<object> | Yes | |
attributes[].values[].value | string | Yes | |
attributes[].values[].users | integer | Yes | |
attributes[].values[].top_users | integer | Yes |
Used by: GET /v1/apps/{appId}/affinity/overview
AgentUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
max_concurrent | integer | null | No | |
languages | array<string> | No | Items: 0–20 |
Used by: PATCH /v1/apps/{appId}/inbox/agents/{accountId}
AiAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ai-agents/{agentId}, PATCH /v1/apps/{appId}/ai-agents/{agentId}
AiAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].enabled | boolean | Yes | |
data[].channels | array<enum> | Yes | |
data[].instructions | string | Yes | |
data[].faq | array<object> | Yes | |
data[].faq[].question | string | Yes | |
data[].faq[].answer | string | Yes | |
data[].tools | array<object> | Yes | |
data[].tools[].name | string | Yes | |
data[].tools[].description | string | Yes | |
data[].tools[].url | string | Yes | |
data[].tools[].params | array<object> | Yes | |
data[].handoff | object | Yes | |
data[].handoff.keywords | array<string> | Yes | |
data[].handoff.max_bot_replies | integer | Yes | |
data[].handoff.on_negative_sentiment | boolean | Yes | |
data[].handoff.message | string | Yes | |
data[].limits | object | Yes | |
data[].limits.monthly_token_cap | integer | Yes | |
data[].limits.max_steps | integer | Yes | |
data[].ai_sentiment | boolean | Yes | |
data[].has_tool_secret | boolean | Yes | |
data[].usage | object | Yes | |
data[].usage.tokens_this_month | integer | Yes | |
data[].usage.period_start | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/ai-agents
AiAgentMetrics
| Field | Type | Required | Description |
|---|---|---|---|
period_days | integer | Yes | |
runs | integer | Yes | |
replied | integer | Yes | |
handed_off | integer | Yes | |
skipped_cap | integer | Yes | |
failed | integer | Yes | |
conversations | integer | Yes | |
resolution_rate | number | Yes | |
avg_steps | number | Yes | |
tool_calls | integer | Yes | |
tool_error_rate | number | Yes | |
tokens | integer | Yes | |
handoff_reasons | map<string, integer> | Yes |
Used by: GET /v1/apps/{appId}/ai-agents/{agentId}/metrics
AiAgentRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].conversation_id | string | Yes | |
data[].status | enum | Yes | Values: "pending", "replied", "handed_off", "skipped_cap", "failed" |
data[].steps | array<object> | Yes | |
data[].steps[].kind | enum | Yes | Values: "reply", "tool", "handoff" |
data[].steps[].tool | string | No | |
data[].steps[].status | integer | null | No | |
data[].steps[].ok | boolean | No | |
data[].steps[].duration_ms | integer | No | |
data[].input_tokens | integer | Yes | |
data[].output_tokens | integer | Yes | |
data[].handoff_reason | string | null | Yes | |
data[].error | string | null | Yes | |
data[].created_at | string | Yes | |
data[].finished_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/ai-agents/runs
AiAgentWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
tool_secret | string | null | Yes |
Used by: POST /v1/apps/{appId}/ai-agents, POST /v1/apps/{appId}/ai-agents/{agentId}/rotate-secret
AiConversationSummary
| Field | Type | Required | Description |
|---|---|---|---|
summary | string | Yes | |
key_points | array<string> | Yes | |
sentiment | enum | Yes | Values: "positive", "neutral", "negative" |
meta | object | Yes | |
meta.model | string | Yes | |
meta.messages | integer | Yes |
AiGlossaryEntry
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
term | string | Yes | |
translations | map<string, string> | Yes | |
note | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
AiGlossaryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].term | string | Yes | |
data[].translations | map<string, string> | Yes | |
data[].note | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
AiPanelApplyResult
| Field | Type | Required | Description |
|---|---|---|---|
segment_id | string | null | Yes | |
campaign_id | string | null | Yes | |
journey_id | string | null | Yes |
AiPanelResult
| Field | Type | Required | Description |
|---|---|---|---|
answer | string | Yes | |
segment | object | null | Yes | |
campaign | object | null | Yes | |
journey | object | null | Yes | |
journey_edit | object | null | Yes | |
meta | object | Yes | |
meta.model | string | Yes |
AiReplySuggestions
| Field | Type | Required | Description |
|---|---|---|---|
suggestions | array<object> | Yes | |
suggestions[].text | string | Yes | |
meta | object | Yes | |
meta.model | string | Yes | |
meta.filtered | integer | Yes | |
meta.messages | integer | Yes |
AiSettings
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
monthly_token_quota | integer | Yes | |
banned_phrases | array<string> | Yes | |
provider | enum | Yes | Values: "anthropic", "openrouter", "mock" |
available | boolean | Yes | |
models | object | Yes | |
models.default | string | Yes | |
models.long | string | Yes | |
usage | object | Yes | |
usage.used_tokens | integer | Yes | |
usage.quota_tokens | integer | Yes | |
usage.period_start | string | Yes |
AiStatus
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
available | boolean | Yes | |
provider | enum | Yes | Values: "anthropic", "openrouter", "mock" |
usage | object | Yes | |
usage.used_tokens | integer | Yes | |
usage.quota_tokens | integer | Yes | |
usage.period_start | string | Yes | |
languages | array<string> | Yes | |
default_language | string | Yes | |
field_limits | map<string, integer> | Yes | |
pending_translations | integer | Yes |
AiSubjectScoreResult
| Field | Type | Required | Description |
|---|---|---|---|
score | integer | Yes | |
reasons | array<string> | Yes | |
improved | array<string> | Yes | |
meta | object | Yes | |
meta.model | string | Yes | |
meta.filtered | integer | Yes | |
meta.warnings | array<string> | Yes |
AiSuggestions
| Field | Type | Required | Description |
|---|---|---|---|
suggestions | array<object> | Yes | |
suggestions[].text | string | Yes | |
suggestions[].length | integer | Yes | |
meta | object | Yes | |
meta.model | string | Yes | |
meta.filtered | integer | Yes | |
meta.warnings | array<string> | Yes |
AiTranslateResult
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].source_language | string | Yes | |
data[].target_language | string | Yes | |
data[].source | object | Yes | |
data[].source.headings | string | No | |
data[].source.contents | string | No | |
data[].source.subtitle | string | No | |
data[].source.email_subject | string | No | |
data[].source.email_preheader | string | No | |
data[].result | object | Yes | |
data[].result.headings | string | No | |
data[].result.contents | string | No | |
data[].result.subtitle | string | No | |
data[].result.email_subject | string | No | |
data[].result.email_preheader | string | No | |
data[].status | enum | Yes | Values: "pending", "approved", "rejected" |
data[].ref_type | string | null | Yes | |
data[].ref_id | string | null | Yes | |
data[].warnings | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].reviewed_at | string | null | Yes | |
data[].reviewed_by | string | null | Yes | |
meta | object | Yes | |
meta.model | string | Yes | |
meta.filtered | integer | Yes | |
meta.warnings | array<string> | Yes |
AiTranslation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
source_language | string | Yes | |
target_language | string | Yes | |
source | object | Yes | |
source.headings | string | No | |
source.contents | string | No | |
source.subtitle | string | No | |
source.email_subject | string | No | |
source.email_preheader | string | No | |
result | object | Yes | |
result.headings | string | No | |
result.contents | string | No | |
result.subtitle | string | No | |
result.email_subject | string | No | |
result.email_preheader | string | No | |
status | enum | Yes | Values: "pending", "approved", "rejected" |
ref_type | string | null | Yes | |
ref_id | string | null | Yes | |
warnings | array<string> | Yes | |
created_at | string | Yes | |
reviewed_at | string | null | Yes | |
reviewed_by | string | null | Yes |
AiTranslationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].source_language | string | Yes | |
data[].target_language | string | Yes | |
data[].source | object | Yes | |
data[].source.headings | string | No | |
data[].source.contents | string | No | |
data[].source.subtitle | string | No | |
data[].source.email_subject | string | No | |
data[].source.email_preheader | string | No | |
data[].result | object | Yes | |
data[].result.headings | string | No | |
data[].result.contents | string | No | |
data[].result.subtitle | string | No | |
data[].result.email_subject | string | No | |
data[].result.email_preheader | string | No | |
data[].status | enum | Yes | Values: "pending", "approved", "rejected" |
data[].ref_type | string | null | Yes | |
data[].ref_id | string | null | Yes | |
data[].warnings | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].reviewed_at | string | null | Yes | |
data[].reviewed_by | string | null | Yes |
AiUsageReport
| Field | Type | Required | Description |
|---|---|---|---|
period_start | string | Yes | |
used_tokens | integer | Yes | |
quota_tokens | integer | Yes | |
by_feature | array<object> | Yes | |
by_feature[].feature | string | Yes | |
by_feature[].model | string | Yes | |
by_feature[].requests | integer | Yes | |
by_feature[].input_tokens | integer | Yes | |
by_feature[].output_tokens | integer | Yes |
AiVariantsResult
| Field | Type | Required | Description |
|---|---|---|---|
variants | array<object> | Yes | |
variants[].name | string | Yes | |
variants[].title | string | Yes | |
variants[].body | string | Yes | |
variants[].rationale | string | Yes | |
meta | object | Yes | |
meta.model | string | Yes | |
meta.filtered | integer | Yes | |
meta.warnings | array<string> | Yes |
AndroidDeliveryReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
devices | object | Yes | |
devices.total | integer | Yes | |
devices.reporting | integer | Yes | |
devices.reporting_rate | number | null | Yes | |
devices.restricted | integer | Yes | |
devices.restricted_rate | number | null | Yes | |
devices.background_restricted | integer | Yes | |
devices.battery_optimized | integer | Yes | |
devices.low_standby_bucket | integer | Yes | |
devices.power_save | integer | Yes | |
devices.data_saver | integer | Yes | |
devices.channel_blocked | integer | Yes | |
devices.notifications_blocked | integer | Yes | |
devices.aggressive_vendor | integer | Yes | |
devices.aggressive_vendor_rate | number | null | Yes | |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.delivered | integer | Yes | |
totals.opened | integer | Yes | |
totals.delivery_rate | number | null | Yes | |
totals.open_rate | number | null | Yes | |
totals.median_delay_seconds | integer | null | Yes | |
totals.p90_delay_seconds | integer | null | Yes | |
previous | object | null | Yes | |
deprioritized | integer | Yes | |
aggressive | object | Yes | |
aggressive.sent | integer | Yes | |
aggressive.delivered | integer | Yes | |
aggressive.delivery_rate | number | null | Yes | |
others | object | Yes | |
others.sent | integer | Yes | |
others.delivered | integer | Yes | |
others.delivery_rate | number | null | Yes | |
vendors | array<object> | Yes | |
vendors[].vendor | string | Yes | |
vendors[].aggressive | boolean | Yes | |
vendors[].devices | integer | Yes | |
vendors[].reporting | integer | Yes | |
vendors[].restricted | integer | Yes | |
vendors[].battery_optimized | integer | Yes | |
vendors[].sent | integer | Yes | |
vendors[].delivered | integer | Yes | |
vendors[].opened | integer | Yes | |
vendors[].delivery_rate | number | null | Yes | |
vendors[].open_rate | number | null | Yes | |
vendors[].median_delay_seconds | integer | null | Yes | |
vendors[].p90_delay_seconds | integer | null | Yes | |
vendors[].deprioritized | integer | Yes | |
roms | array<object> | Yes | |
roms[].rom | string | Yes | |
roms[].devices | integer | Yes | |
roms[].restricted | integer | Yes | |
roms[].sent | integer | Yes | |
roms[].delivered | integer | Yes | |
roms[].delivery_rate | number | null | Yes | |
roms[].median_delay_seconds | integer | null | Yes | |
recommendations | array<enum> | Yes |
Used by: GET /v1/apps/{appId}/analytics/android-delivery
ApiEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
events | array<object> | Yes | Items: 1–500 |
events[].name | string | Yes | Length: 1–100 |
events[].properties | map<string, any> | No | Default: {} |
events[].value | number | No | |
events[].occurred_at | string (date-time) | No | |
events[].event_id | string | No | Length: 8–64 |
events[].subscription_id | string | No | Length: 1–∞ |
events[].external_id | string | No | Length: 1–255 |
Used by: POST /v1/apps/{appId}/events
ApiKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
name | string | Yes | |
prefix | string | Yes | |
scopes | array<string> | Yes | |
last_used_at | string | null | Yes | |
expires_at | string | null | Yes | |
revoked_at | string | null | Yes | |
ip_allowlist | array<string> | Yes | |
rotated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes |
Used by: PATCH /v1/apps/{appId}/api-keys/{keyId}
ApiKeyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].org_id | string | Yes | |
data[].app_id | string | null | Yes | |
data[].name | string | Yes | |
data[].prefix | string | Yes | |
data[].scopes | array<string> | Yes | |
data[].last_used_at | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].revoked_at | string | null | Yes | |
data[].ip_allowlist | array<string> | Yes | |
data[].rotated_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/api-keys
App
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
platform_flags | object | Yes | |
platform_flags.ios | boolean | No | |
platform_flags.android | boolean | No | |
platform_flags.web | boolean | No | |
platform_flags.email | boolean | No | |
platform_flags.sms | boolean | No | |
icon_url | string | null | Yes | |
default_language | string | Yes | |
timezone | string | Yes | |
settings | object | Yes | |
settings.quietHours | object | null | No | |
settings.frequencyCap | object | null | No | |
settings.frequencyCaps | array<object> | No | Items: 0–10 |
settings.frequencyCaps[].max | integer | Yes | Range: 1–1000 |
settings.frequencyCaps[].window | object | Yes | |
settings.frequencyCaps[].channels | array<enum> | No | Items: 1–12 |
settings.inApp | object | No | |
settings.inApp.minIntervalSeconds | integer | No | Range: 0–604800 |
settings.androidChannels | array<object> | No | Items: 0–50 |
settings.androidChannels[].id | string | Yes | Length: 1–64 |
settings.androidChannels[].name | string | Yes | Length: 1–60 |
settings.androidChannels[].description | string | No | Length: 0–200 |
settings.androidChannels[].importance | enum | Yes | Values: "low", "default", "high", "urgent" |
settings.androidChannels[].sound | string | No | Length: 0–64 |
settings.androidChannels[].vibration | boolean | No | |
settings.androidChannels[].group | string | No | Length: 0–64 |
settings.sms | object | No | |
settings.sms.helpReply | string | No | Length: 0–320 |
settings.sms.stopReply | string | No | Length: 0–320 |
settings.sms.autoReply | boolean | No | |
settings.preferenceCenter | object | No | |
settings.preferenceCenter.enabled | boolean | No | |
settings.preferenceCenter.brandName | string | No | Length: 0–80 |
settings.preferenceCenter.logoUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.accentColor | string | No | |
settings.preferenceCenter.customUnsubscribeUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.texts | map<string, object> | No | |
settings.brandKit | object | No | |
settings.brandKit.website_url | string (url) | No | Length: 0–2000 |
settings.brandKit.name | string | No | Length: 0–80 |
settings.brandKit.primary_color | string | No | |
settings.brandKit.accent_color | string | No | |
settings.brandKit.font | string | No | Length: 0–40 |
settings.brandKit.logo_url | string (url) | No | Length: 0–2000 |
settings.brandKit.tone | string | No | Length: 0–240 |
settings.defaultTtlSeconds | integer | No | Range: 60–2419200 |
settings.identityVerificationRequired | boolean | No | |
settings.ipCapture | enum | No | Values: "off", "full", "masked" |
settings.ipRetentionDays | integer | No | Range: 1–365 |
settings.adaptiveFrequency | object | No | |
settings.adaptiveFrequency.enabled | boolean | Yes | |
settings.adaptiveFrequency.min | integer | Yes | Range: 1–50 |
settings.adaptiveFrequency.max | integer | Yes | Range: 1–50 |
settings.allowedOrigins | array<string> | No | Items: 0–50 |
settings.campaignApprovalRequired | boolean | No | |
settings.webPush | object | No | |
settings.webPush.serviceWorkerPath | string | No | Length: 0–200 |
settings.webPush.serviceWorkerScope | string | No | Length: 0–200 |
settings.webPush.prompt | object | No | |
settings.webPush.welcomeNotification | object | No | |
settings.webPush.clickBehavior | object | No | |
settings.webPush.customLink | object | No | |
settings.webPush.promptBackoffDays | array<integer> | No | Items: 0–10 |
settings.onboarding | object | No | |
settings.onboarding.step | integer | Yes | Range: 0–6 |
settings.onboarding.simulation | boolean | No | |
settings.onboarding.completed_at | string | null | No | |
settings.onboarding.version | integer | No | Range: 1–100 |
settings.onboarding.platforms | array<enum> | No | Items: 0–8 |
settings.onboarding.framework | enum | No | Values: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui" |
settings.onboarding.web_integration | enum | No | Values: "code", "wordpress" |
settings.sdkSetup | object | null | No | |
identity_verification_mode | enum | Yes | Values: "hmac", "jwt", "both" |
status | enum | Yes | Values: "active", "suspended", "deleted" |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps, GET /v1/apps/{appId}, PATCH /v1/apps/{appId}, POST /v1/mcp/apps
AppFlag
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
key | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
enabled | boolean | Yes | |
value_type | enum | Yes | Values: "boolean", "string", "number", "json" |
on_value | boolean | number | string | array<any> | map<string, any> | Yes | |
off_value | boolean | number | string | array<any> | map<string, any> | Yes | |
rollout_percent | integer | Yes | |
segment_id | string | null | Yes | |
rollout_schedule | array<object> | Yes | |
rollout_schedule[].at | string | Yes | |
rollout_schedule[].percent | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/feature-flags, GET /v1/apps/{appId}/feature-flags/{flagId}, PATCH /v1/apps/{appId}/feature-flags/{flagId}
AppFlagEvaluation
| Field | Type | Required | Description |
|---|---|---|---|
flags | map<string, object> | Yes |
Used by: POST /v1/apps/{appId}/feature-flags/evaluate
AppFlagList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].key | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].enabled | boolean | Yes | |
data[].value_type | enum | Yes | Values: "boolean", "string", "number", "json" |
data[].on_value | boolean | number | string | array<any> | map<string, any> | Yes | |
data[].off_value | boolean | number | string | array<any> | map<string, any> | Yes | |
data[].rollout_percent | integer | Yes | |
data[].segment_id | string | null | Yes | |
data[].rollout_schedule | array<object> | Yes | |
data[].rollout_schedule[].at | string | Yes | |
data[].rollout_schedule[].percent | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/feature-flags
AppList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].org_id | string | Yes | |
data[].name | string | Yes | |
data[].slug | string | Yes | |
data[].platform_flags | object | Yes | |
data[].platform_flags.ios | boolean | No | |
data[].platform_flags.android | boolean | No | |
data[].platform_flags.web | boolean | No | |
data[].platform_flags.email | boolean | No | |
data[].platform_flags.sms | boolean | No | |
data[].icon_url | string | null | Yes | |
data[].default_language | string | Yes | |
data[].timezone | string | Yes | |
data[].settings | object | Yes | |
data[].settings.quietHours | object | null | No | |
data[].settings.frequencyCap | object | null | No | |
data[].settings.frequencyCaps | array<object> | No | Items: 0–10 |
data[].settings.inApp | object | No | |
data[].settings.androidChannels | array<object> | No | Items: 0–50 |
data[].settings.sms | object | No | |
data[].settings.preferenceCenter | object | No | |
data[].settings.brandKit | object | No | |
data[].settings.defaultTtlSeconds | integer | No | Range: 60–2419200 |
data[].settings.identityVerificationRequired | boolean | No | |
data[].settings.ipCapture | enum | No | Values: "off", "full", "masked" |
data[].settings.ipRetentionDays | integer | No | Range: 1–365 |
data[].settings.adaptiveFrequency | object | No | |
data[].settings.allowedOrigins | array<string> | No | Items: 0–50 |
data[].settings.campaignApprovalRequired | boolean | No | |
data[].settings.webPush | object | No | |
data[].settings.onboarding | object | No | |
data[].settings.sdkSetup | object | null | No | |
data[].identity_verification_mode | enum | Yes | Values: "hmac", "jwt", "both" |
data[].status | enum | Yes | Values: "active", "suspended", "deleted" |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps
AppTransfer
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
app_name | string | null | Yes | |
from_org | object | Yes | |
from_org.id | string | Yes | |
from_org.name | string | null | Yes | |
from_org.slug | string | null | Yes | |
to_org | object | Yes | |
to_org.id | string | Yes | |
to_org.name | string | null | Yes | |
to_org.slug | string | null | Yes | |
status | enum | Yes | Values: "pending", "completed", "cancelled", "rejected", "failed" |
source_approved_at | string | null | Yes | |
target_approved_at | string | null | Yes | |
completed_at | string | null | Yes | |
failure_reason | string | null | Yes | |
created_at | string | Yes |
AppTransferList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].app_name | string | null | Yes | |
data[].from_org | object | Yes | |
data[].from_org.id | string | Yes | |
data[].from_org.name | string | null | Yes | |
data[].from_org.slug | string | null | Yes | |
data[].to_org | object | Yes | |
data[].to_org.id | string | Yes | |
data[].to_org.name | string | null | Yes | |
data[].to_org.slug | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "completed", "cancelled", "rejected", "failed" |
data[].source_approved_at | string | null | Yes | |
data[].target_approved_at | string | null | Yes | |
data[].completed_at | string | null | Yes | |
data[].failure_reason | string | null | Yes | |
data[].created_at | string | Yes |
AssignmentRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
position | integer | Yes | |
conditions | object | Yes | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | Yes | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | Yes | |
agent_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/inbox/assignment-rules, PATCH /v1/apps/{appId}/inbox/assignment-rules/{ruleId}
AssignmentRuleInputDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
conditions | object | No | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | No | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | No | |
agent_ids | array<string> | No | Items: 0–200 |
Used by: POST /v1/apps/{appId}/inbox/assignment-rules
AssignmentRuleList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].enabled | boolean | Yes | |
data[].position | integer | Yes | |
data[].conditions | object | Yes | |
data[].conditions.channels | array<enum> | No | Items: 0–7 |
data[].conditions.languages | array<string> | No | Items: 0–20 |
data[].conditions.tags | map<string, string> | No | |
data[].strategy | enum | Yes | Values: "round_robin", "least_busy", "team_only" |
data[].team_id | string | null | Yes | |
data[].agent_ids | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/inbox/assignment-rules
AssignmentRuleUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
conditions | object | No | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | No | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | No | |
agent_ids | array<string> | No | Items: 0–200 |
Used by: PATCH /v1/apps/{appId}/inbox/assignment-rules/{ruleId}
AuditActions
| Field | Type | Required | Description |
|---|---|---|---|
actions | array<string> | Yes |
AuditEntry
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
actor_type | enum | Yes | Values: "account", "api_key", "system" |
actor_id | string | null | Yes | |
action | string | Yes | |
target_type | string | null | Yes | |
target_id | string | null | Yes | |
metadata | map<string, any> | Yes | |
ip | string | null | Yes | |
request_id | string | null | Yes | |
created_at | string | Yes |
AuditPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].org_id | string | Yes | |
data[].app_id | string | null | Yes | |
data[].actor_type | enum | Yes | Values: "account", "api_key", "system" |
data[].actor_id | string | null | Yes | |
data[].action | string | Yes | |
data[].target_type | string | null | Yes | |
data[].target_id | string | null | Yes | |
data[].metadata | map<string, any> | Yes | |
data[].ip | string | null | Yes | |
data[].request_id | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/organization/audit-logs
AuthConfig
| Field | Type | Required | Description |
|---|---|---|---|
turnstile_site_key | string | null | Yes |
BatchMembersDto
| Field | Type | Required | Description |
|---|---|---|---|
members | array<object> | Yes | Items: 1–1000 |
members[].user_id | string | No | Length: 1–64 |
members[].external_id | string | No | Length: 1–255 |
members[].role | string | No |
Used by: POST /v1/apps/{appId}/companies/{companyId}/members/batch
BatchUpsertCompaniesDto
| Field | Type | Required | Description |
|---|---|---|---|
companies | array<object> | Yes | Items: 1–1000 |
companies[].external_id | string | Yes | |
companies[].name | string | null | No | |
companies[].domain | string | null | No | |
companies[].properties | map<string, any> | No |
Used by: POST /v1/apps/{appId}/companies/batch
BillingStatus
| Field | Type | Required | Description |
|---|---|---|---|
org_id | string | Yes | |
provider | string | Yes | stripe | iyzico | creem | mock | none (no payment provider configured; checkout/portal returns 503) |
plan | object | Yes | |
plan.code | string | Yes | |
plan.name | string | Yes | |
plan.monthly_price | integer | Yes | |
plan.currency | string | Yes | |
plan.prices | object | No | |
plan.prices.USD | integer | Yes | |
plan.prices.TRY | integer | Yes | |
plan.position | integer | Yes | |
plan.is_public | boolean | Yes | |
plan.limits | object | Yes | |
plan.limits.subscriptions | integer | null | Yes | |
plan.limits.messages_per_month | integer | null | Yes | |
plan.limits.api_rps | integer | null | Yes | |
plan.limits.members | integer | null | Yes | |
plan.limits.apps | integer | null | Yes | |
plan.limits.retention_days | integer | null | Yes | |
plan.limits.journeys | integer | null | Yes | |
plan.limits.segments | integer | null | Yes | |
plan.limits.ab_variants | integer | null | Yes | |
plan.limits.tags_per_user | integer | null | Yes | |
plan.limits.aliases_per_user | integer | null | Yes | |
plan.limits.subscriptions_per_user | integer | null | Yes | |
plan.limits.report_history_days | integer | null | Yes | |
plan.limits.webhooks | integer | null | Yes | |
plan.limits.api_keys | integer | null | Yes | |
plan.limits.mau | integer | null | No | |
plan.limits.emails_per_month | integer | null | No | |
plan.limits.sms_per_month | integer | null | No | |
plan.limits.whatsapp_conversations_per_month | integer | null | No | |
plan.limits.rcs_messages_per_month | integer | null | No | |
plan.limits.ai_credits_per_month | integer | null | No | |
plan.limits.data_feeds | integer | null | No | |
plan.limits.content_tables | integer | null | No | |
plan.limits.event_streams | integer | null | No | |
plan.limits.warehouse_destinations | integer | null | No | |
plan.limits.custom_domains | integer | null | No | |
plan.features | object | Yes | |
plan.features.journeys | boolean | Yes | |
plan.features.ab_testing | boolean | Yes | |
plan.features.email | boolean | Yes | |
plan.features.sms | boolean | Yes | |
plan.features.in_app | boolean | Yes | |
plan.features.approval_flow | boolean | Yes | |
plan.features.sso | boolean | Yes | |
plan.features.scim | boolean | No | |
plan.features.audit_export | boolean | Yes | |
plan.features.white_label | boolean | No | |
plan.features.hide_powered_by | boolean | No | |
plan.features.reseller | boolean | No | |
plan.features.whatsapp | boolean | No | |
plan.features.rcs | boolean | No | |
plan.features.live_activities | boolean | No | |
plan.features.inbox | boolean | No | |
plan.features.ai_assistant | boolean | No | |
plan.features.dynamic_content | boolean | No | |
plan.features.event_streams | boolean | No | |
plan.features.warehouse_export | boolean | No | |
plan.features.custom_domain | boolean | No | |
plan.features.data_residency | boolean | No | |
plan.features.priority_support | boolean | No | |
plan.features.mcp_server | boolean | No | |
plan.features.overage | boolean | No | |
plan.features.roles | array<string> | Yes | |
plan.purchasable | boolean | Yes | |
effective_plan_code | string | Yes | |
trialing | boolean | Yes | |
trial_ends_at | string | null | Yes | |
suspended | boolean | Yes | |
suspended_reason | string | null | Yes | |
subscription | object | null | Yes | |
billing_info | object | null | Yes |
Branding
| Field | Type | Required | Description |
|---|---|---|---|
product_name | string | null | Yes | |
logo_url | string | null | Yes | |
primary_color | string | null | Yes | |
secondary_color | string | null | Yes | |
support_email | string | null | Yes | |
hide_powered_by | boolean | Yes | |
effective | object | Yes | |
effective.product_name | string | Yes | |
effective.logo_url | string | null | Yes | |
effective.primary_color | string | null | Yes | |
effective.secondary_color | string | null | Yes | |
effective.support_email | string | null | Yes | |
effective.powered_by | boolean | Yes | |
effective.inherited | boolean | Yes | |
features | object | Yes | |
features.white_label | boolean | Yes | |
features.hide_powered_by | boolean | Yes |
BrandKitExtract
| Field | Type | Required | Description |
|---|---|---|---|
website_url | string | No | |
name | string | No | |
primary_color | string | No | |
accent_color | string | No | |
font | string | No | |
logo_url | string | No | |
tone | string | No |
BrandResolution
| Field | Type | Required | Description |
|---|---|---|---|
kind | enum | Yes | Values: "dashboard", "tracking", "preference_center", "status_page" |
org_slug | string | Yes | |
product_name | string | Yes | |
logo_url | string | null | Yes | |
primary_color | string | null | Yes | |
secondary_color | string | null | Yes | |
support_email | string | null | Yes | |
powered_by | boolean | Yes |
BulkReplayDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "failed", "dead", "failed_or_dead" |
from | string (date-time) | No | |
to | string (date-time) | No |
Used by: POST /v1/apps/{appId}/webhooks/{webhookId}/replay
Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Used by: POST /v1/apps/{appId}/campaigns, GET /v1/apps/{appId}/campaigns/{campaignId}, PATCH /v1/apps/{appId}/campaigns/{campaignId}, POST /v1/apps/{appId}/campaigns/{campaignId}/schedule, POST /v1/apps/{appId}/campaigns/{campaignId}/send, POST /v1/apps/{appId}/campaigns/{campaignId}/pause, POST /v1/apps/{appId}/campaigns/{campaignId}/resume, POST /v1/apps/{appId}/campaigns/{campaignId}/cancel, POST /v1/apps/{appId}/campaigns/{campaignId}/duplicate, POST /v1/apps/{appId}/campaigns/{campaignId}/approve, POST /v1/apps/{appId}/campaigns/{campaignId}/winner, POST /v1/apps/{appId}/campaigns/{campaignId}/resend-failed, …
CampaignAgentConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
goal | enum | Yes | Values: "retention", "revenue", "reactivation", "engagement" |
min_audience | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_run_at | string | null | Yes |
CampaignEmailRisk
| Field | Type | Required | Description |
|---|---|---|---|
applies | boolean | Yes | |
recipients | integer | Yes | |
flagged_invalid | integer | Yes | |
sendable | integer | Yes | |
valid | integer | Yes | |
unknown | integer | Yes | |
unchecked | integer | Yes | |
estimated_invalid_ratio | number | Yes | |
max_invalid_ratio | number | Yes | |
blocked | boolean | Yes | |
bounce_rate_7d | number | null | Yes | |
bounce_rate_30d | number | null | Yes |
Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/email-risk
CampaignPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].labels | array<string> | Yes | |
data[].category | string | null | Yes | |
data[].goals | object | Yes | |
data[].goals.primary | string | No | |
data[].goals.secondary | array<string> | No | |
data[].ab_test | object | Yes | |
data[].ab_test.enabled | boolean | No | |
data[].ab_test.test_percentage | integer | No | Range: 1–100 |
data[].ab_test.winner | object | No | |
data[].ab_test.phase | enum | No | Values: "testing", "winner_sent" |
data[].ab_test.winner_variant_id | string | No | |
data[].ab_test.decided_at | string | No | |
data[].ab_test.decided_by | string | No | |
data[].ab_test.significance | object | No | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].name | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].content | map<string, any> | null | Yes | |
data[].variants[].is_control | boolean | Yes | |
data[].variants[].position | integer | Yes | |
data[].type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
data[].status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
data[].audience | map<string, any> | Yes | |
data[].content | map<string, any> | Yes | |
data[].template_id | string | null | Yes | |
data[].template_version | integer | null | Yes | |
data[].delivery | object | Yes | |
data[].delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
data[].delivery.delivery_time_of_day | string | No | |
data[].delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
data[].delivery.ttl | integer | No | Range: 60–2419200 |
data[].delivery.priority | 5 | 10 | No | |
data[].delivery.collapse_id | string | No | Length: 0–64 |
data[].delivery.frequency_cap_exempt | boolean | No | |
data[].delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
data[].delivery.global_control_exempt | boolean | No | |
data[].delivery.quiet_hours_exempt | boolean | No | |
data[].delivery.one_per_user | boolean | No | |
data[].recurrence | object | null | Yes | |
data[].approval | object | Yes | |
data[].approval.required | boolean | Yes | |
data[].approval.pending_action | enum | No | Values: "send", "schedule" |
data[].approval.requested_by | string | No | |
data[].approval.requested_at | string | No | |
data[].approval.approved_by | string | No | |
data[].approval.approved_at | string | No | |
data[].approval.rejected_by | string | No | |
data[].approval.rejected_at | string | No | |
data[].stats | object | Yes | |
data[].stats.runs | integer | No | |
data[].stats.targeted | integer | No | |
data[].stats.suppressed | integer | No | |
data[].stats.sent | integer | No | |
data[].stats.delivered | integer | No | |
data[].stats.failed | integer | No | |
data[].stats.opened | integer | No | |
data[].stats.clicked | integer | No | |
data[].stats.converted | integer | No | |
data[].stats.bounced | integer | No | |
data[].stats.complained | integer | No | |
data[].stats.unsubscribed | integer | No | |
data[].stats.sms_segments | integer | No | |
data[].send_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].run_count | integer | Yes | |
data[].error | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].completed_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].estimated_recipients | integer | null | Yes | |
data[].preflight | object | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/campaigns
CampaignPreflightReport
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | string | Yes | |
checked_at | string | Yes | |
links_checked | boolean | Yes | |
summary | object | Yes | |
summary.critical | integer | Yes | |
summary.warning | integer | Yes | |
summary.info | integer | Yes | |
summary.blocked | boolean | Yes | |
findings | array<object> | Yes | |
findings[].code | enum | Yes | Values: "brand_name_casing", "off_brand_color", "off_brand_font", "banned_phrase", "phishing_term", "link_invalid", "link_insecure_http", "link_unsafe_host", "link_shortener", "link_missing_utm", "link_broken", "link_unreachable", "liquid_syntax_error", "liquid_missing_default", "liquid_unknown_variable", "liquid_undefined_property", "commercial_no_category", "iys_sms_filter_informational", "sms_missing_opt_out", "email_missing_postal_address", "send_time_outside_hours" |
findings[].category | enum | Yes | Values: "brand", "content", "links", "personalization", "compliance" |
findings[].severity | enum | Yes | Values: "critical", "warning", "info" |
findings[].field | string | No | |
findings[].params | map<string, string | number> | No |
Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/preflight
CampaignProposal
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
kind | enum | Yes | Values: "churn_risk", "likely_to_act", "rfm_at_risk", "inactive_30d", "recent_clickers" |
status | enum | Yes | Values: "pending", "approved", "dismissed", "expired" |
audience_size | integer | Yes | |
model_name | string | null | Yes | |
draft | object | null | Yes | |
segment_id | string | null | Yes | |
campaign_id | string | null | Yes | |
expires_at | string | Yes | |
created_at | string | Yes | |
decided_at | string | null | Yes |
CampaignProposalDraft
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–120 |
title | string | Yes | Length: 1–65 |
body | string | Yes | Length: 1–240 |
language | string | Yes |
CampaignProposalList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kind | enum | Yes | Values: "churn_risk", "likely_to_act", "rfm_at_risk", "inactive_30d", "recent_clickers" |
data[].status | enum | Yes | Values: "pending", "approved", "dismissed", "expired" |
data[].audience_size | integer | Yes | |
data[].model_name | string | null | Yes | |
data[].draft | object | null | Yes | |
data[].segment_id | string | null | Yes | |
data[].campaign_id | string | null | Yes | |
data[].expires_at | string | Yes | |
data[].created_at | string | Yes | |
data[].decided_at | string | null | Yes |
CampaignStats
| Field | Type | Required | Description |
|---|---|---|---|
campaign | object | Yes | |
campaign.id | string | Yes | |
campaign.app_id | string | Yes | |
campaign.name | string | Yes | |
campaign.labels | array<string> | Yes | |
campaign.category | string | null | Yes | |
campaign.goals | object | Yes | |
campaign.goals.primary | string | No | |
campaign.goals.secondary | array<string> | No | |
campaign.ab_test | object | Yes | |
campaign.ab_test.enabled | boolean | No | |
campaign.ab_test.test_percentage | integer | No | Range: 1–100 |
campaign.ab_test.winner | object | No | |
campaign.ab_test.phase | enum | No | Values: "testing", "winner_sent" |
campaign.ab_test.winner_variant_id | string | No | |
campaign.ab_test.decided_at | string | No | |
campaign.ab_test.decided_by | string | No | |
campaign.ab_test.significance | object | No | |
campaign.variants | array<object> | Yes | |
campaign.variants[].id | string | Yes | |
campaign.variants[].name | string | Yes | |
campaign.variants[].weight_percent | integer | Yes | |
campaign.variants[].content | map<string, any> | null | Yes | |
campaign.variants[].is_control | boolean | Yes | |
campaign.variants[].position | integer | Yes | |
campaign.type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
campaign.status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
campaign.audience | map<string, any> | Yes | |
campaign.content | map<string, any> | Yes | |
campaign.template_id | string | null | Yes | |
campaign.template_version | integer | null | Yes | |
campaign.delivery | object | Yes | |
campaign.delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
campaign.delivery.delivery_time_of_day | string | No | |
campaign.delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
campaign.delivery.ttl | integer | No | Range: 60–2419200 |
campaign.delivery.priority | 5 | 10 | No | |
campaign.delivery.collapse_id | string | No | Length: 0–64 |
campaign.delivery.frequency_cap_exempt | boolean | No | |
campaign.delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
campaign.delivery.global_control_exempt | boolean | No | |
campaign.delivery.quiet_hours_exempt | boolean | No | |
campaign.delivery.one_per_user | boolean | No | |
campaign.recurrence | object | null | Yes | |
campaign.approval | object | Yes | |
campaign.approval.required | boolean | Yes | |
campaign.approval.pending_action | enum | No | Values: "send", "schedule" |
campaign.approval.requested_by | string | No | |
campaign.approval.requested_at | string | No | |
campaign.approval.approved_by | string | No | |
campaign.approval.approved_at | string | No | |
campaign.approval.rejected_by | string | No | |
campaign.approval.rejected_at | string | No | |
campaign.stats | object | Yes | |
campaign.stats.runs | integer | No | |
campaign.stats.targeted | integer | No | |
campaign.stats.suppressed | integer | No | |
campaign.stats.sent | integer | No | |
campaign.stats.delivered | integer | No | |
campaign.stats.failed | integer | No | |
campaign.stats.opened | integer | No | |
campaign.stats.clicked | integer | No | |
campaign.stats.converted | integer | No | |
campaign.stats.bounced | integer | No | |
campaign.stats.complained | integer | No | |
campaign.stats.unsubscribed | integer | No | |
campaign.stats.sms_segments | integer | No | |
campaign.send_at | string | null | Yes | |
campaign.next_run_at | string | null | Yes | |
campaign.last_run_at | string | null | Yes | |
campaign.run_count | integer | Yes | |
campaign.error | string | null | Yes | |
campaign.created_by | string | null | Yes | |
campaign.started_at | string | null | Yes | |
campaign.completed_at | string | null | Yes | |
campaign.created_at | string | Yes | |
campaign.updated_at | string | Yes | |
campaign.estimated_recipients | integer | null | Yes | |
campaign.preflight | object | null | Yes | |
rates | object | Yes | |
rates.delivery_rate | number | null | Yes | |
rates.open_rate | number | null | Yes | |
rates.click_rate | number | null | Yes | |
rates.failure_rate | number | null | Yes | |
rates.conversion_rate | number | null | Yes | |
goals | array<object> | Yes | |
goals[].event | string | Yes | |
goals[].primary | boolean | Yes | |
goals[].converted | integer | Yes | |
goals[].conversion_rate | number | null | Yes | |
cards | object | null | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channels[].targeted | integer | Yes | |
channels[].sent | integer | Yes | |
channels[].failed | integer | Yes | |
channels[].opened | integer | Yes | |
channels[].clicked | integer | Yes | |
hourly | array<object> | Yes | |
hourly[].hour | string | Yes | |
hourly[].sent | integer | Yes | |
hourly[].failed | integer | Yes | |
hourly[].opened | integer | Yes | |
hourly[].clicked | integer | Yes | |
errors | array<object> | Yes | |
errors[].code | string | Yes | |
errors[].count | integer | Yes | |
messages | array<object> | Yes | |
messages[].id | string | Yes | |
messages[].app_id | string | Yes | |
messages[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
messages[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
messages[].idempotency_key | string | null | Yes | |
messages[].name | string | null | Yes | |
messages[].content | map<string, any> | Yes | |
messages[].target | map<string, any> | Yes | |
messages[].options | map<string, any> | Yes | |
messages[].labels | array<string> | Yes | |
messages[].category | string | null | Yes | |
messages[].template_id | string | null | Yes | |
messages[].campaign_id | string | null | Yes | |
messages[].variants | array<object> | null | Yes | |
messages[].counts | object | Yes | |
messages[].counts.targeted | integer | No | |
messages[].counts.suppressed | integer | No | |
messages[].counts.sent | integer | No | |
messages[].counts.delivered | integer | No | |
messages[].counts.failed | integer | No | |
messages[].counts.errored | integer | No | |
messages[].counts.expired | integer | No | |
messages[].counts.opened | integer | No | |
messages[].counts.clicked | integer | No | |
messages[].counts.converted | integer | No | |
messages[].counts.bounced | integer | No | |
messages[].counts.complained | integer | No | |
messages[].counts.unsubscribed | integer | No | |
messages[].counts.sms_segments | integer | No | |
messages[].requested_by | object | Yes | |
messages[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
messages[].requested_by.id | string | No | |
messages[].error | string | null | Yes | |
messages[].scheduled_for | string | null | Yes | |
messages[].started_at | string | null | Yes | |
messages[].completed_at | string | null | Yes | |
messages[].created_at | string | Yes | |
messages[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/stats
CampaignVariantStats
| Field | Type | Required | Description |
|---|---|---|---|
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].variant_id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].is_control | boolean | Yes | |
variants[].targeted | integer | Yes | |
variants[].sent | integer | Yes | |
variants[].delivered | integer | Yes | |
variants[].opened | integer | Yes | |
variants[].clicked | integer | Yes | |
variants[].converted | integer | Yes | |
variants[].holdout | integer | Yes | |
variants[].open_rate | number | Yes | |
variants[].click_rate | number | Yes | |
variants[].conversion_rate | number | Yes | |
variants[].goals | array<object> | Yes | |
variants[].goals[].event | string | Yes | |
variants[].goals[].primary | boolean | Yes | |
variants[].goals[].converted | integer | Yes | |
variants[].goals[].conversion_rate | number | Yes | |
leader | string | null | Yes | |
significance | object | Yes | |
significance.p_value | number | Yes | |
significance.significant | boolean | Yes | |
significance.metric | string | Yes |
Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/variants/stats
CannedInputDto
| Field | Type | Required | Description |
|---|---|---|---|
shortcut | string | Yes | |
title | string | Yes | Length: 1–120 |
body | string | Yes | Length: 1–4000 |
language | string | null | No |
Used by: POST /v1/apps/{appId}/canned-responses
CannedResponse
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
shortcut | string | Yes | |
title | string | Yes | |
body | string | Yes | |
language | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/canned-responses, PATCH /v1/apps/{appId}/canned-responses/{cannedId}
CannedResponseList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].shortcut | string | Yes | |
data[].title | string | Yes | |
data[].body | string | Yes | |
data[].language | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/canned-responses
CannedResponseRender
| Field | Type | Required | Description |
|---|---|---|---|
text | string | Yes |
CannedUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
shortcut | string | No | |
title | string | No | Length: 1–120 |
body | string | No | Length: 1–4000 |
language | string | null | No |
Used by: PATCH /v1/apps/{appId}/canned-responses/{cannedId}
Catalog
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
currency | string | Yes | |
item_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/catalogs, GET /v1/apps/{appId}/catalogs/{catalogId}, PATCH /v1/apps/{appId}/catalogs/{catalogId}
CatalogItem
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
title | string | Yes | |
description | string | null | Yes | |
image_url | string | null | Yes | |
url | string | null | Yes | |
price | number | null | Yes | |
sale_price | number | null | Yes | |
currency | string | Yes | |
category | string | null | Yes | |
brand | string | null | Yes | |
in_stock | boolean | Yes | |
attributes | map<string, string> | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/items/{itemId}
CatalogItemsPage
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].title | string | Yes | |
data[].description | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].url | string | null | Yes | |
data[].price | number | null | Yes | |
data[].sale_price | number | null | Yes | |
data[].currency | string | Yes | |
data[].category | string | null | Yes | |
data[].brand | string | null | Yes | |
data[].in_stock | boolean | Yes | |
data[].attributes | map<string, string> | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/items
CatalogList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].currency | string | Yes | |
data[].item_count | integer | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/catalogs
CatalogUpsertResult
| Field | Type | Required | Description |
|---|---|---|---|
catalog | object | Yes | |
catalog.id | string | Yes | |
catalog.app_id | string | Yes | |
catalog.name | string | Yes | |
catalog.description | string | null | Yes | |
catalog.currency | string | Yes | |
catalog.item_count | integer | Yes | |
catalog.liquid | string | Yes | |
catalog.created_at | string | Yes | |
catalog.updated_at | string | Yes | |
upserted | integer | Yes |
Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/items, POST /v1/apps/{appId}/catalogs/{catalogId}/items/upload
CellHandoff
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
expires_at | string | Yes |
CellHandoffResult
| Field | Type | Required | Description |
|---|---|---|---|
account | object | Yes | |
account.id | string | Yes | |
account.email | string | Yes | |
account.name | string | Yes | |
account.locale | string | Yes | |
account.timezone | string | Yes | |
account.email_verified | boolean | Yes | |
account.mfa_enabled | boolean | Yes | |
account.is_platform_admin | boolean | Yes | |
account.has_password | boolean | Yes | |
account.marketing_opt_in | boolean | Yes | |
account.preferences | object | Yes | |
account.preferences.date_format | enum | Yes | Values: "auto", "dmy", "mdy", "iso" |
account.preferences.time_format | enum | Yes | Values: "auto", "24h", "12h" |
account.preferences.table_density | enum | Yes | Values: "comfortable", "compact" |
account.created_at | string | Yes | |
next | string | null | Yes |
CellList
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
current_cell_id | string | null | Yes | |
control_plane | boolean | Yes | |
control_plane_dashboard_url | string | null | Yes | |
cells | array<object> | Yes | |
cells[].id | string | Yes | |
cells[].name | string | Yes | |
cells[].api_url | string | Yes | |
cells[].dashboard_url | string | Yes |
CellOrgList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].slug | string | Yes | |
data[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
data[].region | string | null | Yes | |
data[].dashboard_url | string | null | Yes | |
data[].local | boolean | Yes | |
unavailable_cells | array<string> | Yes |
ChannelConfig
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
provider | enum | null | Yes | |
status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
config | object | Yes | |
config.auth_type | enum | No | Values: "token", "certificate" |
config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
config.certificate_subject | string | No | |
config.certificate_expires_at | string | No | |
config.key_id | string | No | |
config.team_id | string | No | |
config.bundle_id | string | No | |
config.environment | enum | No | Values: "sandbox", "production" |
config.project_id | string | No | |
config.client_email | string | No | |
config.hms_app_id | string | No | |
config.high_priority | boolean | No | |
config.subject | string | No | |
config.vapid_public_key | string | No | |
config.site_url | string | No | |
config.from_address | string | No | |
config.from_name | string | No | |
config.reply_to | string | No | |
config.dkim_selector | string | No | |
config.postal_address | string | No | |
config.host | string | No | |
config.port | integer | No | |
config.secure | boolean | No | |
config.username | string | No | |
config.region | string | No | |
config.access_key_id | string | No | |
config.configuration_set | string | No | |
config.account_sid | string | No | |
config.from_number | string | No | |
config.messaging_service_sid | string | No | |
config.verify_service_sid | string | No | |
config.usercode | string | No | |
config.msgheader | string | No | |
config.iys_filter | enum | No | Values: "0", "11", "12" |
config.waba_id | string | No | |
config.phone_number_id | string | No | |
config.graph_api_version | string | No | |
config.display_phone_number | string | No | |
config.verified_name | string | No | |
config.rbm_agent_id | string | No | |
config.content_sid | string | No | |
config.sms_fallback | boolean | No | |
config.telegram_bot_username | string | No | |
config.viber_uri | string | No | |
config.viber_sender_name | string | No | |
config.viber_sender_avatar | string | No | |
config.webhook_registered_at | string | No | |
has_secret | boolean | Yes | |
has_hook | boolean | Yes | |
last_validated_at | string | null | Yes | |
last_error | string | null | Yes | |
updated_at | string | null | Yes | |
suspended_reason | string | null | Yes | |
dns_check | object | null | Yes |
Used by: PUT /v1/apps/{appId}/channels/{channel}
ChannelHook
| Field | Type | Required | Description |
|---|---|---|---|
url | string | null | Yes | |
provider | string | Yes | |
polling | boolean | Yes | |
events | array<string> | Yes | |
verify_token | string | null | No | |
secret_token | string | null | No |
ChannelList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].provider | enum | null | Yes | |
data[].status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
data[].config | object | Yes | |
data[].config.auth_type | enum | No | Values: "token", "certificate" |
data[].config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
data[].config.certificate_subject | string | No | |
data[].config.certificate_expires_at | string | No | |
data[].config.key_id | string | No | |
data[].config.team_id | string | No | |
data[].config.bundle_id | string | No | |
data[].config.environment | enum | No | Values: "sandbox", "production" |
data[].config.project_id | string | No | |
data[].config.client_email | string | No | |
data[].config.hms_app_id | string | No | |
data[].config.high_priority | boolean | No | |
data[].config.subject | string | No | |
data[].config.vapid_public_key | string | No | |
data[].config.site_url | string | No | |
data[].config.from_address | string | No | |
data[].config.from_name | string | No | |
data[].config.reply_to | string | No | |
data[].config.dkim_selector | string | No | |
data[].config.postal_address | string | No | |
data[].config.host | string | No | |
data[].config.port | integer | No | |
data[].config.secure | boolean | No | |
data[].config.username | string | No | |
data[].config.region | string | No | |
data[].config.access_key_id | string | No | |
data[].config.configuration_set | string | No | |
data[].config.account_sid | string | No | |
data[].config.from_number | string | No | |
data[].config.messaging_service_sid | string | No | |
data[].config.verify_service_sid | string | No | |
data[].config.usercode | string | No | |
data[].config.msgheader | string | No | |
data[].config.iys_filter | enum | No | Values: "0", "11", "12" |
data[].config.waba_id | string | No | |
data[].config.phone_number_id | string | No | |
data[].config.graph_api_version | string | No | |
data[].config.display_phone_number | string | No | |
data[].config.verified_name | string | No | |
data[].config.rbm_agent_id | string | No | |
data[].config.content_sid | string | No | |
data[].config.sms_fallback | boolean | No | |
data[].config.telegram_bot_username | string | No | |
data[].config.viber_uri | string | No | |
data[].config.viber_sender_name | string | No | |
data[].config.viber_sender_avatar | string | No | |
data[].config.webhook_registered_at | string | No | |
data[].has_secret | boolean | Yes | |
data[].has_hook | boolean | Yes | |
data[].last_validated_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].updated_at | string | null | Yes | |
data[].suspended_reason | string | null | Yes | |
data[].dns_check | object | null | Yes |
Used by: GET /v1/apps/{appId}/channels
ChannelScoreConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
window_days | integer | Yes | |
min_sends | integer | Yes | |
count_email_opens | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Used by: GET /v1/apps/{appId}/channel-scores/config, PUT /v1/apps/{appId}/channel-scores/config, POST /v1/apps/{appId}/channel-scores/compute
ChannelScoreOverview
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
low_population | boolean | Yes | |
last_computed_at | string | null | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
channels[].best_users | integer | Yes | |
channels[].share | number | Yes | |
channels[].sends | integer | Yes | |
channels[].engaged | integer | Yes | |
channels[].engagement_rate | number | null | Yes |
Used by: GET /v1/apps/{appId}/channel-scores/overview
ChannelScoreUser
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
best_channel | enum | null | Yes | |
scores | array<object> | Yes | |
scores[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
scores[].sends | integer | Yes | |
scores[].engaged | integer | Yes | |
scores[].score | number | Yes |
Used by: GET /v1/apps/{appId}/channel-scores/users/{userId}
ChannelScoreUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].best_channel | enum | null | Yes | |
data[].scores | array<object> | Yes | |
data[].scores[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
data[].scores[].sends | integer | Yes | |
data[].scores[].engaged | integer | Yes | |
data[].scores[].score | number | Yes | |
next_cursor | string | null | Yes |
Used by: GET /v1/apps/{appId}/channel-scores/users
ChannelStatusList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].channel | string | Yes | |
data[].provider | string | null | Yes | |
data[].status | string | Yes |
Used by: GET /v1/apps/{appId}/channels/status
ChannelValidation
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
kind | enum | null | Yes | |
code | string | null | Yes | |
message | string | null | Yes | |
details | map<string, any> | null | Yes | |
channel | object | Yes | |
channel.channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channel.provider | enum | null | Yes | |
channel.status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
channel.config | object | Yes | |
channel.config.auth_type | enum | No | Values: "token", "certificate" |
channel.config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
channel.config.certificate_subject | string | No | |
channel.config.certificate_expires_at | string | No | |
channel.config.key_id | string | No | |
channel.config.team_id | string | No | |
channel.config.bundle_id | string | No | |
channel.config.environment | enum | No | Values: "sandbox", "production" |
channel.config.project_id | string | No | |
channel.config.client_email | string | No | |
channel.config.hms_app_id | string | No | |
channel.config.high_priority | boolean | No | |
channel.config.subject | string | No | |
channel.config.vapid_public_key | string | No | |
channel.config.site_url | string | No | |
channel.config.from_address | string | No | |
channel.config.from_name | string | No | |
channel.config.reply_to | string | No | |
channel.config.dkim_selector | string | No | |
channel.config.postal_address | string | No | |
channel.config.host | string | No | |
channel.config.port | integer | No | |
channel.config.secure | boolean | No | |
channel.config.username | string | No | |
channel.config.region | string | No | |
channel.config.access_key_id | string | No | |
channel.config.configuration_set | string | No | |
channel.config.account_sid | string | No | |
channel.config.from_number | string | No | |
channel.config.messaging_service_sid | string | No | |
channel.config.verify_service_sid | string | No | |
channel.config.usercode | string | No | |
channel.config.msgheader | string | No | |
channel.config.iys_filter | enum | No | Values: "0", "11", "12" |
channel.config.waba_id | string | No | |
channel.config.phone_number_id | string | No | |
channel.config.graph_api_version | string | No | |
channel.config.display_phone_number | string | No | |
channel.config.verified_name | string | No | |
channel.config.rbm_agent_id | string | No | |
channel.config.content_sid | string | No | |
channel.config.sms_fallback | boolean | No | |
channel.config.telegram_bot_username | string | No | |
channel.config.viber_uri | string | No | |
channel.config.viber_sender_name | string | No | |
channel.config.viber_sender_avatar | string | No | |
channel.config.webhook_registered_at | string | No | |
channel.has_secret | boolean | Yes | |
channel.has_hook | boolean | Yes | |
channel.last_validated_at | string | null | Yes | |
channel.last_error | string | null | Yes | |
channel.updated_at | string | null | Yes | |
channel.suspended_reason | string | null | Yes | |
channel.dns_check | object | null | Yes |
Used by: POST /v1/apps/{appId}/channels/{channel}/validate
CheckoutResult
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
session_id | string | Yes |
CheckVerifyDto
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Length: 4–80 |
code | string | Yes |
Used by: POST /v1/apps/{appId}/verify/sms/check
CleanupResult
| Field | Type | Required | Description |
|---|---|---|---|
deleted | integer | Yes |
Used by: POST /v1/apps/{appId}/subscriptions/cleanup
Company
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
external_id | string | Yes | |
name | string | null | Yes | |
domain | string | null | Yes | |
properties | map<string, any> | Yes | |
member_count | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/companies, GET /v1/apps/{appId}/companies/{companyId}, PATCH /v1/apps/{appId}/companies/{companyId}
CompanyBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
created | integer | Yes | |
updated | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | Yes | |
data[].created | boolean | Yes |
Used by: POST /v1/apps/{appId}/companies/batch
CompanyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | Yes | |
data[].name | string | null | Yes | |
data[].domain | string | null | Yes | |
data[].properties | map<string, any> | Yes | |
data[].member_count | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/companies
CompanyMember
| Field | Type | Required | Description |
|---|---|---|---|
company_id | string | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
role | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: PUT /v1/apps/{appId}/companies/{companyId}/members/{userId}
CompanyMemberBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
added | integer | Yes | |
updated | integer | Yes | |
not_found | array<object> | Yes | |
not_found[].index | integer | Yes | |
not_found[].user_id | string | null | Yes | |
not_found[].external_id | string | null | Yes |
Used by: POST /v1/apps/{appId}/companies/{companyId}/members/batch
CompanyMemberList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].company_id | string | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].role | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/companies/{companyId}/members
ContentCard
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
message_id | string | null | Yes | |
type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
title | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
button_text | string | null | Yes | |
data | map<string, string> | Yes | |
pinned | boolean | Yes | |
priority | integer | Yes | |
viewed | boolean | Yes | |
clicked | boolean | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes |
Used by: POST /sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}
ContentCardList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | null | Yes | |
data[].type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].url | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].button_text | string | null | Yes | |
data[].data | map<string, string> | Yes | |
data[].pinned | boolean | Yes | |
data[].priority | integer | Yes | |
data[].viewed | boolean | Yes | |
data[].clicked | boolean | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
unviewed_count | integer | Yes |
Used by: GET /sdk/v1/apps/{appId}/users/{userId}/cards
ContentTable
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
key_column | string | Yes | |
columns | array<string> | Yes | |
row_count | integer | Yes | |
version | integer | Yes | |
source_file_name | string | null | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/content-tables, GET /v1/apps/{appId}/content-tables/{tableId}, PATCH /v1/apps/{appId}/content-tables/{tableId}, PUT /v1/apps/{appId}/content-tables/{tableId}/rows
ContentTableList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].key_column | string | Yes | |
data[].columns | array<string> | Yes | |
data[].row_count | integer | Yes | |
data[].version | integer | Yes | |
data[].source_file_name | string | null | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/content-tables
ContentTableRows
| Field | Type | Required | Description |
|---|---|---|---|
columns | array<string> | Yes | |
key_column | string | Yes | |
total | integer | Yes | |
data | array<map<string, string>> | Yes |
Used by: GET /v1/apps/{appId}/content-tables/{tableId}/rows
Conversation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
subscription_id | string | null | Yes | |
subscription_status | string | null | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
contact | string | Yes | |
opted_in | boolean | Yes | |
last_message_at | string | Yes | |
last_inbound_at | string | null | Yes | |
last_direction | enum | null | Yes | |
last_message_preview | string | null | Yes | |
unread_count | integer | Yes | |
window | object | null | Yes | |
created_at | string | Yes | |
assignee_id | string | null | Yes | |
team_id | string | null | Yes | |
assigned_at | string | null | Yes | |
language | string | null | Yes | |
bot_active | boolean | Yes | |
last_seq | integer | Yes | |
visitor_last_read_seq | integer | Yes | |
visitor_last_delivered_seq | integer | Yes | |
agent_last_read_seq | integer | Yes | |
waiting_since | string | null | Yes | |
first_response_at | string | null | Yes | |
sla_due_at | string | null | Yes | |
resolved_at | string | null | Yes | |
visitor | object | null | Yes |
Used by: GET /v1/apps/{appId}/conversations/{conversationId}, PATCH /v1/apps/{appId}/conversations/{conversationId}, POST /v1/apps/{appId}/conversations/{conversationId}/read, POST /v1/apps/{appId}/conversations/{conversationId}/assign
ConversationActivity
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].type | string | Yes | |
data[].actor_type | string | Yes | |
data[].actor_id | string | null | Yes | |
data[].data | map<string, any> | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/conversations/{conversationId}/activity
ConversationAssignDto
| Field | Type | Required | Description |
|---|---|---|---|
assignee_id | string | null | No | |
team_id | string | null | No |
Used by: POST /v1/apps/{appId}/conversations/{conversationId}/assign
ConversationContact
| Field | Type | Required | Description |
|---|---|---|---|
user | object | null | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].channel | string | Yes | |
subscriptions[].status | string | Yes | |
subscriptions[].token_masked | string | null | Yes | |
subscriptions[].created_at | string | Yes | |
recent_events | array<object> | Yes | |
recent_events[].name | string | Yes | |
recent_events[].occurred_at | string | Yes | |
recent_events[].properties | map<string, any> | Yes | |
other_conversations | array<object> | Yes | |
other_conversations[].id | string | Yes | |
other_conversations[].channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
other_conversations[].status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
other_conversations[].last_message_at | string | Yes |
Used by: GET /v1/apps/{appId}/conversations/{conversationId}/contact
ConversationMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].direction | enum | Yes | Values: "inbound", "outbound" |
data[].status | string | Yes | |
data[].body | string | null | Yes | |
data[].content | map<string, any> | Yes | |
data[].message_id | string | null | Yes | |
data[].delivery_id | string | null | Yes | |
data[].sent_by | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].read_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].seq | integer | Yes | |
data[].sender_type | string | Yes | |
data[].client_message_id | string | null | Yes | |
data[].attachments | array<object> | Yes | |
data[].attachments[].id | string | Yes | |
data[].attachments[].name | string | Yes | |
data[].attachments[].type | string | Yes | |
data[].attachments[].size | integer | Yes | |
data[].quick_replies | array<object> | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/conversations/{conversationId}/messages
ConversationPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
data[].status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
data[].subscription_id | string | null | Yes | |
data[].subscription_status | string | null | Yes | |
data[].user_id | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].contact | string | Yes | |
data[].opted_in | boolean | Yes | |
data[].last_message_at | string | Yes | |
data[].last_inbound_at | string | null | Yes | |
data[].last_direction | enum | null | Yes | |
data[].last_message_preview | string | null | Yes | |
data[].unread_count | integer | Yes | |
data[].window | object | null | Yes | |
data[].created_at | string | Yes | |
data[].assignee_id | string | null | Yes | |
data[].team_id | string | null | Yes | |
data[].assigned_at | string | null | Yes | |
data[].language | string | null | Yes | |
data[].bot_active | boolean | Yes | |
data[].last_seq | integer | Yes | |
data[].visitor_last_read_seq | integer | Yes | |
data[].visitor_last_delivered_seq | integer | Yes | |
data[].agent_last_read_seq | integer | Yes | |
data[].waiting_since | string | null | Yes | |
data[].first_response_at | string | null | Yes | |
data[].sla_due_at | string | null | Yes | |
data[].resolved_at | string | null | Yes | |
data[].visitor | object | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/conversations
ConversationReplyDto
| Field | Type | Required | Description |
|---|---|---|---|
text | string | No | Length: 1–4096 |
template | object | No | |
template.name | string | Yes | |
template.language | string | Yes | |
template.header | object | No | |
template.body_params | array<string> | No | Items: 0–20 |
template.button_params | array<object> | No | Items: 0–10 |
template.button_params[].index | integer | Yes | Range: 0–9 |
template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
template.button_params[].value | string | Yes | Length: 1–256 |
media | object | No | |
media.type | enum | Yes | Values: "image", "video", "document", "audio" |
media.url | string (url) | Yes | Length: 0–2000 |
media.filename | string | No | Length: 1–240 |
interactive | object | No | |
interactive.type | enum | Yes | Values: "button", "list" |
interactive.header | string | No | Length: 1–60 |
interactive.footer | string | No | Length: 1–60 |
interactive.buttons | array<object> | No | Items: 1–3 |
interactive.buttons[].id | string | Yes | Length: 1–256 |
interactive.buttons[].title | string | Yes | Length: 1–20 |
interactive.list | object | No | |
interactive.list.button | string | Yes | Length: 1–20 |
interactive.list.sections | array<object> | Yes | Items: 1–10 |
client_message_id | string | No | |
source | enum | No | Values: "manual", "canned", "ai_suggestion" |
Used by: POST /v1/apps/{appId}/conversations/{conversationId}/messages
ConversationReplyResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | null | Yes | |
conversation_message | object | Yes | |
conversation_message.id | string | Yes | |
conversation_message.direction | enum | Yes | Values: "inbound", "outbound" |
conversation_message.status | string | Yes | |
conversation_message.body | string | null | Yes | |
conversation_message.content | map<string, any> | Yes | |
conversation_message.message_id | string | null | Yes | |
conversation_message.delivery_id | string | null | Yes | |
conversation_message.sent_by | string | null | Yes | |
conversation_message.error_code | string | null | Yes | |
conversation_message.read_at | string | null | Yes | |
conversation_message.created_at | string | Yes | |
conversation_message.seq | integer | Yes | |
conversation_message.sender_type | string | Yes | |
conversation_message.client_message_id | string | null | Yes | |
conversation_message.attachments | array<object> | Yes | |
conversation_message.attachments[].id | string | Yes | |
conversation_message.attachments[].name | string | Yes | |
conversation_message.attachments[].type | string | Yes | |
conversation_message.attachments[].size | integer | Yes | |
conversation_message.quick_replies | array<object> | null | Yes |
Used by: POST /v1/apps/{appId}/conversations/{conversationId}/messages
ConversationTagsDto
| Field | Type | Required | Description |
|---|---|---|---|
add | map<string, string> | No | |
remove | array<string> | No | Items: 0–50 |
Used by: POST /v1/apps/{appId}/conversations/{conversationId}/tags
ConversationTagsResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
tags | map<string, any> | Yes |
Used by: POST /v1/apps/{appId}/conversations/{conversationId}/tags
ConversationUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
Used by: PATCH /v1/apps/{appId}/conversations/{conversationId}
ConversionsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.conversions | integer | Yes | |
totals.direct | integer | Yes | |
totals.influenced | integer | Yes | |
totals.unattributed | integer | Yes | |
totals.revenue | number | Yes | |
previous | object | null | Yes | |
by_campaign | array<object> | Yes | |
by_campaign[].campaign_id | string | null | Yes | |
by_campaign[].name | string | Yes | |
by_campaign[].conversions | integer | Yes | |
by_campaign[].direct | integer | Yes | |
by_campaign[].influenced | integer | Yes | |
by_campaign[].unattributed | integer | Yes | |
by_campaign[].revenue | number | Yes | |
by_campaign[].sent | integer | Yes | |
by_campaign[].conversion_rate | number | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].conversions | integer | Yes | |
rows[].revenue | number | Yes |
Used by: GET /v1/apps/{appId}/analytics/conversions
CopyTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
target_app_id | string | Yes | Length: 1–64 |
name | string | No | Length: 2–100 |
Used by: POST /v1/apps/{appId}/templates/{templateId}/copy_to_app
CreateAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
ad_account_id | string | Yes | Length: 1–64 |
source | enum | Yes | Values: "segment", "journey" |
segment_id | string | No | Length: 1–64 |
name | string | Yes | Length: 1–120 |
description | string | No | Length: 0–500 |
identifiers | array<enum> | No | Items: 1–3 |
sync_interval_minutes | integer | No | Range: 60–360 |
Used by: POST /v1/apps/{appId}/ads/audiences
CreateAdCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
ad_account_id | string | Yes | Length: 1–64 |
audience_id | string | Yes | Length: 1–64 |
name | string | Yes | Length: 1–200 |
objective | enum | Yes | Values: "traffic", "conversions", "leads", "awareness" |
optimization_goal | enum | No | Values: "clicks", "landing_page_views", "conversions", "reach", "impressions" |
daily_budget | string | number | Yes | |
start_at | string (date-time) | No | |
end_at | string (date-time) | No | |
countries | array<string> | Yes | Items: 1–25 |
status | enum | No | Values: "active", "paused" |
pixel_id | string | No | Length: 1–64 |
creative | object | No | |
creative.headline | string | Yes | Length: 1–30 |
creative.long_headline | string | No | Length: 1–90 |
creative.primary_text | string | Yes | Length: 1–500 |
creative.description | string | No | Length: 1–90 |
creative.link_url | string (uri) | Yes | |
creative.call_to_action | enum | Yes | Values: "LEARN_MORE", "SHOP_NOW", "SIGN_UP", "SUBSCRIBE", "DOWNLOAD", "CONTACT_US", "BOOK_NOW", "GET_OFFER" |
creative.image_id | string | No | Length: 1–64 |
creative.square_image_id | string | No | Length: 1–64 |
creative.page_id | string | No | Length: 1–64 |
creative.business_name | string | No | Length: 1–25 |
Used by: POST /v1/apps/{appId}/ads/campaigns
CreateAiAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
channels | array<enum> | No | Items: 0–6 |
instructions | string | No | Length: 0–4000 |
faq | array<object> | No | Items: 0–50 |
faq[].question | string | Yes | Length: 1–300 |
faq[].answer | string | Yes | Length: 1–1500 |
tools | array<object> | No | Items: 0–10 |
tools[].name | string | Yes | |
tools[].description | string | Yes | Length: 1–500 |
tools[].url | string (uri) | Yes | Length: 0–2000 |
tools[].params | array<object> | No | Items: 0–8 |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | No | Length: 0–200 |
tools[].params[].required | boolean | No | |
handoff | object | No | |
handoff.keywords | array<string> | No | Items: 0–20 |
handoff.max_bot_replies | integer | No | Range: 1–50 |
handoff.on_negative_sentiment | boolean | No | |
handoff.message | string | No | Length: 0–500 |
limits | object | No | |
limits.monthly_token_cap | integer | No | Range: 1000–50000000 |
limits.max_steps | integer | No | Range: 1–6 |
ai_sentiment | boolean | No |
Used by: POST /v1/apps/{appId}/ai-agents
CreateAppApiKeyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
scopes | array<enum> | Yes | Items: 1–8 |
environment | enum | No | Values: "live", "test"; Default: "live" |
expires_at | string (date-time) | null | No | |
ip_allowlist | array<string> | No | Items: 0–50 |
Used by: POST /v1/apps/{appId}/api-keys
CreateAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
slug | string | No | |
platform_flags | object | No | Default: {} |
platform_flags.ios | boolean | No | |
platform_flags.android | boolean | No | |
platform_flags.web | boolean | No | |
platform_flags.email | boolean | No | |
platform_flags.sms | boolean | No | |
default_language | string | No | Default: "en"; Length: 2–10 |
timezone | string | No | Default: "UTC"; Length: 1–64 |
Used by: POST /v1/apps
CreateAppFlagDto
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | |
name | string | Yes | Length: 1–100 |
description | string | null | No | |
enabled | boolean | No | |
value_type | enum | No | Values: "boolean", "string", "number", "json" |
on_value | boolean | number | string | array<any> | map<string, any> | No | |
off_value | boolean | number | string | array<any> | map<string, any> | No | |
rollout_percent | integer | No | Range: 0–100 |
segment_id | string | null | No | |
rollout_schedule | array<object> | No | Items: 0–10 |
rollout_schedule[].at | string (date-time) | Yes | |
rollout_schedule[].percent | integer | Yes | Range: 0–100 |
Used by: POST /v1/apps/{appId}/feature-flags
CreateBudgetAlertRuleDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–120 |
kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
ad_account_id | string | null | No | |
campaign_external_id | string | null | No | |
threshold | number | Yes | Range: −∞–1000000000000 |
window_days | integer | No | Range: 1–30 |
recipients | array<string (email)> | No | Items: 0–20 |
enabled | boolean | No |
Used by: POST /v1/apps/{appId}/ads/alert-rules
CreateCatalogDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | No | Length: 0–500 |
currency | string | No |
Used by: POST /v1/apps/{appId}/catalogs
CreateCategoryDto
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Length: 1–64 |
name | map<string, string> | Yes | |
description | map<string, string> | No | |
channels | array<enum> | null | No | |
default_opted_in | boolean | No | |
position | integer | No | Range: 0–1000 |
Used by: POST /v1/apps/{appId}/categories
CreateCustomAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | No | Length: 0–300 |
enabled | boolean | No | |
instructions | string | No | Length: 0–4000 |
tools | array<enum> | No | Items: 0–5 |
schedule | object | null | No | |
limits | object | No | |
limits.max_steps | integer | No | Range: 1–10 |
limits.monthly_token_cap | integer | No | Range: 1000–20000000 |
Used by: POST /v1/apps/{appId}/custom-agents
CreatedApiKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
name | string | Yes | |
prefix | string | Yes | |
scopes | array<string> | Yes | |
last_used_at | string | null | Yes | |
expires_at | string | null | Yes | |
revoked_at | string | null | Yes | |
ip_allowlist | array<string> | Yes | |
rotated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
key | string | Yes |
Used by: POST /v1/apps/{appId}/api-keys, POST /v1/apps/{appId}/api-keys/{keyId}/rotate
CreateDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | null | No | |
url_template | string | Yes | Length: 1–2048 |
method | enum | No | Values: "GET", "POST" |
body_template | string | null | No | |
headers | map<string, string> | No | |
secret_headers | map<string, string> | No | |
cache_ttl_seconds | integer | No | Range: 0–86400 |
timeout_ms | integer | No | Range: 100–2000 |
enabled | boolean | No |
Used by: POST /v1/apps/{appId}/data-feeds
CreateDataSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
auth_mode | enum | No | Values: "signature", "token" |
mapping | object | No | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | No | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
auth_value | string | No | Length: 0–2000 |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
Used by: POST /v1/apps/{appId}/data-pipelines/sources
CreateDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | No | Length: 0–500 |
enabled | boolean | No | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | No | Range: 0–10000 |
rules | array<object> | No | Items: 0–50 |
code | string | No | Length: 0–20000 |
sources | array<enum> | No | Items: 0–6 |
event_names | array<string> | No | Items: 0–50 |
Used by: POST /v1/apps/{appId}/data-pipelines/transforms
CreateDecisionAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
arms | array<object> | Yes | Items: 2–8 |
arms[].id | string | Yes | |
arms[].label | string | Yes | Length: 1–60 |
reward_events | array<string> | Yes | Items: 1–10 |
reward_window_hours | integer | No | Default: 72; Range: 1–720 |
holdout_percent | integer | No | Default: 10; Range: 0–50 |
context_prediction | string | null | No | |
use_best_channel | boolean | No | Default: false |
Used by: POST /v1/apps/{appId}/decision-agents
CreateExportDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | No | Default: {} |
filters.from | string (date-time) | No | |
filters.to | string (date-time) | No | |
filters.name | string | No | Length: 0–100 |
filters.message_id | string | No | Length: 0–64 |
filters.campaign_id | string | No | Length: 0–64 |
filters.status | string | No | Length: 0–32 |
filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
filters.segment_id | string | No | Length: 0–64 |
Used by: POST /v1/apps/{appId}/exports
CreateFormDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | No | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
status | enum | No | Values: "active", "archived" |
Used by: POST /v1/apps/{appId}/forms
CreateGeofenceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
lat | number | Yes | Range: -90–90 |
lng | number | Yes | Range: -180–180 |
radius_m | integer | Yes | Range: 100–50000 |
cooldown_minutes | integer | No | Range: 0–10080 |
enabled | boolean | No |
Used by: POST /v1/apps/{appId}/geofences
CreateIdentityKeyDto
| Field | Type | Required | Description |
|---|---|---|---|
kid | string | No | Length: 1–64 |
label | string | No | Length: 0–80 |
public_jwk | map<string, any> | No | |
public_key_pem | string | No | Length: 0–4000 |
Used by: POST /v1/apps/{appId}/identity-keys
CreateInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
triggers | array<object> | Yes | Items: 1–5 |
trigger_groups | array<array<object>> | No | Items: 1–10 |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
ab_test | object | No | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | No | |
placement | string | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: POST /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/mcp/in-app-drafts
CreateKeywordDto
| Field | Type | Required | Description |
|---|---|---|---|
keyword | string | Yes | Length: 1–30 |
scope | enum | No | Values: "org", "app" |
channels | array<enum> | No | Items: 1–3 |
actions | object | Yes | |
actions.add_tags | map<string, string> | No | |
actions.remove_tags | array<string> | No | Items: 0–50 |
actions.event | object | No | |
actions.event.name | string | Yes | |
actions.event.properties | map<string, string> | No | |
actions.reply | object | No | |
actions.reply.text | string | Yes | Length: 1–1600 |
actions.opt_in | boolean | No | |
enabled | boolean | No | |
description | string | No | Length: 0–300 |
Used by: POST /v1/apps/{appId}/sms-keywords
CreateLandingPageDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
slug | string | Yes | Length: 0–80 |
document | object | Yes | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
seo | object | No | |
seo.title | string | No | Length: 0–120 |
seo.description | string | No | Length: 0–320 |
seo.og_image | string (url) | No | Length: 0–2000 |
seo.canonical_url | string (url) | No | Length: 0–2000 |
seo.noindex | boolean | No | |
settings | object | No | |
settings.language | string | No | Length: 2–10 |
settings.form_id | string | null | No | |
settings.form_section_id | string | null | No | |
settings.cookie_consent | object | No | |
settings.cookie_consent.enabled | boolean | Yes | |
settings.cookie_consent.text | string | No | Length: 0–1000 |
settings.cookie_consent.accept_label | string | No | Length: 0–60 |
settings.cookie_consent.reject_label | string | No | Length: 0–60 |
settings.cookie_consent.policy_url | string (url) | No | Length: 0–2000 |
settings.web_sdk | boolean | No | |
settings.favicon_url | string (url) | No | Length: 0–2000 |
custom_domain_id | string | null | No |
Used by: POST /v1/apps/{appId}/mcp/landing-page-drafts, POST /v1/apps/{appId}/landing-pages
CreateLiveActivityTypeDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
description | string | No | Length: 0–300 |
content_state_schema | object | Yes | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | No | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
Used by: POST /v1/apps/{appId}/live-activities/types
CreateLookalikeDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
country | string | Yes | |
ratio | number | Yes | Range: 0.01–0.2 |
Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/lookalikes
CreateMessengerLinkDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "telegram", "viber" |
user_id | string | No | Length: 1–64 |
external_id | string | No | Length: 1–255 |
ttl_seconds | integer | No | Range: 60–2592000 |
Used by: POST /v1/apps/{appId}/messenger-links
CreateNotificationDto
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | No | Length: 1–∞ |
idempotency_key | string | No | Length: 1–255 |
target | object | Yes | |
target.all | boolean | No | |
target.include_subscription_ids | array<string> | No | Items: 0–2000 |
target.include_external_ids | array<string> | No | Items: 0–2000 |
target.include_aliases | map<string, array<string>> | No | |
target.included_segments | array<string> | No | Items: 0–50 |
target.excluded_segments | array<string> | No | Items: 0–50 |
target.filters | any | No | |
target.channels | array<enum> | No | Items: 1–∞ |
target.test_devices_only | boolean | No | |
target.email_to | array<string> | No | Items: 1–2000 |
target.include_phone_numbers | array<string> | No | Items: 1–2000 |
headings | map<string, string> | No | |
contents | map<string, string> | No | |
subtitle | map<string, string> | No | |
url | string (url) | No | Length: 0–2000 |
app_url | string (url) | No | Length: 0–2000 |
data | map<string, string> | No | |
buttons | array<object> | No | Items: 0–3 |
buttons[].id | string | Yes | Length: 1–64 |
buttons[].text | string | Yes | Length: 1–100 |
buttons[].icon | string (url) | No | Length: 0–2000 |
buttons[].url | string (url) | No | Length: 0–2000 |
big_picture | string (url) | No | Length: 0–2000 |
ios_attachments | map<string, string (url)> | No | |
ios_sound | string | No | Length: 0–100 |
ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
ios_badge_count | integer | No | Range: 0–99999 |
ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
ios_category | string | No | Length: 0–100 |
thread_id | string | No | Length: 0–100 |
ios_relevance_score | number | No | Range: 0–1 |
target_content_identifier | string | No | Length: 0–200 |
android_channel_id | string | No | Length: 0–100 |
android_group | string | No | Length: 0–100 |
android_sound | string | No | Length: 0–100 |
small_icon | string | No | Length: 0–100 |
large_icon | string (url) | string | No | |
android_accent_color | string | No | |
android_visibility | 1 | 0 | -1 | No | |
ios_carousel | array<object> | No | Items: 0–5 |
ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
ios_carousel[].title | string | No | Length: 0–80 |
android_live_update | object | No | |
android_live_update.progress | integer | Yes | Range: 0–100 |
android_live_update.ongoing | boolean | No | |
voip | boolean | No | |
app_clip | boolean | No | |
chrome_web_icon | string (url) | No | Length: 0–2000 |
chrome_web_image | string (url) | No | Length: 0–2000 |
chrome_web_badge | string (url) | No | Length: 0–2000 |
web_push_topic | string | No | Length: 0–32 |
web_buttons | array<object> | No | Items: 0–2 |
web_buttons[].id | string | Yes | Length: 1–64 |
web_buttons[].text | string | Yes | Length: 1–100 |
web_buttons[].icon | string (url) | No | Length: 0–2000 |
web_buttons[].url | string (url) | No | Length: 0–2000 |
require_interaction | boolean | No | |
content_available | boolean | No | |
mutable_content | boolean | No | |
collapse_id | string | No | Length: 0–64 |
priority | 5 | 10 | No | |
ttl | integer | No | Range: 60–2419200 |
send_after | string (date-time) | No | |
delayed_option | enum | No | Values: "timezone", "optimized" |
delivery_time_of_day | string | No | |
template_id | string | No | |
custom_data | map<string, any> | No | |
email_subject | string | No | Length: 0–998 |
email_body | string | No | Length: 0–500000 |
email_mjml | string | No | Length: 0–500000 |
email_preheader | string | No | Length: 0–500 |
email_from_name | string | No | Length: 0–200 |
email_from_address | string (email) | No | Length: 0–320 |
email_reply_to_address | string (email) | No | Length: 0–320 |
disable_email_click_tracking | boolean | No | |
sms_from | string | No | Length: 1–20 |
sms_media_urls | array<string (url)> | No | Items: 1–10 |
disable_sms_link_shortening | boolean | No | |
whatsapp_template | object | No | |
whatsapp_template.name | string | Yes | |
whatsapp_template.language | string | Yes | |
whatsapp_template.header | object | No | |
whatsapp_template.body_params | array<string> | No | Items: 0–20 |
whatsapp_template.button_params | array<object> | No | Items: 0–10 |
whatsapp_template.button_params[].index | integer | Yes | Range: 0–9 |
whatsapp_template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
whatsapp_template.button_params[].value | string | Yes | Length: 1–256 |
whatsapp_media | object | No | |
whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
whatsapp_media.filename | string | No | Length: 1–240 |
whatsapp_interactive | object | No | |
whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
whatsapp_interactive.header | string | No | Length: 1–60 |
whatsapp_interactive.footer | string | No | Length: 1–60 |
whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
whatsapp_interactive.buttons[].id | string | Yes | Length: 1–256 |
whatsapp_interactive.buttons[].title | string | Yes | Length: 1–20 |
whatsapp_interactive.list | object | No | |
whatsapp_interactive.list.button | string | Yes | Length: 1–20 |
whatsapp_interactive.list.sections | array<object> | Yes | Items: 1–10 |
rcs_card | object | No | |
rcs_card.title | map<string, string> | No | |
rcs_card.description | map<string, string> | No | |
rcs_card.media_url | string (url) | No | Length: 0–2000 |
rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
rcs_suggestions | array<object> | No | Items: 0–11 |
rcs_content_sid | string | No | |
rcs_content_variables | map<string, string> | No | |
rcs_fallback_text | map<string, string> | No | |
messenger_image_url | string (url) | No | Length: 0–2000 |
messenger_buttons | array<object> | No | Items: 0–6 |
add_to_inbox | boolean | No | |
inbox_ttl | integer | No | Range: 60–31536000 |
content_card | object | No | |
content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content_card.pinned | boolean | No | |
content_card.priority | integer | No | Range: 0–100 |
content_card.button_text | map<string, string> | No | |
frequency_cap_exempt | boolean | No | |
quiet_hours_exempt | boolean | No | |
one_per_user | boolean | No | |
throttle_rate_per_minute | integer | No | Range: 0–1000000 |
include_unsubscribed | boolean | No | |
name | string | No | Length: 1–200 |
labels | array<string> | No | Items: 0–10 |
category | string | No | Length: 1–64 |
fallback_channel | enum | No | Values: "sms", "email" |
form_factor | enum | No | Values: "phone", "watch" |
Used by: POST /v1/notifications
CreateNotificationResult
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
recipients_estimate | integer | Yes | |
external_id_missing | array<string> | Yes |
Used by: POST /v1/notifications, POST /v1/apps/{appId}/mcp/test-sends
CreatePredictionDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | No | Default: []; Items: 0–10 |
horizon_days | integer | No | Default: 30; Range: 7–90 |
Used by: POST /v1/apps/{appId}/predictions
CreatePromoCodeListDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | No | Length: 0–500 |
expires_at | string (date-time) | null | No |
Used by: POST /v1/apps/{appId}/promo-code-lists
CreateSavedReportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | No | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | No | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | No | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No |
Used by: POST /v1/apps/{appId}/analytics/reports
CreateSetupAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
platforms | array<enum> | Yes | Items: 1–8 |
framework | enum | No | Values: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui" |
web_integration | enum | No | Values: "code", "wordpress" |
default_language | string | No | Length: 2–10 |
timezone | string | No | Length: 1–64 |
Used by: POST /v1/mcp/apps
CreateSiteSearchSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
kind | enum | Yes | Values: "sitemap", "urls" |
url | string | No | Length: 0–2000 |
urls | array<string> | No | Items: 1–500 |
max_pages | integer | No | Range: 1–2000 |
refresh_hours | integer | null | No | |
enabled | boolean | No |
Used by: POST /v1/apps/{appId}/site-search/sources
CreateSqlSegmentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
description | string | null | No | |
query | string | Yes | Length: 1–20000 |
refresh_interval_minutes | integer | null | No |
Used by: POST /v1/apps/{appId}/sql/segments
CreateSuppressionDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
value | string | Yes | Length: 3–320 |
reason | enum | No | Values: "manual", "bounce", "complaint", "unsubscribe_link", "stop" |
expires_at | string (date-time) | No | |
note | string | No | Length: 0–500 |
Used by: POST /v1/apps/{appId}/suppressions
CreateSurveyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
questions | array<object> | Yes | Items: 1–10 |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].text | map<string, string> | Yes | |
questions[].required | boolean | No | |
questions[].options | array<object> | No | Items: 0–30 |
questions[].options[].value | string | Yes | Length: 1–100 |
questions[].options[].label | map<string, string> | Yes | |
questions[].low_label | map<string, string> | No | |
questions[].high_label | map<string, string> | No | |
questions[].placeholder | map<string, string> | No | |
settings | object | No | |
settings.thank_you | map<string, string> | No | |
settings.submit_label | map<string, string> | No | |
settings.write_properties | boolean | No | |
settings.allow_multiple | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
Used by: POST /v1/apps/{appId}/mcp/survey-drafts, POST /v1/apps/{appId}/surveys
CreateTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
channel | enum | null | No | |
tags | array<string> | No | Items: 0–20 |
content | object | Yes | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.list | object | No | |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No |
Used by: POST /v1/apps/{appId}/templates, POST /v1/apps/{appId}/mcp/template-drafts
CreateWalletTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | No | Default: "#ffffff" |
design.foreground_color | string | No | Default: "#111111" |
design.label_color | string | No | Default: "#555555" |
design.barcode | enum | No | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | No | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | No | Default: ""; Length: 0–60 |
design.fields[].value | string | No | Default: ""; Length: 0–500 |
design.fields[].section | enum | No | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | map<string, string> | No |
Used by: POST /v1/apps/{appId}/wallet/templates
CreateWarehouseConnectionDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
type | enum | Yes | Values: "bigquery", "snowflake", "databricks" |
config | map<string, any> | Yes | |
credentials | map<string, any> | Yes |
Used by: POST /v1/apps/{appId}/warehouse-segments/connections
CreateWarehouseSegmentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
description | string | null | No | |
connection_id | string | Yes | Length: 1–∞ |
query | string | Yes | Length: 1–20000 |
id_column | string | Yes | |
id_type | enum | No | Values: "external_id", "user_id" |
refresh_interval_minutes | integer | null | No | |
limits | object | No | |
limits.timeout_seconds | integer | No | Range: 10–600 |
limits.max_rows | integer | No | Range: 1–1000000 |
limits.max_bytes_billed | integer | No | Range: 10485760–10995116277760 |
limits.max_warehouse_size | enum | null | No |
Used by: POST /v1/apps/{appId}/warehouse-segments/segments
CreateWarmupPlanDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | Length: 2–253 |
start_date | string | No | |
daily_limits | array<integer> | No | Items: 1–120 |
curve | object | No | |
curve.start | integer | Yes | Range: 1–1000000 |
curve.growth | number | Yes | Range: 1.05–3 |
curve.target | integer | Yes | Range: 1–10000000 |
provider_shares | object | No | |
provider_shares.gmail | number | Yes | Range: 0–1 |
provider_shares.outlook | number | Yes | Range: 0–1 |
provider_shares.yahoo | number | Yes | Range: 0–1 |
provider_shares.other | number | Yes | Range: 0–1 |
timezone | string | No | Length: 1–64 |
Used by: POST /v1/apps/{appId}/email-deliverability/warmup-plans
CreateWebCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
trigger | object | Yes | |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
frequency | object | No | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: POST /v1/apps/{appId}/mcp/web-campaign-drafts, POST /v1/apps/{appId}/web-campaigns
CreateWebhookDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Length: 1–2048 |
description | string | null | No | |
events | array<enum> | Yes | Items: 1–41 |
event_filters | object | No | |
event_filters.event_names | array<string> | No | Items: 0–50 |
batch | boolean | No | |
headers | map<string, string> | No | |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No |
Used by: POST /v1/apps/{appId}/webhooks
CreateWebPersonalizationDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
changes | array<object> | No | Items: 0–20 |
variants | array<object> | No | Items: 0–4 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: POST /v1/apps/{appId}/mcp/web-personalization-drafts, POST /v1/apps/{appId}/web-personalizations
CustomAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
instructions | string | Yes | |
tools | array<enum> | Yes | |
schedule | object | null | Yes | |
limits | object | Yes | |
limits.max_steps | integer | Yes | |
limits.monthly_token_cap | integer | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/custom-agents, GET /v1/apps/{appId}/custom-agents/{agentId}, PATCH /v1/apps/{appId}/custom-agents/{agentId}
CustomAgentDraft
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
agent_id | string | Yes | |
run_id | string | Yes | |
kind | enum | Yes | Values: "segment", "campaign" |
status | enum | Yes | Values: "pending", "applied", "dismissed" |
payload | map<string, any> | Yes | |
result_id | string | null | Yes | |
decided_at | string | null | Yes | |
created_at | string | Yes |
CustomAgentDraftList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].run_id | string | Yes | |
data[].kind | enum | Yes | Values: "segment", "campaign" |
data[].status | enum | Yes | Values: "pending", "applied", "dismissed" |
data[].payload | map<string, any> | Yes | |
data[].result_id | string | null | Yes | |
data[].decided_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/custom-agents/drafts
CustomAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | Yes | |
data[].enabled | boolean | Yes | |
data[].instructions | string | Yes | |
data[].tools | array<enum> | Yes | |
data[].schedule | object | null | Yes | |
data[].limits | object | Yes | |
data[].limits.max_steps | integer | Yes | |
data[].limits.monthly_token_cap | integer | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].usage | object | Yes | |
data[].usage.tokens_this_month | integer | Yes | |
data[].usage.period_start | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/custom-agents
CustomAgentRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
agent_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "pending", "running", "succeeded", "failed", "skipped" |
steps | array<object> | Yes | |
steps[].kind | enum | Yes | Values: "tool", "finish" |
steps[].tool | string | No | |
steps[].ok | boolean | No | |
steps[].error | string | No | |
steps[].duration_ms | integer | No | |
summary | string | null | Yes | |
input_tokens | integer | Yes | |
output_tokens | integer | Yes | |
error | string | null | Yes | |
drafts | integer | Yes | |
created_at | string | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes |
Used by: POST /v1/apps/{appId}/custom-agents/{agentId}/run
CustomAgentRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "pending", "running", "succeeded", "failed", "skipped" |
data[].steps | array<object> | Yes | |
data[].steps[].kind | enum | Yes | Values: "tool", "finish" |
data[].steps[].tool | string | No | |
data[].steps[].ok | boolean | No | |
data[].steps[].error | string | No | |
data[].steps[].duration_ms | integer | No | |
data[].summary | string | null | Yes | |
data[].input_tokens | integer | Yes | |
data[].output_tokens | integer | Yes | |
data[].error | string | null | Yes | |
data[].drafts | integer | Yes | |
data[].created_at | string | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/custom-agents/runs
CustomDomain
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
kind | enum | Yes | Values: "dashboard", "tracking", "preference_center", "status_page", "landing" |
hostname | string | Yes | |
status | enum | Yes | Values: "pending", "verified", "active", "failed" |
verification | object | Yes | |
verification.txt_name | string | Yes | |
verification.txt_value | string | Yes | |
verification.cname_target | string | null | Yes | |
last_error | string | null | Yes | |
last_checked_at | string | null | Yes | |
verified_at | string | null | Yes | |
activated_at | string | null | Yes | |
created_at | string | Yes |
CustomDomainList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kind | enum | Yes | Values: "dashboard", "tracking", "preference_center", "status_page", "landing" |
data[].hostname | string | Yes | |
data[].status | enum | Yes | Values: "pending", "verified", "active", "failed" |
data[].verification | object | Yes | |
data[].verification.txt_name | string | Yes | |
data[].verification.txt_value | string | Yes | |
data[].verification.cname_target | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_checked_at | string | null | Yes | |
data[].verified_at | string | null | Yes | |
data[].activated_at | string | null | Yes | |
data[].created_at | string | Yes |
DataFeed
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
url_template | string | Yes | |
method | enum | Yes | Values: "GET", "POST" |
body_template | string | null | Yes | |
headers | map<string, string> | Yes | |
secret_header_names | array<string> | Yes | |
cache_ttl_seconds | integer | Yes | |
timeout_ms | integer | Yes | |
enabled | boolean | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, PATCH /v1/apps/{appId}/data-feeds/{feedId}
DataFeedList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].url_template | string | Yes | |
data[].method | enum | Yes | Values: "GET", "POST" |
data[].body_template | string | null | Yes | |
data[].headers | map<string, string> | Yes | |
data[].secret_header_names | array<string> | Yes | |
data[].cache_ttl_seconds | integer | Yes | |
data[].timeout_ms | integer | Yes | |
data[].enabled | boolean | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/data-feeds
DataFeedTestResult
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error" |
http_status | integer | null | Yes | |
duration_ms | integer | Yes | |
error | string | null | Yes | |
url | string | null | Yes | |
preview | any | Yes | |
truncated | boolean | Yes | |
user | object | null | Yes |
Used by: POST /v1/apps/{appId}/data-feeds/{feedId}/test
DataQuarantineDiscardResult
| Field | Type | Required | Description |
|---|---|---|---|
discarded | integer | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/discard
DataQuarantineList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].target | enum | Yes | Values: "event", "person" |
data[].source | string | Yes | |
data[].source_id | string | null | Yes | |
data[].transform_id | string | null | Yes | |
data[].payload | map<string, any> | Yes | |
data[].error_code | enum | Yes | Values: "mapping_failed", "invalid_path", "cast_failed", "rule_failed", "invalid_output", "js_error", "js_timeout", "js_memory", "js_invalid_return", "sandbox_unavailable", "write_failed" |
data[].error_path | string | null | Yes | |
data[].error_message | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "reprocessed", "discarded" |
data[].attempts | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].resolved_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes | |
pending_total | integer | Yes |
Used by: GET /v1/apps/{appId}/data-pipelines/quarantine
DataQuarantineReprocessResult
| Field | Type | Required | Description |
|---|---|---|---|
reprocessed | integer | Yes | |
dropped | integer | Yes | |
failed | integer | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/reprocess
DataSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/data-pipelines/sources/{sourceId}, PATCH /v1/apps/{appId}/data-pipelines/sources/{sourceId}
DataSourceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "webhook", "http_pull" |
data[].target | enum | Yes | Values: "event", "person" |
data[].enabled | boolean | Yes | |
data[].auth_mode | enum | Yes | Values: "signature", "token" |
data[].mapping | object | Yes | |
data[].mapping.records_path | string | No | Length: 1–200 |
data[].mapping.event_name | string | No | Length: 1–100 |
data[].mapping.event_name_path | string | No | Length: 1–200 |
data[].mapping.external_id_path | string | No | Length: 1–200 |
data[].mapping.occurred_at_path | string | No | Length: 1–200 |
data[].mapping.value_path | string | No | Length: 1–200 |
data[].mapping.event_id_path | string | No | Length: 1–200 |
data[].mapping.properties_path | string | No | Length: 1–200 |
data[].mapping.tags_path | string | No | Length: 1–200 |
data[].config | object | Yes | |
data[].config.url | string (uri) | No | Length: 0–2000 |
data[].config.method | enum | No | Values: "GET", "POST" |
data[].config.headers | map<string, string> | No | |
data[].config.body | string | No | Length: 0–10000 |
data[].config.interval_minutes | integer | No | Range: 5–1440 |
data[].config.auth_header | string | No | |
data[].config.next_cursor_path | string | No | Length: 1–200 |
data[].config.cursor_param | string | No | |
data[].config.resume_cursor | boolean | No | |
data[].has_secret | boolean | Yes | |
data[].webhook_url | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_status | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_stats | map<string, number> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/data-pipelines/sources
DataSourceRunResult
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "succeeded", "partial", "failed", "skipped" |
stats | object | Yes | |
stats.received | integer | Yes | |
stats.processed | integer | Yes | |
stats.dropped | integer | Yes | |
stats.quarantined | integer | Yes | |
error | string | null | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/sources/{sourceId}/run
DataSourceWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | null | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/sources, POST /v1/apps/{appId}/data-pipelines/sources/{sourceId}/rotate-secret
DataTransform
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | Yes | |
sources | array<enum> | Yes | |
event_names | array<string> | Yes | |
rules | array<map<string, any>> | Yes | |
code | string | null | Yes | |
error_count | integer | Yes | |
last_error_code | enum | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/transforms, GET /v1/apps/{appId}/data-pipelines/transforms/{transformId}, PATCH /v1/apps/{appId}/data-pipelines/transforms/{transformId}
DataTransformList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | Yes | |
data[].enabled | boolean | Yes | |
data[].target | enum | Yes | Values: "event", "person" |
data[].kind | enum | Yes | Values: "rules", "javascript" |
data[].position | integer | Yes | |
data[].sources | array<enum> | Yes | |
data[].event_names | array<string> | Yes | |
data[].rules | array<map<string, any>> | Yes | |
data[].code | string | null | Yes | |
data[].error_count | integer | Yes | |
data[].last_error_code | enum | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/data-pipelines/transforms
DataTransformPreview
| Field | Type | Required | Description |
|---|---|---|---|
results | array<object> | Yes | |
results[].status | enum | Yes | Values: "kept", "dropped", "failed" |
results[].record | map<string, any> | null | Yes | |
results[].transform_id | string | null | Yes | |
results[].error_code | enum | null | Yes | |
results[].error_path | string | null | Yes | |
results[].error_message | string | null | Yes | |
results[].logs | array<string> | Yes | |
duration_ms | integer | Yes |
Used by: POST /v1/apps/{appId}/data-pipelines/transforms/preview
DecideDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–200 |
Used by: POST /v1/apps/{appId}/decision-agents/{id}/decide
DecisionAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
reward_events | array<string> | Yes | |
reward_window_hours | integer | Yes | |
holdout_percent | integer | Yes | |
context_prediction | string | null | Yes | |
use_best_channel | boolean | Yes | |
status | enum | Yes | Values: "active", "paused" |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/decision-agents, GET /v1/apps/{appId}/decision-agents/{id}, PATCH /v1/apps/{appId}/decision-agents/{id}
DecisionAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].arms | array<object> | Yes | |
data[].arms[].id | string | Yes | |
data[].arms[].label | string | Yes | |
data[].reward_events | array<string> | Yes | |
data[].reward_window_hours | integer | Yes | |
data[].holdout_percent | integer | Yes | |
data[].context_prediction | string | null | Yes | |
data[].use_best_channel | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused" |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/decision-agents
DecisionReport
| Field | Type | Required | Description |
|---|---|---|---|
agent_id | string | Yes | |
days | integer | Yes | |
learned | object | Yes | |
learned.assignments | integer | Yes | |
learned.settled | integer | Yes | |
learned.rewards | integer | Yes | |
learned.rate | number | null | Yes | |
holdout | object | Yes | |
holdout.assignments | integer | Yes | |
holdout.settled | integer | Yes | |
holdout.rewards | integer | Yes | |
holdout.rate | number | null | Yes | |
lift | number | null | Yes | |
p_value | number | null | Yes | |
significant | boolean | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
arms[].share | number | Yes | |
arms[].assignments | integer | Yes | |
arms[].settled | integer | Yes | |
arms[].rewards | integer | Yes | |
arms[].rate | number | null | Yes | |
contexts | array<object> | Yes | |
contexts[].context | string | Yes | |
contexts[].arm_id | string | Yes | |
contexts[].settled | integer | Yes | |
contexts[].rate | number | null | Yes |
Used by: GET /v1/apps/{appId}/decision-agents/{id}/report
DecisionResult
| Field | Type | Required | Description |
|---|---|---|---|
arm_id | string | Yes | |
label | string | Yes | |
policy | enum | Yes | Values: "thompson", "holdout" |
context | string | Yes |
Used by: POST /v1/apps/{appId}/decision-agents/{id}/decide
DeliverabilitySettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
bcc_address | string (email) | null | No | |
validation | object | No | |
validation.enabled | boolean | Yes | |
validation.check_mx | boolean | No | |
validation.block_disposable | boolean | No | |
validation.block_role | boolean | No | |
verifier | object | No | |
verifier.provider | enum | null | Yes | |
verifier.api_key | string | No | Length: 8–200 |
volume_spike | object | No | |
volume_spike.multiplier | integer | null | Yes | |
volume_spike.floor | integer | null | Yes | |
max_invalid_ratio | number | null | No | |
postmaster | object | No | |
postmaster.domain | string | null | Yes | |
postmaster.access_token | string | No | Length: 20–4096 |
Used by: PUT /v1/apps/{appId}/email-deliverability
Delivery
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
message_id | string | Yes | |
subscription_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
provider | string | null | Yes | |
status | enum | Yes | Values: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
attempt_count | integer | Yes | |
provider_message_id | string | null | Yes | |
error_code | string | null | Yes | |
error_message | string | null | Yes | |
suppression_reason | string | null | Yes | |
send_after | string | null | Yes | |
sent_at | string | null | Yes | |
delivered_at | string | null | Yes | |
opened_at | string | null | Yes | |
clicked_at | string | null | Yes | |
failed_at | string | null | Yes | |
created_at | string | Yes |
DeliveryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | Yes | |
data[].subscription_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].provider | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
data[].attempt_count | integer | Yes | |
data[].provider_message_id | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].error_message | string | null | Yes | |
data[].suppression_reason | string | null | Yes | |
data[].send_after | string | null | Yes | |
data[].sent_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].opened_at | string | null | Yes | |
data[].clicked_at | string | null | Yes | |
data[].failed_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/notifications/{messageId}/deliveries, GET /v1/apps/{appId}/campaigns/{campaignId}/deliveries
DiscardQuarantineDto
| Field | Type | Required | Description |
|---|---|---|---|
ids | array<string> | Yes | Items: 1–500 |
Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/discard
EmailAddressCheck
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
reason | enum | null | Yes | |
detail | string | null | Yes | |
checks | array<string> | Yes | |
unknown | array<string> | Yes |
Used by: POST /v1/apps/{appId}/email-deliverability/verify-address
EmailBounceStats
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | Yes | |
target_rate | number | Yes | |
suspend_rate | number | Yes | |
rate_7d | object | Yes | |
rate_7d.sent | integer | Yes | |
rate_7d.bounced | integer | Yes | |
rate_7d.rate | number | null | Yes | |
rate_30d | object | Yes | |
rate_30d.sent | integer | Yes | |
rate_30d.bounced | integer | Yes | |
rate_30d.rate | number | null | Yes | |
trend | array<object> | Yes | |
trend[].day | string | Yes | |
trend[].sent | integer | Yes | |
trend[].bounced | integer | Yes | |
trend[].soft_bounced | integer | Yes | |
trend[].rate | number | null | Yes | |
by_type | object | Yes | |
by_type.hard | integer | Yes | |
by_type.soft | integer | Yes | |
by_type.complaint | integer | Yes | |
by_type.blocked_before_send | integer | Yes | |
by_reason | array<object> | Yes | |
by_reason[].code | string | Yes | |
by_reason[].count | integer | Yes | |
top_domains | array<object> | Yes | |
top_domains[].domain | string | Yes | |
top_domains[].sent | integer | Yes | |
top_domains[].bounced | integer | Yes | |
top_domains[].rate | number | null | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/bounces
EmailDeliverabilitySettings
| Field | Type | Required | Description |
|---|---|---|---|
bcc_address | string | null | Yes | |
validation | object | Yes | |
validation.enabled | boolean | Yes | |
validation.check_mx | boolean | Yes | |
validation.block_disposable | boolean | Yes | |
validation.block_role | boolean | Yes | |
verifier | object | Yes | |
verifier.provider | enum | null | Yes | |
verifier.has_key | boolean | Yes | |
volume_spike | object | Yes | |
volume_spike.multiplier | integer | null | Yes | |
volume_spike.floor | integer | null | Yes | |
postmaster | object | Yes | |
postmaster.domain | string | null | Yes | |
postmaster.has_token | boolean | Yes | |
max_invalid_ratio | number | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability
EmailDesign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
subject | string | Yes | |
preheader | string | null | Yes | |
version | integer | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
created_by | string | null | Yes | |
updated_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
document | object | Yes | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
issues | array<object> | Yes | |
issues[].code | enum | Yes | Values: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing" |
issues[].severity | enum | Yes | Values: "error", "warning" |
issues[].block_id | string | Yes | |
issues[].mode | enum | No | Values: "light", "dark" |
issues[].ratio | number | No | |
issues[].required | number | No | |
issues[].foreground | string | No | |
issues[].background | string | No | |
warnings | array<string> | Yes |
EmailDesignPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].subject | string | Yes | |
data[].preheader | string | null | Yes | |
data[].version | integer | Yes | |
data[].template_id | string | null | Yes | |
data[].template_version | integer | null | Yes | |
data[].created_by | string | null | Yes | |
data[].updated_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
EmailDesignPreview
| Field | Type | Required | Description |
|---|---|---|---|
html | string | Yes | |
mjml | string | Yes | |
warnings | array<string> | Yes | |
issues | array<object> | Yes | |
issues[].code | enum | Yes | Values: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing" |
issues[].severity | enum | Yes | Values: "error", "warning" |
issues[].block_id | string | Yes | |
issues[].mode | enum | No | Values: "light", "dark" |
issues[].ratio | number | No | |
issues[].required | number | No | |
issues[].foreground | string | No | |
issues[].background | string | No |
EmailHygieneRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
status | enum | Yes | Values: "queued", "running", "completed", "failed" |
total | integer | Yes | |
processed | integer | Yes | |
valid | integer | Yes | |
invalid | integer | Yes | |
unknown | integer | Yes | |
reasons | map<string, integer> | Yes | |
error | string | null | Yes | |
suppressed_count | integer | null | Yes | |
suppressed_at | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}
EmailHygieneStart
| Field | Type | Required | Description |
|---|---|---|---|
run | object | Yes | |
run.id | string | Yes | |
run.app_id | string | Yes | |
run.status | enum | Yes | Values: "queued", "running", "completed", "failed" |
run.total | integer | Yes | |
run.processed | integer | Yes | |
run.valid | integer | Yes | |
run.invalid | integer | Yes | |
run.unknown | integer | Yes | |
run.reasons | map<string, integer> | Yes | |
run.error | string | null | Yes | |
run.suppressed_count | integer | null | Yes | |
run.suppressed_at | string | null | Yes | |
run.started_at | string | null | Yes | |
run.completed_at | string | null | Yes | |
run.created_at | string | Yes | |
run.updated_at | string | Yes | |
created | boolean | Yes |
Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs
EmailHygieneStatus
| Field | Type | Required | Description |
|---|---|---|---|
status | object | Yes | |
status.total | integer | Yes | |
status.valid | integer | Yes | |
status.invalid | integer | Yes | |
status.unknown | integer | Yes | |
status.pending | integer | Yes | |
status.unchecked | integer | Yes | |
status.invalid_by_reason | map<string, integer> | Yes | |
status.unsendable | integer | Yes | |
latest_run | object | null | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/hygiene
EmailHygieneSuppress
| Field | Type | Required | Description |
|---|---|---|---|
suppressed | integer | Yes | |
run | object | Yes | |
run.id | string | Yes | |
run.app_id | string | Yes | |
run.status | enum | Yes | Values: "queued", "running", "completed", "failed" |
run.total | integer | Yes | |
run.processed | integer | Yes | |
run.valid | integer | Yes | |
run.invalid | integer | Yes | |
run.unknown | integer | Yes | |
run.reasons | map<string, integer> | Yes | |
run.error | string | null | Yes | |
run.suppressed_count | integer | null | Yes | |
run.suppressed_at | string | null | Yes | |
run.started_at | string | null | Yes | |
run.completed_at | string | null | Yes | |
run.created_at | string | Yes | |
run.updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppress
EmailProviderInsights
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | Yes | |
providers | array<object> | Yes | |
providers[].provider | enum | Yes | Values: "gmail", "outlook", "yahoo", "other" |
providers[].sent | integer | Yes | |
providers[].delivered | integer | Yes | |
providers[].opened | integer | Yes | |
providers[].clicked | integer | Yes | |
providers[].bounced | integer | Yes | |
providers[].complained | integer | Yes | |
trend | array<object> | Yes | |
trend[].day | string | Yes | |
trend[].provider | enum | Yes | Values: "gmail", "outlook", "yahoo", "other" |
trend[].sent | integer | Yes | |
trend[].delivered | integer | Yes | |
trend[].bounced | integer | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/insights
EmailSavedBlock
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "section", "block" |
content | object | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes |
EmailSavedBlockList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "section", "block" |
data[].content | object | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes |
EmailWarmupPlan
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | |
start_date | string | Yes | |
daily_limits | array<integer> | Yes | |
provider_shares | map<string, number> | Yes | |
timezone | string | Yes | |
status | enum | Yes | Values: "active", "paused", "completed" |
today | object | Yes | |
today.day | string | Yes | |
today.index | integer | Yes | |
today.limit | integer | null | Yes | |
today.used | integer | Yes | |
today.buckets | map<string, object> | Yes | |
scheduled_ahead | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/email-deliverability/warmup-plans, GET /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}, PATCH /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}
EmailWarmupPlanList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "domain", "ip" |
data[].target | string | Yes | |
data[].start_date | string | Yes | |
data[].daily_limits | array<integer> | Yes | |
data[].provider_shares | map<string, number> | Yes | |
data[].timezone | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "completed" |
data[].today | object | Yes | |
data[].today.day | string | Yes | |
data[].today.index | integer | Yes | |
data[].today.limit | integer | null | Yes | |
data[].today.used | integer | Yes | |
data[].today.buckets | map<string, object> | Yes | |
data[].scheduled_ahead | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/warmup-plans
EmailWarmupUsage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].day | string | Yes | |
data[].bucket | string | Yes | |
data[].used | integer | Yes | |
data[].limit | integer | null | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usage
EndLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | Yes | Length: 1–100 |
content_state | map<string, string | number | boolean> | No | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Used by: POST /v1/apps/{appId}/live-activities/{activityType}/end
EngagementReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
timezone | string | Yes | |
totals | object | Yes | |
totals.opened | integer | Yes | |
totals.clicked | integer | Yes | |
previous | object | null | Yes | |
cells | array<object> | Yes | |
cells[].weekday | integer | Yes | |
cells[].hour | integer | Yes | |
cells[].opened | integer | Yes | |
cells[].clicked | integer | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].opened | integer | Yes | |
rows[].clicked | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/engagement
EstimateAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | No | Length: 1–∞ |
target | object | Yes | |
target.all | boolean | No | |
target.include_subscription_ids | array<string> | No | Items: 0–2000 |
target.include_external_ids | array<string> | No | Items: 0–2000 |
target.include_aliases | map<string, array<string>> | No | |
target.included_segments | array<string> | No | Items: 0–50 |
target.excluded_segments | array<string> | No | Items: 0–50 |
target.filters | any | No | |
target.channels | array<enum> | No | Items: 1–∞ |
target.test_devices_only | boolean | No | |
target.email_to | array<string> | No | Items: 1–2000 |
target.include_phone_numbers | array<string> | No | Items: 1–2000 |
include_unsubscribed | boolean | No |
Used by: POST /v1/notifications/estimate
EstimateAudienceResult
| Field | Type | Required | Description |
|---|---|---|---|
recipients | integer | Yes | |
by_channel | map<string, integer> | Yes | |
new_contacts | integer | Yes | |
external_id_missing | array<string> | Yes |
Used by: POST /v1/notifications/estimate
EvaluateAppFlagsDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | Length: 1–255 |
user_id | string | No | Length: 1–64 |
subject | string | No | Length: 1–128 |
Used by: POST /v1/apps/{appId}/feature-flags/evaluate
EventDefinition
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
display_name | string | null | Yes | |
properties_schema | map<string, string> | Yes | |
is_conversion | boolean | Yes | |
outcome_unique | boolean | Yes | |
outcome_unattributed | boolean | Yes | |
retention_days | integer | null | Yes | |
first_seen_at | string | Yes | |
last_seen_at | string | Yes | |
count_30d | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: PATCH /v1/apps/{appId}/events/definitions/{name}
EventDefinitionDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
display_name | string | null | Yes | |
properties_schema | map<string, string> | Yes | |
is_conversion | boolean | Yes | |
outcome_unique | boolean | Yes | |
outcome_unattributed | boolean | Yes | |
retention_days | integer | null | Yes | |
first_seen_at | string | Yes | |
last_seen_at | string | Yes | |
count_30d | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].count | integer | Yes | |
daily[].users | integer | Yes | |
properties | array<object> | Yes | |
properties[].key | string | Yes | |
properties[].type | string | Yes | |
properties[].values | array<object> | Yes | |
properties[].values[].value | string | Yes | |
properties[].values[].count | integer | Yes |
Used by: GET /v1/apps/{appId}/events/definitions/{name}
EventDefinitionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].display_name | string | null | Yes | |
data[].properties_schema | map<string, string> | Yes | |
data[].is_conversion | boolean | Yes | |
data[].outcome_unique | boolean | Yes | |
data[].outcome_unattributed | boolean | Yes | |
data[].retention_days | integer | null | Yes | |
data[].first_seen_at | string | Yes | |
data[].last_seen_at | string | Yes | |
data[].count_30d | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/events/definitions
EventList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_id | string | null | Yes | |
data[].name | string | Yes | |
data[].properties | map<string, any> | Yes | |
data[].value | number | null | Yes | |
data[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
data[].occurred_at | string | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/events
EventsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-events, POST /sdk/v1/apps/{appId}/events, POST /v1/apps/{appId}/events
EventsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
group_by | enum | Yes | Values: "day", "name" |
name | string | null | Yes | |
totals | object | Yes | |
totals.count | integer | Yes | |
totals.users | integer | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].count | integer | Yes | |
rows[].users | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/events
Export
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | Yes | |
filters.from | string (date-time) | No | |
filters.to | string (date-time) | No | |
filters.name | string | No | Length: 0–100 |
filters.message_id | string | No | Length: 0–64 |
filters.campaign_id | string | No | Length: 0–64 |
filters.status | string | No | Length: 0–32 |
filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
filters.segment_id | string | No | Length: 0–64 |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
row_count | integer | null | Yes | |
error | string | null | Yes | |
download_url | string | null | Yes | |
expires_at | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Used by: POST /v1/apps/{appId}/exports, GET /v1/apps/{appId}/exports/{exportId}, GET /v1/notifications/{messageId}/history, POST /v1/notifications/{messageId}/export_events
ExportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
data[].filters | object | Yes | |
data[].filters.from | string (date-time) | No | |
data[].filters.to | string (date-time) | No | |
data[].filters.name | string | No | Length: 0–100 |
data[].filters.message_id | string | No | Length: 0–64 |
data[].filters.campaign_id | string | No | Length: 0–64 |
data[].filters.status | string | No | Length: 0–32 |
data[].filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].filters.segment_id | string | No | Length: 0–64 |
data[].status | enum | Yes | Values: "pending", "running", "completed", "failed" |
data[].row_count | integer | null | Yes | |
data[].error | string | null | Yes | |
data[].download_url | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].requested_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].completed_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/exports
Form
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "archived" |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | Yes | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
stats | object | Yes | |
stats.submissions | integer | Yes | |
stats.last_submission_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/forms, GET /v1/apps/{appId}/forms/{formId}, PATCH /v1/apps/{appId}/forms/{formId}
FormPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "archived" |
data[].fields | array<object> | Yes | Items: 1–20 |
data[].fields[].id | string | Yes | |
data[].fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
data[].fields[].label | map<string, string> | Yes | |
data[].fields[].placeholder | map<string, string> | No | |
data[].fields[].required | boolean | No | |
data[].fields[].options | array<object> | No | Items: 0–30 |
data[].fields[].maps_to | string | No | |
data[].fields[].max_length | integer | No | Range: 1–2000 |
data[].fields[].policy_url | string (url) | No | Length: 0–2000 |
data[].settings | object | Yes | |
data[].settings.submit_label | map<string, string> | No | |
data[].settings.success_message | map<string, string> | No | |
data[].settings.redirect_url | string (url) | No | Length: 0–2000 |
data[].settings.tags | map<string, string> | No | |
data[].settings.subscribe | object | No | |
data[].settings.double_opt_in | object | No | |
data[].settings.event_name | string | No | |
data[].settings.captcha | boolean | No | |
data[].settings.default_language | string | No | Length: 2–10 |
data[].stats | object | Yes | |
data[].stats.submissions | integer | Yes | |
data[].stats.last_submission_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/forms
FormSubmission
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
form_id | string | Yes | |
user_id | string | null | Yes | |
subscription_ids | array<string> | Yes | |
source | enum | Yes | Values: "web_campaign", "landing_page", "sdk", "api" |
source_id | string | null | Yes | |
status | enum | Yes | Values: "accepted", "pending_confirmation", "confirmed" |
data | map<string, string | boolean | array<string>> | Yes | |
consent | array<object> | Yes | |
consent[].field_id | string | Yes | |
consent[].given | boolean | Yes | |
consent[].text | string | Yes | |
consent[].text_hash | string | Yes | |
consent[].policy_url | string | null | Yes | |
consent[].language | string | Yes | |
consent[].at | string | Yes | |
page_url | string | null | Yes | |
language | string | null | Yes | |
confirmed_at | string | null | Yes | |
created_at | string | Yes |
FormSubmissionPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].form_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_ids | array<string> | Yes | |
data[].source | enum | Yes | Values: "web_campaign", "landing_page", "sdk", "api" |
data[].source_id | string | null | Yes | |
data[].status | enum | Yes | Values: "accepted", "pending_confirmation", "confirmed" |
data[].data | map<string, string | boolean | array<string>> | Yes | |
data[].consent | array<object> | Yes | |
data[].consent[].field_id | string | Yes | |
data[].consent[].given | boolean | Yes | |
data[].consent[].text | string | Yes | |
data[].consent[].text_hash | string | Yes | |
data[].consent[].policy_url | string | null | Yes | |
data[].consent[].language | string | Yes | |
data[].consent[].at | string | Yes | |
data[].page_url | string | null | Yes | |
data[].language | string | null | Yes | |
data[].confirmed_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/forms/{formId}/submissions
FormSubmitResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
status | enum | Yes | Values: "accepted", "pending_confirmation" |
submission_id | string | null | Yes | |
success_message | string | Yes | |
redirect_url | string | null | Yes |
Used by: POST /sdk/v1/apps/{appId}/forms/{formId}/submissions, POST /v1/apps/{appId}/forms/{formId}/submissions
FunnelBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
steps | array<object> | Yes | Items: 2–8 |
steps[].name | string | Yes | Length: 1–100 |
steps[].where | object | No | |
steps[].where.key | string | Yes | Length: 1–64 |
steps[].where.value | string | Yes | Length: 0–500 |
from | string (date-time) | No | |
to | string (date-time) | No | |
window_hours | integer | No | Default: 72; Range: 1–720 |
compare | boolean | No | Default: false |
format | enum | No | Values: "json", "csv"; Default: "json" |
Used by: POST /v1/apps/{appId}/analytics/funnels
FunnelReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
window_hours | integer | Yes | |
steps | array<object> | Yes | |
steps[].name | string | Yes | |
steps[].users | integer | Yes | |
steps[].conversion_rate | number | null | Yes | |
steps[].drop_off | integer | Yes | |
overall_rate | number | null | Yes | |
previous | object | null | Yes |
Used by: POST /v1/apps/{appId}/analytics/funnels
Geofence
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
lat | number | Yes | |
lng | number | Yes | |
radius_m | integer | Yes | |
cooldown_minutes | integer | Yes | |
enabled | boolean | Yes | |
enter_count | integer | Yes | |
exit_count | integer | Yes | |
inside_count | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/geofences, GET /v1/apps/{appId}/geofences/{geofenceId}, PATCH /v1/apps/{appId}/geofences/{geofenceId}
GeofenceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].lat | number | Yes | |
data[].lng | number | Yes | |
data[].radius_m | integer | Yes | |
data[].cooldown_minutes | integer | Yes | |
data[].enabled | boolean | Yes | |
data[].enter_count | integer | Yes | |
data[].exit_count | integer | Yes | |
data[].inside_count | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/geofences
GlobalControl
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/global-control, PUT /v1/apps/{appId}/global-control, POST /v1/apps/{appId}/global-control/reset
GlobalControlReport
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes | |
from | string | Yes | |
to | string | Yes | |
events | array<string> | Yes | |
control | object | Yes | |
control.users | integer | Yes | |
control.converted | integer | Yes | |
control.conversion_rate | number | Yes | |
treatment | object | Yes | |
treatment.users | integer | Yes | |
treatment.converted | integer | Yes | |
treatment.conversion_rate | number | Yes | |
lift_percent | number | null | Yes | |
incremental_conversions | integer | Yes | |
p_value | number | null | Yes | |
significant | boolean | Yes | |
withheld_messages | integer | Yes |
Used by: GET /v1/apps/{appId}/global-control/report
IdentityKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
kid | string | Yes | |
alg | "ES256" | Yes | |
public_jwk | map<string, string> | Yes | |
label | string | null | Yes | |
created_at | string | Yes | |
revoked_at | string | null | Yes |
Used by: POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}
IdentityKeyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kid | string | Yes | |
data[].alg | "ES256" | Yes | |
data[].public_jwk | map<string, string> | Yes | |
data[].label | string | null | Yes | |
data[].created_at | string | Yes | |
data[].revoked_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/identity-keys
Import
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "legacy_players", "csv_users" |
file_name | string | null | Yes | |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
stats | object | Yes | |
stats.processed | integer | No | |
stats.created_users | integer | No | |
stats.updated_users | integer | No | |
stats.created_subscriptions | integer | No | |
stats.skipped | integer | No | |
stats.errors | integer | No | |
stats.rejected_emails | integer | No | |
stats.rejected_email_reasons | map<string, integer> | No | |
error | string | null | Yes | |
error_report_url | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Used by: POST /v1/apps/{appId}/imports, GET /v1/apps/{appId}/imports/{importId}
ImportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "legacy_players", "csv_users" |
data[].file_name | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "running", "completed", "failed" |
data[].stats | object | Yes | |
data[].stats.processed | integer | No | |
data[].stats.created_users | integer | No | |
data[].stats.updated_users | integer | No | |
data[].stats.created_subscriptions | integer | No | |
data[].stats.skipped | integer | No | |
data[].stats.errors | integer | No | |
data[].stats.rejected_emails | integer | No | |
data[].stats.rejected_email_reasons | map<string, integer> | No | |
data[].error | string | null | Yes | |
data[].error_report_url | string | null | Yes | |
data[].requested_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].completed_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/imports
InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, PATCH /v1/apps/{appId}/in-app-messages/{messageId}, POST /v1/apps/{appId}/in-app-messages/{messageId}/status, POST /v1/apps/{appId}/in-app-messages/{messageId}/winner, POST /v1/apps/{appId}/mcp/in-app-drafts
InAppMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].priority | integer | Yes | |
data[].triggers | array<object> | Yes | |
data[].trigger_groups | array<array<object>> | null | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | Length: 1–64 |
data[].variants[].name | string | Yes | Length: 1–60 |
data[].variants[].weight_percent | integer | Yes | Range: 1–99 |
data[].variants[].display | object | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | No | |
data[].display.text_color | string | No | |
data[].display.dismissible | boolean | No | |
data[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
data[].display.content_type | enum | No | Values: "blocks", "html" |
data[].display.html | map<string, string> | No | |
data[].display.html_height | integer | No | Range: 40–2000 |
data[].display.blocks | array<object> | Yes | Items: 0–12 |
data[].audience | object | Yes | |
data[].audience.included_segments | array<string> | No | Items: 0–20 |
data[].audience.excluded_segments | array<string> | No | Items: 0–20 |
data[].audience.global_control_exempt | boolean | No | |
data[].frequency | object | Yes | |
data[].frequency.max_impressions | integer | No | Range: 1–1000 |
data[].frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
data[].frequency.stop_after_interaction | boolean | No | |
data[].journey_only | boolean | Yes | |
data[].placement | string | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.impressions | integer | Yes | |
data[].stats.clicks | integer | Yes | |
data[].stats.dismissals | integer | Yes | |
data[].stats.unique_users | integer | Yes | |
data[].stats.ctr | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_stats[].impressions | integer | Yes | |
data[].variant_stats[].clicks | integer | Yes | |
data[].variant_stats[].ctr | number | Yes | |
data[].ab_test | object | Yes | |
data[].ab_test.winner | object | No | |
data[].ab_test.winner_variant_id | string | null | Yes | |
data[].ab_test.decided_at | string | null | Yes | |
data[].ab_test.decided_by | string | null | Yes | |
data[].variant_significance | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/in-app-messages
InAppStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Used by: POST /v1/apps/{appId}/in-app-messages/{messageId}/status
InAppTemplate
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
source | enum | Yes | Values: "system", "org" |
category | enum | Yes | Values: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom" |
name | string | Yes | |
description | string | null | Yes | |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
created_at | string | null | Yes | |
updated_at | string | null | Yes |
InAppTemplateList
| Field | Type | Required | Description |
|---|---|---|---|
gallery_version | string | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].source | enum | Yes | Values: "system", "org" |
data[].category | enum | Yes | Values: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom" |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | No | |
data[].display.text_color | string | No | |
data[].display.dismissible | boolean | No | |
data[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
data[].display.content_type | enum | No | Values: "blocks", "html" |
data[].display.html | map<string, string> | No | |
data[].display.html_height | integer | No | Range: 40–2000 |
data[].display.blocks | array<object> | Yes | Items: 0–12 |
data[].created_at | string | null | Yes | |
data[].updated_at | string | null | Yes |
InAppWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Used by: POST /v1/apps/{appId}/in-app-messages/{messageId}/winner
InboxAgent
| Field | Type | Required | Description |
|---|---|---|---|
account_id | string | Yes | |
name | string | Yes | |
email | string | Yes | |
role | string | Yes | |
status | enum | Yes | Values: "online", "busy", "offline" |
last_heartbeat_at | string | null | Yes | |
max_concurrent | integer | null | Yes | |
languages | array<string> | Yes | |
open_conversations | integer | Yes | |
team_ids | array<string> | Yes |
Used by: PATCH /v1/apps/{appId}/inbox/agents/{accountId}
InboxAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].account_id | string | Yes | |
data[].name | string | Yes | |
data[].email | string | Yes | |
data[].role | string | Yes | |
data[].status | enum | Yes | Values: "online", "busy", "offline" |
data[].last_heartbeat_at | string | null | Yes | |
data[].max_concurrent | integer | null | Yes | |
data[].languages | array<string> | Yes | |
data[].open_conversations | integer | Yes | |
data[].team_ids | array<string> | Yes |
Used by: GET /v1/apps/{appId}/inbox/agents
InboxItem
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
message_id | string | null | Yes | |
title | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
data | map<string, string> | Yes | |
read | boolean | Yes | |
read_at | string | null | Yes | |
archived_at | string | null | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes |
Used by: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read
InboxMetrics
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
first_response | object | Yes | |
first_response.count | integer | Yes | |
first_response.avg_seconds | number | null | Yes | |
first_response.p90_seconds | number | null | Yes | |
resolution | object | Yes | |
resolution.count | integer | Yes | |
resolution.avg_seconds | number | null | Yes | |
resolution.p90_seconds | number | null | Yes | |
sla | object | Yes | |
sla.target_seconds | integer | Yes | |
sla.met | integer | Yes | |
sla.breached | integer | Yes | |
sla.rate | number | null | Yes | |
volume | object | Yes | |
volume.created | integer | Yes | |
volume.resolved | integer | Yes | |
volume.open_now | integer | Yes | |
volume.unassigned_now | integer | Yes | |
volume.by_channel | map<string, integer> | Yes | |
agents | array<object> | Yes | |
agents[].account_id | string | Yes | |
agents[].name | string | null | Yes | |
agents[].first_response | object | Yes | |
agents[].first_response.count | integer | Yes | |
agents[].first_response.avg_seconds | number | null | Yes | |
agents[].first_response.p90_seconds | number | null | Yes | |
agents[].resolution | object | Yes | |
agents[].resolution.count | integer | Yes | |
agents[].resolution.avg_seconds | number | null | Yes | |
agents[].resolution.p90_seconds | number | null | Yes | |
agents[].resolved | integer | Yes | |
agents[].open_now | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].created | integer | Yes | |
daily[].resolved | integer | Yes | |
daily[].first_response_avg_seconds | number | null | Yes |
Used by: GET /v1/apps/{appId}/inbox/metrics
InboxPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | null | Yes | |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].url | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].data | map<string, string> | Yes | |
data[].read | boolean | Yes | |
data[].read_at | string | null | Yes | |
data[].archived_at | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
unread_count | integer | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /sdk/v1/apps/{appId}/users/{userId}/inbox, GET /v1/apps/{appId}/users/by/{label}/{value}/inbox
InboxReadAllResult
| Field | Type | Required | Description |
|---|---|---|---|
updated | integer | Yes | |
unread_count | integer | Yes |
Used by: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all
InboxSettings
| Field | Type | Required | Description |
|---|---|---|---|
widget | object | Yes | |
widget.enabled | boolean | No | |
widget.color | string | No | |
widget.text_color | string | No | |
widget.position | enum | No | Values: "right", "left" |
widget.theme | enum | No | Values: "light", "dark", "auto" |
widget.title | map<string, string> | No | |
widget.greeting | map<string, string> | No | |
widget.offline_message | map<string, string> | No | |
widget.collect_email_offline | boolean | No | |
widget.attachments | boolean | No | |
widget.require_email | boolean | No | |
business_hours | object | Yes | |
business_hours.enabled | boolean | No | |
business_hours.timezone | string | null | No | |
business_hours.days | array<object> | No | Items: 0–21 |
business_hours.days[].day | integer | Yes | Range: 0–6 |
business_hours.days[].start | string | Yes | |
business_hours.days[].end | string | Yes | |
business_hours.holidays | array<string> | No | Items: 0–100 |
routing | object | Yes | |
routing.auto_assign | boolean | Yes | |
routing.visibility | enum | Yes | Values: "all", "team", "assigned" |
routing.show_unassigned | boolean | Yes | |
routing.first_response_sla_seconds | integer | Yes | |
routing.max_concurrent_default | integer | null | Yes | |
email | object | Yes | |
email.capture_replies | boolean | Yes | |
email.reply_domain | string | null | Yes | |
timezone | string | Yes | |
within_business_hours | boolean | Yes | |
install | object | Yes | |
install.app_id | string | Yes | |
install.sdk_url | string | Yes | |
install.api_url | string | Yes |
Used by: GET /v1/apps/{appId}/inbox/settings, PUT /v1/apps/{appId}/inbox/settings
InboxSettingsUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
widget | object | No | |
widget.enabled | boolean | No | |
widget.color | string | No | |
widget.text_color | string | No | |
widget.position | enum | No | Values: "right", "left" |
widget.theme | enum | No | Values: "light", "dark", "auto" |
widget.title | map<string, string> | No | |
widget.greeting | map<string, string> | No | |
widget.offline_message | map<string, string> | No | |
widget.collect_email_offline | boolean | No | |
widget.attachments | boolean | No | |
widget.require_email | boolean | No | |
business_hours | object | No | |
business_hours.enabled | boolean | No | |
business_hours.timezone | string | null | No | |
business_hours.days | array<object> | No | Items: 0–21 |
business_hours.days[].day | integer | Yes | Range: 0–6 |
business_hours.days[].start | string | Yes | |
business_hours.days[].end | string | Yes | |
business_hours.holidays | array<string> | No | Items: 0–100 |
routing | object | No | |
routing.auto_assign | boolean | No | |
routing.visibility | enum | No | Values: "all", "team", "assigned" |
routing.show_unassigned | boolean | No | |
routing.first_response_sla_seconds | integer | No | Range: 30–604800 |
routing.max_concurrent_default | integer | null | No | |
email | object | No | |
email.capture_replies | boolean | No |
Used by: PUT /v1/apps/{appId}/inbox/settings
InboxTeam
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
member_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/inbox/teams, PATCH /v1/apps/{appId}/inbox/teams/{teamId}
InboxTeamList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].member_ids | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/inbox/teams
Integration
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
name | string | Yes | |
status | enum | Yes | Values: "active", "paused", "error" |
settings | map<string, any> | Yes | |
events | array<string> | Yes | |
credentials | map<string, string> | Yes | |
state | map<string, any> | Yes | |
inbound_url | string | null | Yes | |
interactions_url | string | null | Yes | |
pending_events | integer | Yes | |
dead_events | integer | Yes | |
hooks | integer | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
last_success_at | string | null | Yes | |
last_run_at | string | null | Yes | |
next_sync_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/integrations/{type}
IntegrationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "error" |
data[].settings | map<string, any> | Yes | |
data[].events | array<string> | Yes | |
data[].credentials | map<string, string> | Yes | |
data[].state | map<string, any> | Yes | |
data[].inbound_url | string | null | Yes | |
data[].interactions_url | string | null | Yes | |
data[].pending_events | integer | Yes | |
data[].dead_events | integer | Yes | |
data[].hooks | integer | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].next_sync_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
catalog | array<object> | Yes | |
catalog[].type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
catalog[].events | array<string> | Yes | |
catalog[].cohorts | boolean | Yes | |
catalog[].inbound | boolean | Yes |
Used by: GET /v1/apps/{appId}/integrations
IntegrationOk
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Used by: DELETE /v1/apps/{appId}/integrations/zapier/hooks/{hookId}
IntegrationRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kind | enum | Yes | Values: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test" |
data[].trigger | enum | Yes | Values: "schedule", "manual", "event", "inbound" |
data[].status | enum | Yes | Values: "running", "succeeded", "partial", "failed" |
data[].stats | map<string, number> | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes |
Used by: GET /v1/apps/{appId}/integrations/{type}/runs
IntegrationSyncResult
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes |
Used by: POST /v1/apps/{appId}/integrations/{type}/sync
IntegrationTestResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
error | string | null | Yes | |
run_id | string | Yes |
Used by: POST /v1/apps/{appId}/integrations/{type}/test
Invite
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
email | string | Yes | |
role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
expires_at | string | Yes | |
invited_by | string | null | Yes | |
created_at | string | Yes |
InviteList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].email | string | Yes | |
data[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
data[].expires_at | string | Yes | |
data[].invited_by | string | null | Yes | |
data[].created_at | string | Yes |
InvitePreview
| Field | Type | Required | Description |
|---|---|---|---|
org_name | string | Yes | |
email | string | Yes | |
role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
expires_at | string | Yes | |
inviter_name | string | null | Yes |
InvoiceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].provider_invoice_id | string | Yes | |
data[].amount | integer | Yes | |
data[].currency | string | Yes | |
data[].status | string | Yes | |
data[].pdf_url | string | null | Yes | |
data[].hosted_url | string | null | Yes | |
data[].period_start | string | null | Yes | |
data[].period_end | string | null | Yes | |
data[].issued_at | string | null | Yes |
IssueWalletPassDto
| Field | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Length: 0–64 |
external_id | string | No | Length: 1–200 |
barcode_value | string | No | Length: 1–500 |
values | map<string, string> | No |
Used by: POST /v1/apps/{appId}/wallet/passes
Journey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes |
JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
Used by: POST /v1/apps/{appId}/journeys, GET /v1/apps/{appId}/journeys/{journeyId}, PATCH /v1/apps/{appId}/journeys/{journeyId}, PUT /v1/apps/{appId}/journeys/{journeyId}/draft, PATCH /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}, POST /v1/apps/{appId}/journeys/{journeyId}/versions/{version}/restore, POST /v1/apps/{appId}/journeys/{journeyId}/pause, POST /v1/apps/{appId}/journeys/{journeyId}/resume, POST /v1/apps/{appId}/journeys/{journeyId}/archive, POST /v1/apps/{appId}/journeys/{journeyId}/duplicate, POST /v1/apps/{appId}/mcp/journey-drafts
JourneyPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].current_version | integer | null | Yes | |
data[].draft_version | integer | null | Yes | |
data[].trigger_kind | string | null | Yes | |
data[].published_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].summary | object | Yes | |
data[].summary.runs_total | integer | Yes | |
data[].summary.active | integer | Yes | |
data[].summary.completed | integer | Yes | |
data[].summary.exited | integer | Yes | |
data[].summary.failed | integer | Yes | |
data[].summary.goal_reached | integer | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/journeys
JourneyPublishResult
| Field | Type | Required | Description |
|---|---|---|---|
journey | object | Yes | |
journey.id | string | Yes | |
journey.app_id | string | Yes | |
journey.name | string | Yes | |
journey.description | string | null | Yes | |
journey.status | enum | Yes | Values: "draft", "active", "paused", "archived" |
journey.current_version | integer | null | Yes | |
journey.draft_version | integer | null | Yes | |
journey.trigger_kind | string | null | Yes | |
journey.published_at | string | null | Yes | |
journey.created_by | string | null | Yes | |
journey.created_at | string | Yes | |
journey.updated_at | string | Yes | |
journey.summary | object | Yes | |
journey.summary.runs_total | integer | Yes | |
journey.summary.active | integer | Yes | |
journey.summary.completed | integer | Yes | |
journey.summary.exited | integer | Yes | |
journey.summary.failed | integer | Yes | |
journey.summary.goal_reached | integer | Yes | |
version | integer | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
Used by: POST /v1/apps/{appId}/journeys/{journeyId}/publish
JourneyRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
journey_id | string | Yes | |
version | integer | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Yes | |
next_action_at | string | null | Yes | |
entered_at | string | Yes | |
completed_at | string | null | Yes | |
exit_reason | string | null | Yes | |
goal_id | string | null | Yes | |
goal_reached_at | string | null | Yes | |
context | map<string, any> | Yes |
JourneyRunDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
journey_id | string | Yes | |
version | integer | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Yes | |
next_action_at | string | null | Yes | |
entered_at | string | Yes | |
completed_at | string | null | Yes | |
exit_reason | string | null | Yes | |
goal_id | string | null | Yes | |
goal_reached_at | string | null | Yes | |
context | map<string, any> | Yes | |
journey_name | string | Yes | |
steps | array<object> | Yes | |
steps[].id | string | Yes | |
steps[].node_id | string | Yes | |
steps[].node_type | string | Yes | |
steps[].status | enum | Yes | Values: "completed", "waiting", "failed", "skipped" |
steps[].branch | string | null | Yes | |
steps[].result | map<string, any> | Yes | |
steps[].started_at | string | Yes | |
steps[].finished_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}, DELETE /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}
JourneyRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].journey_id | string | Yes | |
data[].version | integer | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Yes | |
data[].next_action_at | string | null | Yes | |
data[].entered_at | string | Yes | |
data[].completed_at | string | null | Yes | |
data[].exit_reason | string | null | Yes | |
data[].goal_id | string | null | Yes | |
data[].goal_reached_at | string | null | Yes | |
data[].context | map<string, any> | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/journeys/{journeyId}/runs
JourneyStats
| Field | Type | Required | Description |
|---|---|---|---|
version | integer | null | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
summary.waiting | integer | Yes | |
summary.goal_conversion_rate | number | Yes | |
nodes | array<object> | Yes | |
nodes[].node_id | string | Yes | |
nodes[].node_type | string | Yes | |
nodes[].entered | integer | Yes | |
nodes[].completed | integer | Yes | |
nodes[].waiting_now | integer | Yes | |
nodes[].skipped | integer | Yes | |
nodes[].failed | integer | Yes | |
nodes[].branches | map<string, integer> | Yes | |
nodes[].messages | map<string, integer> | No | |
nodes[].variants | array<object> | No | |
nodes[].variants[].variant_id | string | Yes | |
nodes[].variants[].sent | integer | Yes | |
nodes[].variants[].opened | integer | Yes | |
nodes[].variants[].clicked | integer | Yes | |
nodes[].variants[].converted | integer | Yes | |
nodes[].variants[].winner | boolean | Yes | |
goals | array<object> | Yes | |
goals[].goal_id | string | Yes | |
goals[].reached | integer | Yes | |
exit_reasons | map<string, integer> | Yes |
Used by: GET /v1/apps/{appId}/journeys/{journeyId}/stats
JourneyTriggerResult
| Field | Type | Required | Description |
|---|---|---|---|
entered | boolean | Yes | |
run | object | null | Yes | |
reason | enum | null | Yes |
Used by: POST /v1/apps/{appId}/journeys/{journeyId}/runs
JourneyVersionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].version | integer | Yes | |
data[].graph | map<string, any> | Yes | |
data[].settings | map<string, any> | Yes | |
data[].published_at | string | null | Yes | |
data[].published_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/journeys/{journeyId}/versions
LandingPage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
status | enum | Yes | Values: "draft", "published", "archived" |
seo | object | Yes | |
seo.title | string | No | Length: 0–120 |
seo.description | string | No | Length: 0–320 |
seo.og_image | string (url) | No | Length: 0–2000 |
seo.canonical_url | string (url) | No | Length: 0–2000 |
seo.noindex | boolean | No | |
settings | object | Yes | |
settings.language | string | No | Length: 2–10 |
settings.form_id | string | null | No | |
settings.form_section_id | string | null | No | |
settings.cookie_consent | object | No | |
settings.cookie_consent.enabled | boolean | Yes | |
settings.cookie_consent.text | string | No | Length: 0–1000 |
settings.cookie_consent.accept_label | string | No | Length: 0–60 |
settings.cookie_consent.reject_label | string | No | Length: 0–60 |
settings.cookie_consent.policy_url | string (url) | No | Length: 0–2000 |
settings.web_sdk | boolean | No | |
settings.favicon_url | string (url) | No | Length: 0–2000 |
custom_domain_id | string | null | Yes | |
version | integer | Yes | |
published_version | integer | null | Yes | |
published_at | string | null | Yes | |
has_unpublished_changes | boolean | Yes | |
url | string | Yes | |
domain_url | string | null | Yes | |
stats | object | Yes | |
stats.submissions | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
document | object | Yes | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
Used by: POST /v1/apps/{appId}/mcp/landing-page-drafts, POST /v1/apps/{appId}/landing-pages, GET /v1/apps/{appId}/landing-pages/{pageId}, PATCH /v1/apps/{appId}/landing-pages/{pageId}, POST /v1/apps/{appId}/landing-pages/{pageId}/publish, POST /v1/apps/{appId}/landing-pages/{pageId}/unpublish, POST /v1/apps/{appId}/landing-pages/{pageId}/archive, POST /v1/apps/{appId}/landing-pages/{pageId}/versions/{version}/restore
LandingPageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].slug | string | Yes | |
data[].status | enum | Yes | Values: "draft", "published", "archived" |
data[].seo | object | Yes | |
data[].seo.title | string | No | Length: 0–120 |
data[].seo.description | string | No | Length: 0–320 |
data[].seo.og_image | string (url) | No | Length: 0–2000 |
data[].seo.canonical_url | string (url) | No | Length: 0–2000 |
data[].seo.noindex | boolean | No | |
data[].settings | object | Yes | |
data[].settings.language | string | No | Length: 2–10 |
data[].settings.form_id | string | null | No | |
data[].settings.form_section_id | string | null | No | |
data[].settings.cookie_consent | object | No | |
data[].settings.web_sdk | boolean | No | |
data[].settings.favicon_url | string (url) | No | Length: 0–2000 |
data[].custom_domain_id | string | null | Yes | |
data[].version | integer | Yes | |
data[].published_version | integer | null | Yes | |
data[].published_at | string | null | Yes | |
data[].has_unpublished_changes | boolean | Yes | |
data[].url | string | Yes | |
data[].domain_url | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.submissions | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/landing-pages
LandingPageVersions
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].version | integer | Yes | |
data[].published_at | string | Yes | |
data[].published_by | string | null | Yes |
Used by: GET /v1/apps/{appId}/landing-pages/{pageId}/versions
LandingPreviewResult
| Field | Type | Required | Description |
|---|---|---|---|
html | string | Yes |
LiveActivitySendResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | |
activity_id | string | Yes | |
event | enum | Yes | Values: "start", "update", "end" |
recipients_estimate | integer | Yes |
Used by: POST /v1/apps/{appId}/live-activities/{activityType}/start, POST /v1/apps/{appId}/live-activities/{activityType}/update, POST /v1/apps/{appId}/live-activities/{activityType}/end
LiveActivityTokenResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Used by: DELETE /v1/apps/{appId}/live-activities/types/{activityType}, POST /sdk/v1/apps/{appId}/live-activities/tokens, POST /sdk/v1/apps/{appId}/live-activities/tokens/delete
LiveActivityType
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
content_state_schema | object | Yes | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | Yes | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
push_to_start_tokens | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}
LiveActivityTypeList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].content_state_schema | object | Yes | |
data[].content_state_schema.type | "object" | Yes | |
data[].content_state_schema.properties | map<string, object> | Yes | |
data[].content_state_schema.required | array<string> | No | Items: 0–50 |
data[].attributes_schema | object | Yes | |
data[].attributes_schema.type | "object" | Yes | |
data[].attributes_schema.properties | map<string, object> | Yes | |
data[].attributes_schema.required | array<string> | No | Items: 0–50 |
data[].push_to_start_tokens | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/live-activities/types
LoginResult
| Field | Type | Required | Description |
|---|---|---|---|
mfa_required | boolean | Yes | |
mfa_token | string | No | |
account | object | No | |
account.id | string | Yes | |
account.email | string | Yes | |
account.name | string | Yes | |
account.locale | string | Yes | |
account.timezone | string | Yes | |
account.email_verified | boolean | Yes | |
account.mfa_enabled | boolean | Yes | |
account.is_platform_admin | boolean | Yes | |
account.has_password | boolean | Yes | |
account.marketing_opt_in | boolean | Yes | |
account.preferences | object | Yes | |
account.preferences.date_format | enum | Yes | Values: "auto", "dmy", "mdy", "iso" |
account.preferences.time_format | enum | Yes | Values: "auto", "24h", "12h" |
account.preferences.table_density | enum | Yes | Values: "comfortable", "compact" |
account.created_at | string | Yes |
Me
| Field | Type | Required | Description |
|---|---|---|---|
account | object | Yes | |
account.id | string | Yes | |
account.email | string | Yes | |
account.name | string | Yes | |
account.locale | string | Yes | |
account.timezone | string | Yes | |
account.email_verified | boolean | Yes | |
account.mfa_enabled | boolean | Yes | |
account.is_platform_admin | boolean | Yes | |
account.has_password | boolean | Yes | |
account.marketing_opt_in | boolean | Yes | |
account.preferences | object | Yes | |
account.preferences.date_format | enum | Yes | Values: "auto", "dmy", "mdy", "iso" |
account.preferences.time_format | enum | Yes | Values: "auto", "24h", "12h" |
account.preferences.table_density | enum | Yes | Values: "comfortable", "compact" |
account.created_at | string | Yes | |
memberships | array<object> | Yes | |
memberships[].org_id | string | Yes | |
memberships[].org_name | string | Yes | |
memberships[].org_slug | string | Yes | |
memberships[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
memberships[].app_scopes | array<string> | Yes | |
memberships[].mfa_required | boolean | Yes | |
admin_mfa_required | boolean | Yes | |
mock_providers_available | boolean | Yes |
Member
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
account_id | string | Yes | |
email | string | Yes | |
name | string | Yes | |
role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
app_scopes | array<string> | Yes | |
app_roles | array<object> | Yes | |
app_roles[].app_id | string | Yes | |
app_roles[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
accepted_at | string | null | Yes | |
created_at | string | Yes | |
last_login_at | string | null | Yes |
MemberList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].account_id | string | Yes | |
data[].email | string | Yes | |
data[].name | string | Yes | |
data[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
data[].app_scopes | array<string> | Yes | |
data[].app_roles | array<object> | Yes | |
data[].app_roles[].app_id | string | Yes | |
data[].app_roles[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
data[].accepted_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].last_login_at | string | null | Yes |
Used by: GET /v1/organization/members
Message
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
source | enum | Yes | Values: "campaign", "api", "journey", "test" |
status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
idempotency_key | string | null | Yes | |
name | string | null | Yes | |
content | map<string, any> | Yes | |
target | map<string, any> | Yes | |
options | map<string, any> | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
template_id | string | null | Yes | |
campaign_id | string | null | Yes | |
variants | array<object> | null | Yes | |
counts | object | Yes | |
counts.targeted | integer | No | |
counts.suppressed | integer | No | |
counts.sent | integer | No | |
counts.delivered | integer | No | |
counts.failed | integer | No | |
counts.errored | integer | No | |
counts.expired | integer | No | |
counts.opened | integer | No | |
counts.clicked | integer | No | |
counts.converted | integer | No | |
counts.bounced | integer | No | |
counts.complained | integer | No | |
counts.unsubscribed | integer | No | |
counts.sms_segments | integer | No | |
requested_by | object | Yes | |
requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
requested_by.id | string | No | |
error | string | null | Yes | |
scheduled_for | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/notifications/{messageId}, DELETE /v1/notifications/{messageId}
MessageCategory
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
key | string | Yes | |
name | map<string, string> | Yes | |
description | map<string, string> | Yes | |
channels | array<string> | null | Yes | |
default_opted_in | boolean | Yes | |
position | integer | Yes | |
opted_out_users | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}
MessageCategoryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].key | string | Yes | |
data[].name | map<string, string> | Yes | |
data[].description | map<string, string> | Yes | |
data[].channels | array<string> | null | Yes | |
data[].default_opted_in | boolean | Yes | |
data[].position | integer | Yes | |
data[].opted_out_users | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/categories
MessageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
data[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
data[].idempotency_key | string | null | Yes | |
data[].name | string | null | Yes | |
data[].content | map<string, any> | Yes | |
data[].target | map<string, any> | Yes | |
data[].options | map<string, any> | Yes | |
data[].labels | array<string> | Yes | |
data[].category | string | null | Yes | |
data[].template_id | string | null | Yes | |
data[].campaign_id | string | null | Yes | |
data[].variants | array<object> | null | Yes | |
data[].counts | object | Yes | |
data[].counts.targeted | integer | No | |
data[].counts.suppressed | integer | No | |
data[].counts.sent | integer | No | |
data[].counts.delivered | integer | No | |
data[].counts.failed | integer | No | |
data[].counts.errored | integer | No | |
data[].counts.expired | integer | No | |
data[].counts.opened | integer | No | |
data[].counts.clicked | integer | No | |
data[].counts.converted | integer | No | |
data[].counts.bounced | integer | No | |
data[].counts.complained | integer | No | |
data[].counts.unsubscribed | integer | No | |
data[].counts.sms_segments | integer | No | |
data[].requested_by | object | Yes | |
data[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
data[].requested_by.id | string | No | |
data[].error | string | null | Yes | |
data[].scheduled_for | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].completed_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/notifications, GET /v1/apps/{appId}/campaigns/{campaignId}/messages
MessagesReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
group_by | enum | Yes | Values: "day", "channel", "campaign" |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.delivered | integer | Yes | |
totals.failed | integer | Yes | |
totals.opened | integer | Yes | |
totals.clicked | integer | Yes | |
totals.converted | integer | Yes | |
totals.delivery_rate | number | null | Yes | |
totals.open_rate | number | null | Yes | |
totals.click_rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].label | string | Yes | |
rows[].sent | integer | Yes | |
rows[].delivered | integer | Yes | |
rows[].failed | integer | Yes | |
rows[].opened | integer | Yes | |
rows[].clicked | integer | Yes | |
rows[].converted | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/messages
MessengerLink
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "telegram", "viber" |
user_id | string | Yes | |
url | string | Yes | |
token | string | Yes | |
expires_at | string | Yes |
Used by: POST /v1/apps/{appId}/messenger-links
MfaSetup
| Field | Type | Required | Description |
|---|---|---|---|
secret | string | Yes | |
otpauth_uri | string | Yes |
OAuthApproveResult
| Field | Type | Required | Description |
|---|---|---|---|
redirect_to | string | Yes |
OAuthConsentContext
| Field | Type | Required | Description |
|---|---|---|---|
client | object | Yes | |
client.client_id | string | Yes | |
client.client_name | string | Yes | |
client.client_uri | string | null | Yes | |
client.redirect_host | string | Yes | |
requested_scopes | array<string> | Yes | |
available_scopes | array<string> | Yes | |
deny_url | string | Yes | |
organizations | array<object> | Yes | |
organizations[].id | string | Yes | |
organizations[].name | string | Yes | |
organizations[].slug | string | Yes | |
organizations[].role | string | Yes | |
organizations[].org_wide_allowed | boolean | Yes | |
organizations[].grantable_scopes | array<string> | Yes | |
organizations[].apps | array<object> | Yes | |
organizations[].apps[].id | string | Yes | |
organizations[].apps[].name | string | Yes |
Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Used by: DELETE /v1/apps/{appId}/api-keys/{keyId}, DELETE /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, POST /sdk/v1/apps/{appId}/sessions, POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/received, POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/dismissed, POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened, DELETE /v1/apps/{appId}/data-feeds/{feedId}, DELETE /v1/apps/{appId}/content-tables/{tableId}, DELETE /v1/apps/{appId}/promo-code-lists/{listId}, DELETE /v1/apps/{appId}/catalogs/{catalogId}, DELETE /v1/apps/{appId}/catalogs/{catalogId}/items/{itemId}, DELETE /v1/apps/{appId}/feature-flags/{flagId}, …
OpenedDto
| Field | Type | Required | Description |
|---|---|---|---|
button_id | string | No | Length: 0–64 |
Used by: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened
Org
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
plan_code | string | Yes | |
status | enum | Yes | Values: "active", "suspended", "deleted" |
settings | object | Yes | |
settings.mfaRequired | boolean | No | |
settings.ipAllowlist | array<string> | No | Items: 0–50 |
settings.retentionDays | integer | No | Range: 7–3650 |
settings.sessionMaxHours | integer | No | Range: 1–2160 |
settings.auditStream | object | No | |
settings.auditStream.s3 | boolean | No | |
settings.auditStream.webhookAppId | string | null | No | |
created_at | string | Yes | |
region | string | null | Yes | |
managed_by_reseller | boolean | Yes |
Used by: GET /v1/organization
OrgDataExport
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].app_id | string | Yes | |
data[].app_name | string | Yes | |
data[].export_ids | array<string> | Yes |
OrgList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].slug | string | Yes | |
data[].plan_code | string | Yes | |
data[].status | enum | Yes | Values: "active", "suspended", "deleted" |
data[].settings | object | Yes | |
data[].settings.mfaRequired | boolean | No | |
data[].settings.ipAllowlist | array<string> | No | Items: 0–50 |
data[].settings.retentionDays | integer | No | Range: 7–3650 |
data[].settings.sessionMaxHours | integer | No | Range: 1–2160 |
data[].settings.auditStream | object | No | |
data[].created_at | string | Yes | |
data[].region | string | null | Yes | |
data[].managed_by_reseller | boolean | Yes | |
data[].role | enum | Yes | Values: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent" |
data[].app_scopes | array<string> | Yes |
OrgNotificationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kind | enum | Yes | Values: "channel_invalid", "channel_expiring", "campaign_approval", "message_failed", "export_ready", "import_finished", "webhook_unhealthy" |
data[].severity | enum | Yes | Values: "error", "warning", "info", "success" |
data[].app_id | string | Yes | |
data[].app_name | string | Yes | |
data[].title | string | Yes | |
data[].detail | string | null | Yes | |
data[].target_id | string | null | Yes | |
data[].at | string | Yes |
OverageChargeList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].period_start | string | Yes | |
data[].period_end | string | Yes | |
data[].provider | string | Yes | |
data[].plan_code | string | Yes | |
data[].currency | string | Yes | |
data[].amount | integer | Yes | |
data[].status | enum | Yes | Values: "pending", "invoiced", "awaiting_payment", "paid", "failed", "waived" |
data[].lines | array<object> | Yes | |
data[].lines[].metric | string | Yes | |
data[].lines[].included | number | Yes | |
data[].lines[].used | number | Yes | |
data[].lines[].billable | number | Yes | |
data[].lines[].amount | integer | Yes | |
data[].lines[].description | string | Yes | |
data[].charged_at | string | null | Yes | |
data[].paid_at | string | null | Yes | |
data[].created_at | string | Yes |
OverviewStats
| Field | Type | Required | Description |
|---|---|---|---|
range | enum | Yes | Values: "7d", "30d", "custom" |
from | string | Yes | |
to | string | Yes | |
kpis | object | Yes | |
kpis.sent | integer | Yes | |
kpis.delivered | integer | Yes | |
kpis.failed | integer | Yes | |
kpis.opened | integer | Yes | |
kpis.clicked | integer | Yes | |
kpis.delivery_rate | number | null | Yes | |
kpis.open_rate | number | null | Yes | |
kpis.click_rate | number | null | Yes | |
kpis.active_subscriptions | integer | Yes | |
kpis.new_subscriptions | integer | Yes | |
kpis.opt_outs | integer | Yes | |
series | array<object> | Yes | |
series[].date | string | Yes | |
series[].sent | integer | Yes | |
series[].delivered | integer | Yes | |
series[].failed | integer | Yes | |
series[].opened | integer | Yes | |
recent_messages | array<object> | Yes | |
recent_messages[].id | string | Yes | |
recent_messages[].app_id | string | Yes | |
recent_messages[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
recent_messages[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
recent_messages[].idempotency_key | string | null | Yes | |
recent_messages[].name | string | null | Yes | |
recent_messages[].content | map<string, any> | Yes | |
recent_messages[].target | map<string, any> | Yes | |
recent_messages[].options | map<string, any> | Yes | |
recent_messages[].labels | array<string> | Yes | |
recent_messages[].category | string | null | Yes | |
recent_messages[].template_id | string | null | Yes | |
recent_messages[].campaign_id | string | null | Yes | |
recent_messages[].variants | array<object> | null | Yes | |
recent_messages[].counts | object | Yes | |
recent_messages[].counts.targeted | integer | No | |
recent_messages[].counts.suppressed | integer | No | |
recent_messages[].counts.sent | integer | No | |
recent_messages[].counts.delivered | integer | No | |
recent_messages[].counts.failed | integer | No | |
recent_messages[].counts.errored | integer | No | |
recent_messages[].counts.expired | integer | No | |
recent_messages[].counts.opened | integer | No | |
recent_messages[].counts.clicked | integer | No | |
recent_messages[].counts.converted | integer | No | |
recent_messages[].counts.bounced | integer | No | |
recent_messages[].counts.complained | integer | No | |
recent_messages[].counts.unsubscribed | integer | No | |
recent_messages[].counts.sms_segments | integer | No | |
recent_messages[].requested_by | object | Yes | |
recent_messages[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
recent_messages[].requested_by.id | string | No | |
recent_messages[].error | string | null | Yes | |
recent_messages[].scheduled_for | string | null | Yes | |
recent_messages[].started_at | string | null | Yes | |
recent_messages[].completed_at | string | null | Yes | |
recent_messages[].created_at | string | Yes | |
recent_messages[].updated_at | string | Yes | |
recent_campaigns | array<object> | Yes | |
recent_campaigns[].id | string | Yes | |
recent_campaigns[].name | string | Yes | |
recent_campaigns[].type | string | Yes | |
recent_campaigns[].status | string | Yes | |
recent_campaigns[].sent | integer | Yes | |
recent_campaigns[].opened | integer | Yes | |
recent_campaigns[].clicked | integer | Yes | |
recent_campaigns[].updated_at | string | Yes | |
top_errors | array<object> | Yes | |
top_errors[].code | string | Yes | |
top_errors[].count | integer | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channels[].provider | enum | null | Yes | |
channels[].status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
channels[].last_error | string | null | Yes | |
channels[].active_subscriptions | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/overview
PatchEventDefinitionDto
| Field | Type | Required | Description |
|---|---|---|---|
display_name | string | null | No | |
is_conversion | boolean | No | |
outcome_unique | boolean | No | |
outcome_unattributed | boolean | No | |
retention_days | integer | null | No |
Used by: PATCH /v1/apps/{appId}/events/definitions/{name}
PatchSubscriptionDto
| Field | Type | Required | Description |
|---|---|---|---|
token | string | No | Length: 1–4096 |
device | object | No | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
status | enum | No | Values: "subscribed", "unsubscribed" |
test_device | boolean | No | |
test_device_name | string | No | Length: 0–100 |
Used by: PATCH /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}
PatchUserDto
| Field | Type | Required | Description |
|---|---|---|---|
properties | map<string, any> | No | |
tags | map<string, string | null> | No | |
deltas | object | No | |
deltas.session_count | integer | No | Range: -1000000–1000000 |
deltas.session_time | integer | No | Range: 0–31536000 |
deltas.purchases | array<object> | No | Items: 0–100 |
deltas.purchases[].sku | string | Yes | Length: 1–100 |
deltas.purchases[].amount | number | Yes | Range: 0–∞ |
deltas.purchases[].iso | string | No | Length: 3–3 |
deltas.purchases[].count | integer | No | Default: 1; Range: 1–1000 |
Used by: PATCH /v1/apps/{appId}/users/by/{label}/{value}
PathBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
event | string | Yes | Length: 1–100 |
direction | enum | No | Values: "after", "before"; Default: "after" |
depth | integer | No | Default: 3; Range: 1–5 |
top | integer | No | Default: 5; Range: 2–10 |
window_hours | integer | No | Default: 24; Range: 1–720 |
exclude | array<string> | No | Default: []; Items: 0–20 |
from | string (date-time) | No | |
to | string (date-time) | No | |
format | enum | No | Values: "json", "csv"; Default: "json" |
Used by: POST /v1/apps/{appId}/analytics/paths
PathReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
event | string | Yes | |
direction | enum | Yes | Values: "after", "before" |
window_hours | integer | Yes | |
total_users | integer | Yes | |
truncated | boolean | Yes | |
levels | array<object> | Yes | |
levels[].step | integer | Yes | |
levels[].nodes | array<object> | Yes | |
levels[].nodes[].id | string | Yes | |
levels[].nodes[].name | string | null | Yes | |
levels[].nodes[].kind | enum | Yes | Values: "event", "other", "end" |
levels[].nodes[].users | integer | Yes | |
levels[].nodes[].share | number | Yes | |
links | array<object> | Yes | |
links[].source | string | Yes | |
links[].target | string | Yes | |
links[].users | integer | Yes | |
top_paths | array<object> | Yes | |
top_paths[].path | array<string> | Yes | |
top_paths[].users | integer | Yes | |
top_paths[].share | number | Yes |
Used by: POST /v1/apps/{appId}/analytics/paths
PlanList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].code | string | Yes | |
data[].name | string | Yes | |
data[].monthly_price | integer | Yes | |
data[].currency | string | Yes | |
data[].prices | object | No | |
data[].prices.USD | integer | Yes | |
data[].prices.TRY | integer | Yes | |
data[].position | integer | Yes | |
data[].is_public | boolean | Yes | |
data[].limits | object | Yes | |
data[].limits.subscriptions | integer | null | Yes | |
data[].limits.messages_per_month | integer | null | Yes | |
data[].limits.api_rps | integer | null | Yes | |
data[].limits.members | integer | null | Yes | |
data[].limits.apps | integer | null | Yes | |
data[].limits.retention_days | integer | null | Yes | |
data[].limits.journeys | integer | null | Yes | |
data[].limits.segments | integer | null | Yes | |
data[].limits.ab_variants | integer | null | Yes | |
data[].limits.tags_per_user | integer | null | Yes | |
data[].limits.aliases_per_user | integer | null | Yes | |
data[].limits.subscriptions_per_user | integer | null | Yes | |
data[].limits.report_history_days | integer | null | Yes | |
data[].limits.webhooks | integer | null | Yes | |
data[].limits.api_keys | integer | null | Yes | |
data[].limits.mau | integer | null | No | |
data[].limits.emails_per_month | integer | null | No | |
data[].limits.sms_per_month | integer | null | No | |
data[].limits.whatsapp_conversations_per_month | integer | null | No | |
data[].limits.rcs_messages_per_month | integer | null | No | |
data[].limits.ai_credits_per_month | integer | null | No | |
data[].limits.data_feeds | integer | null | No | |
data[].limits.content_tables | integer | null | No | |
data[].limits.event_streams | integer | null | No | |
data[].limits.warehouse_destinations | integer | null | No | |
data[].limits.custom_domains | integer | null | No | |
data[].features | object | Yes | |
data[].features.journeys | boolean | Yes | |
data[].features.ab_testing | boolean | Yes | |
data[].features.email | boolean | Yes | |
data[].features.sms | boolean | Yes | |
data[].features.in_app | boolean | Yes | |
data[].features.approval_flow | boolean | Yes | |
data[].features.sso | boolean | Yes | |
data[].features.scim | boolean | No | |
data[].features.audit_export | boolean | Yes | |
data[].features.white_label | boolean | No | |
data[].features.hide_powered_by | boolean | No | |
data[].features.reseller | boolean | No | |
data[].features.whatsapp | boolean | No | |
data[].features.rcs | boolean | No | |
data[].features.live_activities | boolean | No | |
data[].features.inbox | boolean | No | |
data[].features.ai_assistant | boolean | No | |
data[].features.dynamic_content | boolean | No | |
data[].features.event_streams | boolean | No | |
data[].features.warehouse_export | boolean | No | |
data[].features.custom_domain | boolean | No | |
data[].features.data_residency | boolean | No | |
data[].features.priority_support | boolean | No | |
data[].features.mcp_server | boolean | No | |
data[].features.overage | boolean | No | |
data[].features.roles | array<string> | Yes | |
data[].purchasable | boolean | Yes |
PortalResult
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes |
PostmasterStats
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | null | Yes | |
data | array<object> | Yes | |
data[].day | string | Yes | |
data[].domain_reputation | string | null | Yes | |
data[].spam_rate | string | null | Yes |
Used by: GET /v1/apps/{appId}/email-deliverability/postmaster, POST /v1/apps/{appId}/email-deliverability/postmaster/sync
PredictionModel
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | Yes | |
horizon_days | integer | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
outcome | enum | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
metrics | object | null | Yes | |
distribution | array<object> | Yes | |
distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
distribution[].users | integer | Yes |
Used by: POST /v1/apps/{appId}/predictions, GET /v1/apps/{appId}/predictions/{id}, PATCH /v1/apps/{appId}/predictions/{id}, POST /v1/apps/{appId}/predictions/{id}/compute
PredictionModelList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "churn", "event" |
data[].event_names | array<string> | Yes | |
data[].horizon_days | integer | Yes | |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "idle", "queued", "running", "failed" |
data[].outcome | enum | null | Yes | |
data[].last_computed_at | string | null | Yes | |
data[].scored_users | integer | Yes | |
data[].metrics | object | null | Yes | |
data[].distribution | array<object> | Yes | |
data[].distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
data[].distribution[].users | integer | Yes |
Used by: GET /v1/apps/{appId}/predictions
PredictionUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].score | integer | Yes | |
data[].bucket | enum | Yes | Values: "low", "medium", "high" |
next_cursor | string | null | Yes |
Used by: GET /v1/apps/{appId}/predictions/{id}/users
PreviewDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
target | enum | Yes | Values: "event", "person" |
source | enum | No | Values: "sdk", "api", "import", "system", "webhook_source", "pull_source" |
records | array<map<string, any>> | Yes | Items: 1–20 |
transform | object | No | |
transform.kind | enum | Yes | Values: "rules", "javascript" |
transform.rules | array<object> | No | Items: 0–50 |
transform.code | string | No | Length: 0–20000 |
transform.sources | array<enum> | No | Items: 0–6 |
transform.event_names | array<string> | No | Items: 0–50 |
transform_id | string | No |
Used by: POST /v1/apps/{appId}/data-pipelines/transforms/preview
PreviewWarehouseQueryDto
| Field | Type | Required | Description |
|---|---|---|---|
connection_id | string | Yes | Length: 1–∞ |
query | string | Yes | Length: 1–20000 |
id_column | string | Yes | |
id_type | enum | No | Values: "external_id", "user_id" |
limits | object | No | |
limits.timeout_seconds | integer | No | Range: 10–600 |
limits.max_rows | integer | No | Range: 1–1000000 |
limits.max_bytes_billed | integer | No | Range: 10485760–10995116277760 |
limits.max_warehouse_size | enum | null | No | |
mode | enum | No | Values: "dry_run", "sample" |
Used by: POST /v1/apps/{appId}/warehouse-segments/preview
PromoCodeList
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
expires_at | string | null | Yes | |
total_count | integer | Yes | |
assigned_count | integer | Yes | |
available_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/promo-code-lists, GET /v1/apps/{appId}/promo-code-lists/{listId}, PATCH /v1/apps/{appId}/promo-code-lists/{listId}
PromoCodeListList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].total_count | integer | Yes | |
data[].assigned_count | integer | Yes | |
data[].available_count | integer | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/promo-code-lists
PromoCodesPage
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
data | array<object> | Yes | |
data[].code | string | Yes | |
data[].delivery_id | string | null | Yes | |
data[].message_id | string | null | Yes | |
data[].assigned_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/promo-code-lists/{listId}/codes
PromoCodeUploadResult
| Field | Type | Required | Description |
|---|---|---|---|
list | object | Yes | |
list.id | string | Yes | |
list.app_id | string | Yes | |
list.name | string | Yes | |
list.description | string | null | Yes | |
list.expires_at | string | null | Yes | |
list.total_count | integer | Yes | |
list.assigned_count | integer | Yes | |
list.available_count | integer | Yes | |
list.liquid | string | Yes | |
list.created_at | string | Yes | |
list.updated_at | string | Yes | |
added | integer | Yes | |
skipped | integer | Yes |
Used by: POST /v1/apps/{appId}/promo-code-lists/{listId}/codes
ProvidersReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.failed | integer | Yes | |
totals.failure_rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].channel | string | Yes | |
rows[].provider | string | null | Yes | |
rows[].sent | integer | Yes | |
rows[].failed | integer | Yes | |
rows[].failure_rate | number | null | Yes | |
rows[].latency_p50_ms | number | null | Yes | |
rows[].latency_p95_ms | number | null | Yes | |
rows[].errors | array<object> | Yes | |
rows[].errors[].code | string | Yes | |
rows[].errors[].count | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/providers
PublicCleanupSubscriptionsDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "invalid", "unsubscribed" |
Used by: POST /v1/apps/{appId}/subscriptions/cleanup
PublicFormSubmitDto
| Field | Type | Required | Description |
|---|---|---|---|
values | map<string, string | boolean | number | array<string>> | Yes | |
external_id | string | No | Length: 1–128 |
page_url | string | No | Length: 0–2000 |
language | string | No | Length: 2–10 |
Used by: POST /v1/apps/{appId}/forms/{formId}/submissions
PublicSurveyResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
answers | map<string, string | boolean | number | array<string>> | Yes | |
external_id | string | No | Length: 1–128 |
Used by: POST /v1/apps/{appId}/surveys/{surveyId}/responses
PutSiteSearchDocumentDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Length: 0–2000 |
title | string | No | Length: 0–300 |
content | string | No | Length: 0–300000 |
html | string | No | Length: 0–900000 |
language | string | No |
Used by: PUT /v1/apps/{appId}/site-search/documents/{documentKey}
ReceivedDto
| Field | Type | Required | Description |
|---|---|---|---|
received_at | string (date-time) | No | |
deprioritized | boolean | No |
Used by: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/received
RecentEvents
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_id | string | null | Yes | |
data[].name | string | Yes | |
data[].properties | map<string, any> | Yes | |
data[].value | number | null | Yes | |
data[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
data[].occurred_at | string | Yes |
Used by: GET /v1/apps/{appId}/events/recent
RecommendationConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
view_events | array<string> | Yes | |
purchase_events | array<string> | Yes | |
item_property | string | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_items | integer | Yes | |
scored_users | integer | Yes |
Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config, PUT /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config, POST /v1/apps/{appId}/catalogs/{catalogId}/recommendations/compute
Recommendations
| Field | Type | Required | Description |
|---|---|---|---|
strategy | enum | Yes | Values: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals" |
source | enum | null | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].title | string | Yes | |
data[].description | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].url | string | null | Yes | |
data[].price | number | null | Yes | |
data[].sale_price | number | null | Yes | |
data[].currency | string | Yes | |
data[].category | string | null | Yes | |
data[].brand | string | null | Yes | |
data[].in_stock | boolean | Yes | |
data[].attributes | map<string, string> | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/recommendations
RecoveryCodes
| Field | Type | Required | Description |
|---|---|---|---|
recovery_codes | array<string> | Yes |
RenderPreview
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
language | string | Yes | |
title | string | null | Yes | |
subtitle | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
icon_url | string | null | Yes | |
buttons | array<object> | Yes | |
buttons[].id | string | Yes | |
buttons[].text | string | Yes | |
buttons[].url | string | null | Yes | |
data | map<string, string> | Yes | |
warnings | array<string> | Yes | |
email | object | null | No | |
sms | object | null | No |
Used by: POST /v1/apps/{appId}/templates/{templateId}/render
RenderTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"; Default: "ios_push" |
language | string | No | Length: 2–10 |
user | object | No | |
user.external_id | string | No | Length: 0–255 |
user.tags | map<string, string> | No | |
user.properties | map<string, any> | No | |
custom_data | map<string, any> | No | |
content | object | No | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.list | object | No | |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No | |
version | integer | No | Range: 1–∞ |
Used by: POST /v1/apps/{appId}/templates/{templateId}/render
ReportResult
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
columns | array<object> | Yes | |
columns[].key | string | Yes | |
columns[].kind | enum | Yes | Values: "dimension", "metric" |
columns[].format | enum | Yes | Values: "text", "date", "number", "percent" |
rows | array<map<string, string | number | null>> | Yes | |
totals | map<string, number | null> | null | Yes | |
truncated | boolean | Yes |
Used by: POST /v1/apps/{appId}/analytics/reports/run
ReportRunBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
source | enum | Yes | Values: "deliveries", "events", "conversions" |
metrics | array<enum> | Yes | Items: 1–8 |
dimensions | array<enum> | No | Default: []; Items: 0–2 |
filters | map<string, array<string>> | No | Default: {} |
sort | object | No | |
sort.by | string | Yes | Length: 0–64 |
sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
limit | integer | No | Default: 100; Range: 1–1000 |
days | integer | No | Range: 1–730 |
from | string (date-time) | No | |
to | string (date-time) | No | |
format | enum | No | Values: "json", "csv"; Default: "json" |
Used by: POST /v1/apps/{appId}/analytics/reports/run
ReprocessQuarantineDto
| Field | Type | Required | Description |
|---|---|---|---|
ids | array<string> | No | Items: 1–500 |
Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/reprocess
RequestLog
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
api_key_id | string | null | Yes | |
method | string | Yes | |
path | string | Yes | |
route | string | null | Yes | |
status | integer | Yes | |
duration_ms | integer | Yes | |
request_id | string | null | Yes | |
ip | string | null | Yes | |
error_code | string | null | Yes | |
created_at | string | Yes |
RequestLogPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].org_id | string | Yes | |
data[].app_id | string | null | Yes | |
data[].api_key_id | string | null | Yes | |
data[].method | string | Yes | |
data[].path | string | Yes | |
data[].route | string | null | Yes | |
data[].status | integer | Yes | |
data[].duration_ms | integer | Yes | |
data[].request_id | string | null | Yes | |
data[].ip | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/organization/logs
ResellerChildOrg
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
plan_code | string | Yes | |
status | enum | Yes | Values: "active", "suspended", "deleted" |
suspended_reason | string | null | Yes | |
members | number | Yes | |
access | enum | Yes | Values: "owner", "member", "support", "none" |
region | string | null | Yes | |
created_at | string | Yes |
ResellerChildOrgList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].slug | string | Yes | |
data[].plan_code | string | Yes | |
data[].status | enum | Yes | Values: "active", "suspended", "deleted" |
data[].suspended_reason | string | null | Yes | |
data[].members | number | Yes | |
data[].access | enum | Yes | Values: "owner", "member", "support", "none" |
data[].region | string | null | Yes | |
data[].created_at | string | Yes |
ResellerStatement
| Field | Type | Required | Description |
|---|---|---|---|
month | string | Yes | |
currency | string | Yes | |
items | array<object> | Yes | |
items[].org_id | string | Yes | |
items[].name | string | Yes | |
items[].slug | string | Yes | |
items[].plan_code | string | Yes | |
items[].status | string | Yes | |
items[].amount | number | Yes | |
items[].messages_sent | number | Yes | |
items[].events_ingested | number | Yes | |
items[].api_requests | number | Yes | |
items[].active_subscriptions | number | Yes | |
items[].mau | number | Yes | |
totals | object | Yes | |
totals.amount | number | Yes | |
totals.messages_sent | number | Yes | |
totals.events_ingested | number | Yes | |
totals.child_orgs | number | Yes |
RetentionReport
| Field | Type | Required | Description |
|---|---|---|---|
weeks | integer | Yes | |
cohorts | array<object> | Yes | |
cohorts[].week | string | Yes | |
cohorts[].users | integer | Yes | |
cohorts[].retention | array<number | null> | Yes | |
average | array<number | null> | Yes |
Used by: GET /v1/apps/{appId}/analytics/retention
ReverseEtlConnectionTest
Type: object
Used by: POST /v1/apps/{appId}/reverse-etl/test-connection
ReverseEtlCreate
Type: object
Used by: POST /v1/apps/{appId}/reverse-etl
ReverseEtlRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
sync_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
row_count | integer | Yes | |
attempt | integer | Yes | |
error | string | null | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes | |
duration_ms | integer | null | Yes | |
created_at | string | Yes |
Used by: POST /v1/apps/{appId}/reverse-etl/{syncId}/run
ReverseEtlRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].sync_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
data[].row_count | integer | Yes | |
data[].attempt | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/reverse-etl/{syncId}/runs
ReverseEtlSync
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
target | enum | Yes | Values: "event", "user" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
cursor | string | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/reverse-etl, GET /v1/apps/{appId}/reverse-etl/{syncId}, PATCH /v1/apps/{appId}/reverse-etl/{syncId}
ReverseEtlSyncList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
data[].target | enum | Yes | Values: "event", "user" |
data[].config | map<string, any> | Yes | |
data[].credentials_hint | string | Yes | |
data[].schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "failing" |
data[].cursor | string | null | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/reverse-etl
RfmConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
event_names | array<string> | Yes | |
value_property | string | null | Yes | |
use_monetary | boolean | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
first_computed_at | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Used by: GET /v1/apps/{appId}/rfm/config, PUT /v1/apps/{appId}/rfm/config, POST /v1/apps/{appId}/rfm/compute
RfmOverview
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
low_population | boolean | Yes | |
last_computed_at | string | null | Yes | |
segments | array<object> | Yes | |
segments[].segment | enum | Yes | Values: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost" |
segments[].users | integer | Yes | |
segments[].share | number | Yes | |
segments[].avg_recency_days | number | null | Yes | |
segments[].avg_frequency | number | null | Yes | |
segments[].avg_monetary | number | null | Yes |
Used by: GET /v1/apps/{appId}/rfm/overview
RfmTransitions
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
first_computed_at | string | null | Yes | |
transitions | array<object> | Yes | |
transitions[].from | enum | null | Yes | |
transitions[].to | enum | null | Yes | |
transitions[].users | integer | Yes |
Used by: GET /v1/apps/{appId}/rfm/transitions
RfmUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].segment | enum | Yes | Values: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost" |
data[].r | integer | Yes | |
data[].f | integer | Yes | |
data[].m | integer | null | Yes | |
data[].recency_days | integer | Yes | |
data[].frequency | integer | Yes | |
data[].monetary | number | Yes | |
data[].last_event_at | string | Yes | |
data[].segment_since | string | Yes | |
next_cursor | string | null | Yes |
Used by: GET /v1/apps/{appId}/rfm/users
RunSqlQueryDto
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Length: 1–20000 |
row_limit | integer | No | Range: 1–5000 |
timeout_ms | integer | No | Range: 1000–30000 |
Used by: POST /v1/apps/{appId}/sql/query
SavedReport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | Yes | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | Yes | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/analytics/reports, GET /v1/apps/{appId}/analytics/reports/{id}, PATCH /v1/apps/{appId}/analytics/reports/{id}
SavedReportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].definition | object | Yes | |
data[].definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
data[].definition.metrics | array<enum> | Yes | Items: 1–8 |
data[].definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
data[].definition.filters | map<string, array<string>> | Yes | Default: {} |
data[].definition.sort | object | No | |
data[].definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
data[].definition.days | integer | No | Range: 1–730 |
data[].definition.from | string (date-time) | No | |
data[].definition.to | string (date-time) | No | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/analytics/reports
ScheduleCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
send_at | string (date-time) | No | |
recurrence | object | No | |
recurrence.cron | string | Yes | Length: 9–100 |
recurrence.until | string (date-time) | null | No | |
recurrence.timezone | string | No | Length: 1–64 |
Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/schedule
ScimTokenCreated
| Field | Type | Required | Description |
|---|---|---|---|
token | string | Yes | |
scim_base_url | string | Yes | |
data | object | Yes | |
data.id | string | Yes | |
data.name | string | Yes | |
data.prefix | string | Yes | |
data.last_used_at | string | null | Yes | |
data.revoked_at | string | null | Yes | |
data.created_at | string | Yes |
ScimTokenList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].prefix | string | Yes | |
data[].last_used_at | string | null | Yes | |
data[].revoked_at | string | null | Yes | |
data[].created_at | string | Yes |
SdkAttributionAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Used by: POST /sdk/v1/apps/{appId}/attribution
SdkAttributionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
external_id | string | No | Length: 1–128 |
touches | array<object> | Yes | Items: 1–10 |
touches[].touch_id | string | Yes | Length: 8–64 |
touches[].occurred_at | string (date-time) | Yes | |
touches[].utm_source | string | No | Length: 1–200 |
touches[].utm_medium | string | No | Length: 1–200 |
touches[].utm_campaign | string | No | Length: 1–200 |
touches[].utm_term | string | No | Length: 1–200 |
touches[].utm_content | string | No | Length: 1–200 |
touches[].utm_id | string | No | Length: 1–200 |
touches[].click_id_type | enum | No | Values: "fbclid", "gclid", "gbraid", "wbraid", "ttclid", "li_fat_id", "msclkid" |
touches[].click_id | string | No | Length: 1–500 |
touches[].landing_url | string | No | Length: 0–2000 |
touches[].referrer | string | No | Length: 0–255 |
Used by: POST /sdk/v1/apps/{appId}/attribution
SdkChatAckDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
read_seq | integer | No | Range: 0–∞ |
delivered_seq | integer | No | Range: 0–∞ |
Used by: POST /sdk/v1/apps/{appId}/chat/ack
SdkChatConfig
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
online | boolean | Yes | |
within_business_hours | boolean | Yes | |
color | string | null | Yes | |
text_color | string | null | Yes | |
position | enum | Yes | Values: "right", "left" |
theme | enum | Yes | Values: "light", "dark", "auto" |
title | string | null | Yes | |
greeting | string | null | Yes | |
offline_message | string | null | Yes | |
collect_email_offline | boolean | Yes | |
require_email | boolean | Yes | |
attachments | object | Yes | |
attachments.enabled | boolean | Yes | |
attachments.max_bytes | integer | Yes | |
attachments.types | array<string> | Yes | |
language | string | Yes |
Used by: GET /sdk/v1/apps/{appId}/chat/config
SdkChatConversation
| Field | Type | Required | Description |
|---|---|---|---|
conversation | object | null | Yes | |
unread_count | integer | Yes |
Used by: GET /sdk/v1/apps/{appId}/chat/conversation, POST /sdk/v1/apps/{appId}/chat/ack
SdkChatIdentifyDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
external_id | string | No | Length: 1–255 |
identity_hash | string | No | Length: 16–128 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
name | string | No | Length: 1–120 |
email | string (email) | No | Length: 0–320 |
language | string | No |
Used by: POST /sdk/v1/apps/{appId}/chat/identify
SdkChatIdentifyResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | null | Yes | |
conversation | object | null | Yes |
Used by: POST /sdk/v1/apps/{appId}/chat/identify
SdkChatMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].seq | integer | Yes | |
data[].client_message_id | string | null | Yes | |
data[].sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
data[].author_name | string | null | Yes | |
data[].text | string | null | Yes | |
data[].attachments | array<object> | Yes | |
data[].attachments[].id | string | Yes | |
data[].attachments[].name | string | Yes | |
data[].attachments[].type | string | Yes | |
data[].attachments[].size | integer | Yes | |
data[].quick_replies | array<object> | null | Yes | |
data[].status | enum | Yes | Values: "sent", "delivered", "read" |
data[].created_at | string | Yes | |
has_more | boolean | Yes |
Used by: GET /sdk/v1/apps/{appId}/chat/messages
SdkChatOfflineDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
client_message_id | string | Yes | |
email | string (email) | Yes | Length: 0–320 |
name | string | No | Length: 1–120 |
text | string | Yes | Length: 1–4000 |
language | string | No |
Used by: POST /sdk/v1/apps/{appId}/chat/offline
SdkChatSendDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
client_message_id | string | Yes | |
text | string | Yes | Length: 1–4000 |
option_id | string | No | Length: 1–64 |
name | string | No | Length: 1–120 |
email | string (email) | No | Length: 0–320 |
language | string | No | |
page_url | string | No | Length: 0–2000 |
Used by: POST /sdk/v1/apps/{appId}/chat/messages
SdkChatSendResult
| Field | Type | Required | Description |
|---|---|---|---|
message | object | Yes | |
message.id | string | Yes | |
message.seq | integer | Yes | |
message.client_message_id | string | null | Yes | |
message.sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
message.author_name | string | null | Yes | |
message.text | string | null | Yes | |
message.attachments | array<object> | Yes | |
message.attachments[].id | string | Yes | |
message.attachments[].name | string | Yes | |
message.attachments[].type | string | Yes | |
message.attachments[].size | integer | Yes | |
message.quick_replies | array<object> | null | Yes | |
message.status | enum | Yes | Values: "sent", "delivered", "read" |
message.created_at | string | Yes | |
conversation | object | Yes | |
conversation.id | string | Yes | |
conversation.status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
conversation.last_seq | integer | Yes | |
conversation.agent_last_read_seq | integer | Yes | |
conversation.visitor_last_read_seq | integer | Yes | |
conversation.unread_count | integer | Yes | |
conversation.bot_active | boolean | Yes | |
conversation.assignee_name | string | null | Yes | |
conversation.created_at | string | Yes | |
duplicate | boolean | Yes |
Used by: POST /sdk/v1/apps/{appId}/chat/messages, POST /sdk/v1/apps/{appId}/chat/attachments, POST /sdk/v1/apps/{appId}/chat/offline
SdkChatTypingDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
typing | boolean | Yes |
Used by: POST /sdk/v1/apps/{appId}/chat/typing
SdkConfig
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | |
name | string | Yes | |
api_url | string | Yes | |
cell_id | string | null | Yes | |
identity_verification_required | boolean | Yes | |
identity_verification_mode | enum | Yes | Values: "hmac", "jwt", "both" |
platforms | object | Yes | |
platforms.ios | boolean | Yes | |
platforms.android | boolean | Yes | |
platforms.web | boolean | Yes | |
platforms.email | boolean | Yes | |
platforms.sms | boolean | Yes | |
web | object | Yes | |
web.vapid_public_key | string | null | Yes | |
web.allowed_origins | array<string> | Yes | |
web.service_worker_path | string | null | Yes | |
web.service_worker_scope | string | null | Yes | |
web.prompt | object | null | Yes | |
web.welcome_notification | object | null | Yes | |
web.click_behavior | object | null | Yes | |
web.custom_link | object | null | Yes | |
web.prompt_backoff_days | array<integer> | null | Yes | |
session | object | Yes | |
session.timeout_seconds | integer | Yes | |
in_app | object | Yes | |
in_app.min_interval_seconds | integer | Yes | |
android_channels | array<object> | Yes | |
android_channels[].id | string | Yes | |
android_channels[].name | string | Yes | |
android_channels[].description | string | null | Yes | |
android_channels[].importance | enum | Yes | Values: "low", "default", "high", "urgent" |
android_channels[].sound | string | null | Yes | |
android_channels[].vibration | boolean | Yes | |
android_channels[].group | string | null | Yes | |
categories | array<object> | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes |
Used by: GET /sdk/v1/apps/{appId}/config
SdkErrorPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].subscription_id | string | null | Yes | |
data[].platform | string | Yes | |
data[].sdk_version | string | null | Yes | |
data[].level | string | Yes | |
data[].code | string | null | Yes | |
data[].message | string | Yes | |
data[].context | map<string, any> | Yes | |
data[].occurred_at | string | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/sdk-errors
SdkErrorsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Used by: POST /sdk/v1/apps/{appId}/errors
SdkErrorsDto
| Field | Type | Required | Description |
|---|---|---|---|
errors | array<object> | Yes | Items: 1–20 |
errors[].level | enum | No | Values: "error", "warning"; Default: "error" |
errors[].platform | enum | Yes | Values: "web", "android", "ios", "flutter", "react_native", "node" |
errors[].sdk_version | string | No | Length: 0–50 |
errors[].code | string | No | Length: 0–100 |
errors[].message | string | Yes | Length: 1–2000 |
errors[].subscription_id | string | No | Length: 0–64 |
errors[].context | map<string, any> | No | |
errors[].occurred_at | string (date-time) | No |
Used by: POST /sdk/v1/apps/{appId}/errors
SdkEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
events | array<object> | Yes | Items: 1–100 |
events[].name | string | Yes | Length: 1–100 |
events[].properties | map<string, any> | No | Default: {} |
events[].value | number | No | |
events[].occurred_at | string (date-time) | No | |
events[].event_id | string | No | Length: 8–64 |
events[].subscription_id | string | No | Length: 1–∞ |
events[].external_id | string | No | Length: 1–255 |
events[].token_hash | string | No | |
events[].identity_hash | string | No | Length: 64–64 |
Used by: POST /sdk/v1/apps/{appId}/events
SdkFeatureFlags
| Field | Type | Required | Description |
|---|---|---|---|
flags | map<string, object> | Yes |
Used by: POST /sdk/v1/apps/{appId}/feature-flags/evaluate
SdkFlagsEvaluateDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
subscription_id | string | No | Length: 1–64 |
subject | string | No | Length: 1–128 |
Used by: POST /sdk/v1/apps/{appId}/feature-flags/evaluate
SdkFormSubmitDto
| Field | Type | Required | Description |
|---|---|---|---|
values | map<string, string | boolean | number | array<string>> | Yes | |
visitor_id | string | No | |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
web_campaign_id | string | No | Length: 0–64 |
page_url | string | No | Length: 0–2000 |
language | string | No | Length: 2–10 |
website | string | No | Length: 0–500 |
elapsed_ms | integer | No | Range: 0–86400000 |
Used by: POST /sdk/v1/apps/{appId}/forms/{formId}/submissions
SdkGeofenceEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
events | array<object> | Yes | Items: 1–20 |
events[].geofence_id | string | Yes | Length: 1–64 |
events[].transition | enum | Yes | Values: "enter", "exit" |
events[].occurred_at | string (date-time) | No |
Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-events
SdkGeofenceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].lat | number | Yes | |
data[].lng | number | Yes | |
data[].radius_m | integer | Yes |
Used by: GET /sdk/v1/apps/{appId}/geofences
SdkIdentityDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes | |
identity_hash | string | No | Length: 64–64 |
Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity
SdkIdentityResult
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity, DELETE /sdk/v1/apps/{appId}/users/{userId}/identity/{label}
SdkInAppEventDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
token_hash | string | No | |
type | enum | Yes | Values: "impression", "click", "dismiss" |
button_id | string | No | Length: 0–64 |
variant_id | string | No | Length: 0–64 |
Used by: POST /sdk/v1/apps/{appId}/in-app/{messageId}/events
SdkInAppList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].triggers | array<object> | Yes | |
data[].trigger_groups | array<array<object>> | Yes | |
data[].variant_id | string | null | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | null | Yes | |
data[].display.text_color | string | null | Yes | |
data[].display.dismissible | boolean | Yes | |
data[].display.auto_dismiss_seconds | integer | null | Yes | |
data[].display.content_type | enum | Yes | Values: "blocks", "html" |
data[].display.html | string | null | Yes | |
data[].display.html_height | integer | null | Yes | |
data[].display.blocks | array<object> | Yes | |
data[].remaining_impressions | integer | Yes | |
data[].min_interval_seconds | integer | Yes | |
data[].stop_after_interaction | boolean | Yes | |
data[].last_impression_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
language | string | Yes |
Used by: GET /sdk/v1/apps/{appId}/in-app, GET /sdk/v1/apps/{appId}/placements/{key}
SdkInboxActionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
identity_hash | string | No | Length: 0–128 |
token_hash | string | No |
Used by: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all, POST /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read, POST /sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}
SdkLiveActivityTokenDeleteDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
activity_type | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "push_to_start", "update" |
activity_id | string | No | Length: 1–100 |
token_hash | string | No | Length: 64–64 |
identity_hash | string | No | Length: 64–64 |
Used by: POST /sdk/v1/apps/{appId}/live-activities/tokens/delete
SdkLiveActivityTokenDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
activity_type | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "push_to_start", "update" |
activity_id | string | No | Length: 1–100 |
token | string | Yes | |
token_hash | string | No | Length: 64–64 |
identity_hash | string | No | Length: 64–64 |
Used by: POST /sdk/v1/apps/{appId}/live-activities/tokens
SdkLoginDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–255 |
identity_hash | string | No | Length: 64–64 |
token_hash | string | No |
Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login
SdkLogoutDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout
SdkPreferences
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Used by: GET /sdk/v1/apps/{appId}/preferences, PUT /sdk/v1/apps/{appId}/preferences
SdkRegisterDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs" |
token | string | Yes | Length: 1–4096 |
device | object | No | Default: {} |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | No | |
user | object | No | |
user.external_id | string | No | Length: 1–255 |
user.identity_hash | string | No | Length: 64–64 |
user.tags | map<string, string> | No | |
user.properties | map<string, any> | No | |
user.subscription_id | string | No | Length: 1–64 |
user.token_hash | string | No | |
ownership_proof | boolean | No |
Used by: POST /sdk/v1/apps/{appId}/subscriptions
SdkRegisterResult
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
created | boolean | Yes |
Used by: POST /sdk/v1/apps/{appId}/subscriptions
SdkSecret
| Field | Type | Required | Description |
|---|---|---|---|
sdk_secret | string | Yes | |
identity_verification_required | boolean | Yes |
SdkSessionDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
subscription_id | string | Yes | Length: 1–∞ |
duration_seconds | integer | No | Range: 0–604800 |
app_version | string | null | No | |
sdk_version | string | No | Length: 0–50 |
Used by: POST /sdk/v1/apps/{appId}/sessions
SdkSetPreferencesDto
| Field | Type | Required | Description |
|---|---|---|---|
preferences | array<object> | Yes | Items: 1–100 |
preferences[].category | string | Yes | Length: 1–64 |
preferences[].channel | enum | null | No | |
preferences[].opted_in | boolean | Yes | |
subscription_id | string | Yes | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
Used by: PUT /sdk/v1/apps/{appId}/preferences
SdkSnippet
| Field | Type | Required | Description |
|---|---|---|---|
platform | string | Yes | |
variant | string | null | Yes | |
variants | array<string> | Yes | |
lang | string | Yes | |
availability | enum | Yes | Values: "available", "soon" |
docs_path | string | null | Yes | |
install | array<object> | Yes | |
install[].key | string | Yes | |
install[].language | string | Yes | |
install[].code | string | Yes | |
init | array<object> | Yes | |
init[].key | string | Yes | |
init[].language | string | Yes | |
init[].code | string | Yes | |
extras | array<object> | Yes | |
extras[].key | string | Yes | |
extras[].language | string | Yes | |
extras[].code | string | Yes | |
android_modules | array<object> | Yes | |
android_modules[].module | string | Yes | |
android_modules[].language | string | Yes | |
android_modules[].code | string | Yes |
Used by: GET /v1/apps/{appId}/setup/snippet
SdkSubscriptionPatchDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
token | string | No | Length: 1–4096 |
device | object | No | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
opted_in | boolean | No | |
location | object | null | No | |
advertising_id | string | null | No |
Used by: PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}
SdkSurveyResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
answers | map<string, string | boolean | number | array<string>> | Yes | |
visitor_id | string | No | |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
web_campaign_id | string | No | Length: 0–64 |
Used by: POST /sdk/v1/apps/{appId}/surveys/{surveyId}/responses
SdkUserPatchDto
| Field | Type | Required | Description |
|---|---|---|---|
tags | map<string, string | null> | No | |
properties | map<string, any> | No | |
deltas | object | No | |
deltas.session_count | integer | No | Range: -1000000–1000000 |
deltas.session_time | integer | No | Range: 0–31536000 |
deltas.purchases | array<object> | No | Items: 0–100 |
deltas.purchases[].sku | string | Yes | Length: 1–100 |
deltas.purchases[].amount | number | Yes | Range: 0–∞ |
deltas.purchases[].iso | string | No | Length: 3–3 |
deltas.purchases[].count | integer | No | Default: 1; Range: 1–1000 |
identity_hash | string | No | Length: 64–64 |
Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}
SdkUserResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
tags | map<string, string> | Yes |
Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login, POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout, PATCH /sdk/v1/apps/{appId}/users/{userId}
SdkWebCampaignEventDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "impression", "click", "close", "conversion" |
visitor_id | string | Yes | |
variant_id | string | No | Length: 0–64 |
button_id | string | No | Length: 0–64 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No |
Used by: POST /sdk/v1/apps/{appId}/web-campaigns/{campaignId}/events
SdkWebCampaignList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].trigger | object | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.visitor | enum | Yes | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | Yes | |
data[].frequency | object | Yes | |
data[].frequency.max_per_session | integer | No | Range: 1–100 |
data[].frequency.max_per_day | integer | No | Range: 1–100 |
data[].frequency.max_total | integer | No | Range: 1–1000 |
data[].frequency.hide_after_close_days | integer | No | Range: 0–365 |
data[].frequency.stop_after_conversion | boolean | No | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
data[].display.position | enum | Yes | Values: "left", "right" |
data[].display.background_color | string | null | Yes | |
data[].display.text_color | string | null | Yes | |
data[].display.dismissible | boolean | Yes | |
data[].display.auto_dismiss_seconds | integer | null | Yes | |
data[].display.max_width | integer | null | Yes | |
data[].display.blocks | array<object> | Yes | |
data[].display.form_id | string | null | Yes | |
data[].display.survey_id | string | null | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].display | object | Yes | |
data[].end_at | string | null | Yes | |
forms | map<string, object> | Yes | |
surveys | map<string, object> | Yes | |
language | string | Yes |
Used by: GET /sdk/v1/apps/{appId}/web-campaigns
SdkWebPersonalizationEventDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "impression", "conversion" |
visitor_id | string | Yes | |
variant_id | string | No | Length: 0–64 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No |
Used by: POST /sdk/v1/apps/{appId}/web-personalizations/{personalizationId}/events
SdkWebPersonalizationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.visitor | enum | Yes | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | Yes | |
data[].changes | array<object> | Yes | |
data[].changes[].selector | string | Yes | |
data[].changes[].action | enum | Yes | Values: "text", "image", "link", "hide", "show" |
data[].changes[].text | string | null | Yes | |
data[].changes[].url | string | null | Yes | |
data[].changes[].alt | string | null | Yes | |
data[].changes[].new_tab | boolean | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].changes | array<object> | Yes | |
data[].winner_variant_id | string | null | Yes | |
data[].goal | object | null | Yes | |
data[].end_at | string | null | Yes | |
editor_origins | array<string> | Yes | |
language | string | Yes |
Used by: GET /sdk/v1/apps/{appId}/web-personalizations
Segment
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
definition | map<string, any> | Yes | |
is_dynamic | boolean | Yes | |
estimated_count | integer | null | Yes | |
estimated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
sql | object | null | Yes | |
warehouse | object | null | Yes |
Used by: POST /v1/apps/{appId}/sql/segments, PATCH /v1/apps/{appId}/sql/segments/{segmentId}, POST /v1/apps/{appId}/sql/segments/{segmentId}/refresh, POST /v1/apps/{appId}/warehouse-segments/segments, PATCH /v1/apps/{appId}/warehouse-segments/segments/{segmentId}, POST /v1/apps/{appId}/warehouse-segments/segments/{segmentId}/refresh, POST /v1/apps/{appId}/segments, GET /v1/apps/{appId}/segments/{segmentId}, PATCH /v1/apps/{appId}/segments/{segmentId}, POST /v1/apps/{appId}/segments/{segmentId}/refresh, POST /v1/apps/{appId}/mcp/segment-drafts
SegmentCampaigns
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].status | string | Yes | |
data[].type | string | Yes | |
data[].usage | enum | Yes | Values: "include", "exclude" |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/segments/{segmentId}/campaigns
SegmentEstimate
| Field | Type | Required | Description |
|---|---|---|---|
segment_id | string | null | Yes | |
subscriptions | integer | Yes | |
users | integer | Yes | |
estimated_at | string | Yes | |
cached | boolean | Yes | |
sampled | boolean | Yes |
Used by: POST /v1/apps/{appId}/segments/{segmentId}/estimate
SegmentPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].definition | map<string, any> | Yes | |
data[].is_dynamic | boolean | Yes | |
data[].estimated_count | integer | null | Yes | |
data[].estimated_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].sql | object | null | Yes | |
data[].warehouse | object | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/segments
SegmentPreview
| Field | Type | Required | Description |
|---|---|---|---|
subscriptions | integer | Yes | |
users | integer | Yes | |
sampled | boolean | Yes | |
sample | array<object> | Yes | |
sample[].id | string | Yes | |
sample[].external_id | string | null | Yes | |
sample[].tags | map<string, string> | Yes | |
sample[].last_active_at | string | Yes |
Used by: POST /v1/apps/{appId}/segments/preview
SelectWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–∞ |
Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/winner
SessionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].ip | string | null | Yes | |
data[].user_agent | string | null | Yes | |
data[].created_at | string | Yes | |
data[].last_seen_at | string | Yes | |
data[].expires_at | string | Yes | |
data[].current | boolean | Yes |
SessionVolume
| Field | Type | Required | Description |
|---|---|---|---|
days | array<object> | Yes | |
days[].day | string | Yes | |
days[].sessions | integer | Yes | |
days[].users | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/sessions
SetMemberDto
| Field | Type | Required | Description |
|---|---|---|---|
role | string | No |
Used by: PUT /v1/apps/{appId}/companies/{companyId}/members/{userId}
SetOwnerDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–255 |
Used by: POST /v1/apps/{appId}/subscriptions/{subscriptionId}/owner
SetPreferencesDto
| Field | Type | Required | Description |
|---|---|---|---|
preferences | array<object> | Yes | Items: 1–100 |
preferences[].category | string | Yes | Length: 1–64 |
preferences[].channel | enum | null | No | |
preferences[].opted_in | boolean | Yes |
Used by: PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences
SetupStatus
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | |
name | string | Yes | |
platforms | array<string> | Yes | |
framework | string | Yes | |
web_integration | string | Yes | |
sdk_platforms | array<string> | Yes | |
channels | array<object> | Yes | |
channels[].platform | string | Yes | |
channels[].channel | string | Yes | |
channels[].provider | string | null | Yes | |
channels[].status | string | Yes | |
first_subscriber | boolean | Yes | |
completed | boolean | Yes | |
missing | array<object> | Yes | |
missing[].step | enum | Yes | Values: "credentials", "install", "first_subscriber" |
missing[].platform | string | No | |
missing[].channel | string | No | |
missing[].status | string | No | |
missing[].local_upload | boolean | No | |
missing[].sdk_platforms | array<string> | No | |
missing[].url | string | Yes | |
links | object | Yes | |
links.getting_started | string | Yes | |
links.channels | string | Yes |
Used by: GET /v1/apps/{appId}/setup/status
ShopifyWebhookStatus
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes |
SiteSearchCrawlRequest
| Field | Type | Required | Description |
|---|---|---|---|
queued | boolean | Yes | |
source | object | Yes | |
source.id | string | Yes | |
source.name | string | Yes | |
source.kind | enum | Yes | Values: "sitemap", "urls" |
source.url | string | null | Yes | |
source.urls | array<string> | Yes | |
source.max_pages | integer | Yes | |
source.refresh_hours | integer | null | Yes | |
source.enabled | boolean | Yes | |
source.status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
source.documents | integer | Yes | |
source.crawl_requested_at | string | null | Yes | |
source.last_crawled_at | string | null | Yes | |
source.next_crawl_at | string | null | Yes | |
source.last_error | string | null | Yes | |
source.stats | object | Yes | |
source.stats.pages_found | integer | Yes | |
source.stats.pages_indexed | integer | Yes | |
source.stats.pages_unchanged | integer | Yes | |
source.stats.pages_skipped | integer | Yes | |
source.stats.pages_failed | integer | Yes | |
source.stats.pages_removed | integer | Yes | |
source.stats.duration_ms | integer | Yes | |
source.created_at | string | Yes | |
source.updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/site-search/sources/{sourceId}/crawl
SiteSearchDocument
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
key | string | Yes | |
source_id | string | null | Yes | |
url | string | Yes | |
title | string | Yes | |
language | string | null | Yes | |
chunks | integer | Yes | |
chars | integer | Yes | |
indexed_at | string | Yes | |
created_at | string | Yes |
SiteSearchDocumentPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].key | string | Yes | |
data[].source_id | string | null | Yes | |
data[].url | string | Yes | |
data[].title | string | Yes | |
data[].language | string | null | Yes | |
data[].chunks | integer | Yes | |
data[].chars | integer | Yes | |
data[].indexed_at | string | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/site-search/documents
SiteSearchDocumentResult
| Field | Type | Required | Description |
|---|---|---|---|
outcome | enum | Yes | Values: "created", "updated", "unchanged" |
document | object | Yes | |
document.id | string | Yes | |
document.key | string | Yes | |
document.source_id | string | null | Yes | |
document.url | string | Yes | |
document.title | string | Yes | |
document.language | string | null | Yes | |
document.chunks | integer | Yes | |
document.chars | integer | Yes | |
document.indexed_at | string | Yes | |
document.created_at | string | Yes |
Used by: PUT /v1/apps/{appId}/site-search/documents/{documentKey}
SiteSearchEventDto
| Field | Type | Required | Description |
|---|---|---|---|
query_id | string | Yes | Length: 0–60 |
type | enum | Yes | Values: "click" |
url | string | Yes | Length: 0–2000 |
position | integer | No | Range: 1–100 |
Used by: POST /sdk/v1/apps/{appId}/search/events
SiteSearchOverview
| Field | Type | Required | Description |
|---|---|---|---|
settings | object | Yes | |
settings.enabled | boolean | Yes | |
settings.ai_answers | boolean | Yes | |
settings.allowed_origins | array<string> | Yes | |
settings.language | string | Yes | |
settings.text_search_config | string | Yes | |
settings.monthly_token_cap | integer | Yes | |
settings.query_retention_days | integer | Yes | |
settings.updated_at | string | null | Yes | |
index | object | Yes | |
index.documents | integer | Yes | |
index.chunks | integer | Yes | |
index.sources | integer | Yes | |
index.last_indexed_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.monthly_token_cap | integer | Yes | |
usage.period_start | string | Yes | |
ai | object | Yes | |
ai.available | boolean | Yes | |
ai.reason | enum | null | Yes |
Used by: GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings
SiteSearchPreview
| Field | Type | Required | Description |
|---|---|---|---|
query_id | string | Yes | |
mode | enum | Yes | Values: "search", "answer" |
results | array<object> | Yes | |
results[].id | string | Yes | |
results[].url | string | Yes | |
results[].title | string | Yes | |
results[].heading | string | Yes | |
results[].snippet | string | Yes | |
results[].snippet_html | string | Yes | |
answer | object | null | Yes | |
answer_status | enum | null | Yes | |
answers_available | boolean | Yes | |
fallback_reason | enum | null | Yes |
SiteSearchReport
| Field | Type | Required | Description |
|---|---|---|---|
period_days | integer | Yes | |
searches | integer | Yes | |
zero_results | integer | Yes | |
click_through_rate | number | Yes | |
answers_requested | integer | Yes | |
answered | integer | Yes | |
not_found | integer | Yes | |
answer_fallbacks | integer | Yes | |
tokens | integer | Yes | |
top_queries | array<object> | Yes | |
top_queries[].query | string | Yes | |
top_queries[].searches | integer | Yes | |
top_queries[].clicks | integer | Yes | |
top_queries[].avg_results | number | Yes | |
zero_result_queries | array<object> | Yes | |
zero_result_queries[].query | string | Yes | |
zero_result_queries[].searches | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].searches | integer | Yes | |
daily[].zero_results | integer | Yes | |
daily[].answered | integer | Yes |
Used by: GET /v1/apps/{appId}/site-search/report
SiteSearchRequestDto
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Length: 0–1000 |
mode | enum | No | Values: "search", "answer" |
language | string | No | |
limit | integer | No | Range: 1–20 |
Used by: POST /sdk/v1/apps/{appId}/search
SiteSearchResponse
| Field | Type | Required | Description |
|---|---|---|---|
query_id | string | Yes | |
mode | enum | Yes | Values: "search", "answer" |
results | array<object> | Yes | |
results[].id | string | Yes | |
results[].url | string | Yes | |
results[].title | string | Yes | |
results[].heading | string | Yes | |
results[].snippet | string | Yes | |
results[].snippet_html | string | Yes | |
answer | object | null | Yes | |
answer_status | enum | null | Yes | |
answers_available | boolean | Yes |
Used by: POST /sdk/v1/apps/{appId}/search
SiteSearchSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "sitemap", "urls" |
url | string | null | Yes | |
urls | array<string> | Yes | |
max_pages | integer | Yes | |
refresh_hours | integer | null | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
documents | integer | Yes | |
crawl_requested_at | string | null | Yes | |
last_crawled_at | string | null | Yes | |
next_crawl_at | string | null | Yes | |
last_error | string | null | Yes | |
stats | object | Yes | |
stats.pages_found | integer | Yes | |
stats.pages_indexed | integer | Yes | |
stats.pages_unchanged | integer | Yes | |
stats.pages_skipped | integer | Yes | |
stats.pages_failed | integer | Yes | |
stats.pages_removed | integer | Yes | |
stats.duration_ms | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/site-search/sources, PATCH /v1/apps/{appId}/site-search/sources/{sourceId}
SiteSearchSourceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "sitemap", "urls" |
data[].url | string | null | Yes | |
data[].urls | array<string> | Yes | |
data[].max_pages | integer | Yes | |
data[].refresh_hours | integer | null | Yes | |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
data[].documents | integer | Yes | |
data[].crawl_requested_at | string | null | Yes | |
data[].last_crawled_at | string | null | Yes | |
data[].next_crawl_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.pages_found | integer | Yes | |
data[].stats.pages_indexed | integer | Yes | |
data[].stats.pages_unchanged | integer | Yes | |
data[].stats.pages_skipped | integer | Yes | |
data[].stats.pages_failed | integer | Yes | |
data[].stats.pages_removed | integer | Yes | |
data[].stats.duration_ms | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/site-search/sources
SmsKeyword
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
keyword | string | Yes | |
scope | enum | Yes | Values: "org", "app" |
app_id | string | null | Yes | |
channels | array<enum> | Yes | |
actions | map<string, any> | Yes | |
enabled | boolean | Yes | |
description | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/sms-keywords, PATCH /v1/apps/{appId}/sms-keywords/{keywordId}
SmsKeywordList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].keyword | string | Yes | |
data[].scope | enum | Yes | Values: "org", "app" |
data[].app_id | string | null | Yes | |
data[].channels | array<enum> | Yes | |
data[].actions | map<string, any> | Yes | |
data[].enabled | boolean | Yes | |
data[].description | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
reserved | array<string> | Yes |
Used by: GET /v1/apps/{appId}/sms-keywords
SmsVerification
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
expires_at | string | Yes |
Used by: POST /v1/apps/{appId}/verify/sms
SmsVerificationCheck
| Field | Type | Required | Description |
|---|---|---|---|
verified | true | Yes |
Used by: POST /v1/apps/{appId}/verify/sms/check
SqlQueryResult
| Field | Type | Required | Description |
|---|---|---|---|
run_id | string | Yes | |
columns | array<object> | Yes | |
columns[].name | string | Yes | |
columns[].type | enum | "unknown" | Yes | |
rows | array<array<any>> | Yes | |
row_count | integer | Yes | |
truncated | boolean | Yes | |
duration_ms | integer | Yes |
Used by: POST /v1/apps/{appId}/sql/query
SqlRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].segment_id | string | null | Yes | |
data[].source | enum | Yes | Values: "panel", "api", "schedule" |
data[].actor_id | string | null | Yes | |
data[].query | string | Yes | |
data[].query_hash | string | Yes | |
data[].status | enum | Yes | Values: "ok", "rejected", "timeout", "failed" |
data[].reason | enum | null | Yes | |
data[].error | string | null | Yes | |
data[].row_count | integer | Yes | |
data[].truncated | boolean | Yes | |
data[].duration_ms | integer | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/sql/runs
SqlSchema
| Field | Type | Required | Description |
|---|---|---|---|
views | array<object> | Yes | |
views[].name | string | Yes | |
views[].columns | array<object> | Yes | |
views[].columns[].name | string | Yes | |
views[].columns[].type | enum | Yes | Values: "text", "integer", "number", "boolean", "timestamp", "json" |
limits | object | Yes | |
limits.query_max | integer | Yes | |
limits.row_limit_default | integer | Yes | |
limits.row_limit_max | integer | Yes | |
limits.timeout_default_ms | integer | Yes | |
limits.timeout_max_ms | integer | Yes | |
limits.segment_max_members | integer | Yes | |
refresh_intervals | array<integer> | Yes |
Used by: GET /v1/apps/{appId}/sql/schema
SqlSegmentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].definition | map<string, any> | Yes | |
data[].is_dynamic | boolean | Yes | |
data[].estimated_count | integer | null | Yes | |
data[].estimated_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].sql | object | null | Yes | |
data[].warehouse | object | null | Yes |
Used by: GET /v1/apps/{appId}/sql/segments
SsoConnection
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
type | enum | Yes | Values: "saml", "oidc" |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "disabled" |
config | object | Yes | |
config.idp_entity_id | string | No | Length: 1–500 |
config.idp_sso_url | string (uri) | No | Length: 0–2000 |
config.idp_certificates | array<string> | No | Items: 0–3 |
config.allow_idp_initiated | boolean | No | |
config.groups_attribute | string | No | Length: 0–200 |
config.email_attribute | string | No | Length: 0–200 |
config.name_attribute | string | No | Length: 0–200 |
config.issuer | string (uri) | No | Length: 0–2000 |
config.client_id | string | No | Length: 1–500 |
config.authorization_endpoint | string (uri) | No | Length: 0–2000 |
config.token_endpoint | string (uri) | No | Length: 0–2000 |
config.jwks_uri | string (uri) | No | Length: 0–2000 |
config.scopes | array<string> | No | Items: 0–20 |
config.groups_claim | string | No | Length: 0–200 |
has_client_secret | boolean | Yes | |
default_role | string | Yes | |
group_role_map | map<string, string> | Yes | |
jit_enabled | boolean | Yes | |
last_login_at | string | null | Yes | |
sp | object | Yes | |
sp.entity_id | string | Yes | |
sp.acs_url | string | Yes | |
sp.metadata_url | string | Yes | |
sp.redirect_uri | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
SsoConnectionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].type | enum | Yes | Values: "saml", "oidc" |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "disabled" |
data[].config | object | Yes | |
data[].config.idp_entity_id | string | No | Length: 1–500 |
data[].config.idp_sso_url | string (uri) | No | Length: 0–2000 |
data[].config.idp_certificates | array<string> | No | Items: 0–3 |
data[].config.allow_idp_initiated | boolean | No | |
data[].config.groups_attribute | string | No | Length: 0–200 |
data[].config.email_attribute | string | No | Length: 0–200 |
data[].config.name_attribute | string | No | Length: 0–200 |
data[].config.issuer | string (uri) | No | Length: 0–2000 |
data[].config.client_id | string | No | Length: 1–500 |
data[].config.authorization_endpoint | string (uri) | No | Length: 0–2000 |
data[].config.token_endpoint | string (uri) | No | Length: 0–2000 |
data[].config.jwks_uri | string (uri) | No | Length: 0–2000 |
data[].config.scopes | array<string> | No | Items: 0–20 |
data[].config.groups_claim | string | No | Length: 0–200 |
data[].has_client_secret | boolean | Yes | |
data[].default_role | string | Yes | |
data[].group_role_map | map<string, string> | Yes | |
data[].jit_enabled | boolean | Yes | |
data[].last_login_at | string | null | Yes | |
data[].sp | object | Yes | |
data[].sp.entity_id | string | Yes | |
data[].sp.acs_url | string | Yes | |
data[].sp.metadata_url | string | Yes | |
data[].sp.redirect_uri | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
SsoDiscoverResult
| Field | Type | Required | Description |
|---|---|---|---|
sso | boolean | Yes | |
type | enum | null | Yes | |
start_url | string | null | Yes |
SsoDomain
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
domain | string | Yes | |
verified | boolean | Yes | |
verified_at | string | null | Yes | |
last_checked_at | string | null | Yes | |
txt_record | object | Yes | |
txt_record.name | string | Yes | |
txt_record.value | string | Yes | |
created_at | string | Yes |
SsoDomainList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].domain | string | Yes | |
data[].verified | boolean | Yes | |
data[].verified_at | string | null | Yes | |
data[].last_checked_at | string | null | Yes | |
data[].txt_record | object | Yes | |
data[].txt_record.name | string | Yes | |
data[].txt_record.value | string | Yes | |
data[].created_at | string | Yes |
SsoSettings
| Field | Type | Required | Description |
|---|---|---|---|
enforced | boolean | Yes | |
available | boolean | Yes | |
scim_available | boolean | Yes | |
recovery_codes | array<string> | No | |
recovery_codes_remaining | integer | null | Yes |
SsoTestResult
| Field | Type | Required | Description |
|---|---|---|---|
connection_id | string | Yes | |
ok | boolean | Yes | |
error | string | null | Yes | |
email | string | null | Yes | |
name | string | null | Yes | |
groups | array<string> | Yes | |
mapped_role | string | null | Yes | |
domain_verified | boolean | Yes | |
account_exists | boolean | Yes | |
member | boolean | Yes | |
claims | map<string, any> | Yes | |
tested_at | string | Yes |
SsoTestStart
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes |
StartHygieneDto
Type: object
Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs, POST /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppress
StartLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | No | Length: 1–100 |
attributes | map<string, string | number | boolean> | No | |
target | object | Yes | |
target.include_external_ids | array<string> | No | Items: 0–2000 |
target.include_subscription_ids | array<string> | No | Items: 0–2000 |
target.included_segments | array<string> | No | Items: 0–20 |
target.all | boolean | No | |
content_state | map<string, string | number | boolean> | Yes | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Used by: POST /v1/apps/{appId}/live-activities/{activityType}/start
StartVerifyDto
| Field | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | Length: 8–20 |
locale | string | No | Length: 2–12 |
Used by: POST /v1/apps/{appId}/verify/sms
StatusTokenResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes |
Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Used by: PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, POST /v1/apps/{appId}/users/by/{label}/{value}/subscriptions, GET /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}, POST /v1/apps/{appId}/subscriptions/{subscriptionId}/owner
SubscriptionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].token | string | Yes | |
data[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
data[].unsubscribe_reason | enum | null | Yes | |
data[].device | object | Yes | |
data[].device.model | string | No | Length: 0–100 |
data[].device.os | string | No | Length: 0–50 |
data[].device.os_version | string | No | Length: 0–50 |
data[].device.app_version | string | null | No | |
data[].device.sdk_version | string | No | Length: 0–50 |
data[].device.sdk_platform | string | No | Length: 0–50 |
data[].device.carrier | string | No | Length: 0–100 |
data[].device.locale | string | No | Length: 0–20 |
data[].device.timezone | string | No | Length: 0–64 |
data[].device.push_capable | boolean | No | |
data[].device.push_environment | enum | No | Values: "sandbox", "production" |
data[].device.form_factor | enum | No | Values: "phone", "watch" |
data[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
data[].device.manufacturer | string | No | Length: 0–50 |
data[].device.brand | string | No | Length: 0–50 |
data[].device.rom | string | No | Length: 0–30 |
data[].device.rom_version | string | No | Length: 0–30 |
data[].device.delivery | object | No | |
data[].test_device | boolean | Yes | |
data[].test_device_name | string | null | Yes | |
data[].last_active_at | string | Yes | |
data[].last_sent_at | string | null | Yes | |
data[].last_delivered_at | string | null | Yes | |
data[].opted_in_at | string | null | Yes | |
data[].opt_in_source | string | null | Yes | |
data[].unsubscribed_at | string | null | Yes | |
data[].location | object | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/subscriptions
SubscriptionsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.active | integer | Yes | |
totals.new | integer | Yes | |
totals.unsubscribed | integer | Yes | |
totals.opt_outs | integer | Yes | |
totals.net | integer | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].new | integer | Yes | |
rows[].unsubscribed | integer | Yes | |
rows[].opt_outs | integer | Yes | |
rows[].net | integer | Yes | |
by_channel | array<object> | Yes | |
by_channel[].channel | string | Yes | |
by_channel[].active | integer | Yes | |
by_channel[].new | integer | Yes | |
by_channel[].unsubscribed | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/subscriptions
Suppression
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
value_masked | string | Yes | |
reason | enum | Yes | Values: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
source | string | Yes | |
detail | map<string, any> | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/suppressions
SuppressionPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].value_masked | string | Yes | |
data[].reason | enum | Yes | Values: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
data[].source | string | Yes | |
data[].detail | map<string, any> | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/suppressions
Survey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "closed" |
questions | array<object> | Yes | Items: 1–10 |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].text | map<string, string> | Yes | |
questions[].required | boolean | No | |
questions[].options | array<object> | No | Items: 0–30 |
questions[].options[].value | string | Yes | Length: 1–100 |
questions[].options[].label | map<string, string> | Yes | |
questions[].low_label | map<string, string> | No | |
questions[].high_label | map<string, string> | No | |
questions[].placeholder | map<string, string> | No | |
settings | object | Yes | |
settings.thank_you | map<string, string> | No | |
settings.submit_label | map<string, string> | No | |
settings.write_properties | boolean | No | |
settings.allow_multiple | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
in_app_message_id | string | null | Yes | |
stats | object | Yes | |
stats.responses | integer | Yes | |
stats.nps | number | null | Yes | |
stats.last_response_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/mcp/survey-drafts, POST /v1/apps/{appId}/surveys, GET /v1/apps/{appId}/surveys/{surveyId}, PATCH /v1/apps/{appId}/surveys/{surveyId}, POST /v1/apps/{appId}/surveys/{surveyId}/status, POST /v1/apps/{appId}/surveys/{surveyId}/distribute/in-app
SurveyInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
triggers | array<object> | No | Items: 1–5 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
layout | enum | No | Values: "modal", "banner_bottom", "fullscreen" |
publish | boolean | No |
Used by: POST /v1/apps/{appId}/surveys/{surveyId}/distribute/in-app
SurveyPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "closed" |
data[].questions | array<object> | Yes | Items: 1–10 |
data[].questions[].id | string | Yes | |
data[].questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
data[].questions[].text | map<string, string> | Yes | |
data[].questions[].required | boolean | No | |
data[].questions[].options | array<object> | No | Items: 0–30 |
data[].questions[].low_label | map<string, string> | No | |
data[].questions[].high_label | map<string, string> | No | |
data[].questions[].placeholder | map<string, string> | No | |
data[].settings | object | Yes | |
data[].settings.thank_you | map<string, string> | No | |
data[].settings.submit_label | map<string, string> | No | |
data[].settings.write_properties | boolean | No | |
data[].settings.allow_multiple | boolean | No | |
data[].settings.default_language | string | No | Length: 2–10 |
data[].in_app_message_id | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.responses | integer | Yes | |
data[].stats.nps | number | null | Yes | |
data[].stats.last_response_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/surveys
SurveyReport
| Field | Type | Required | Description |
|---|---|---|---|
survey_id | string | Yes | |
days | integer | Yes | |
responses | integer | Yes | |
nps | object | Yes | |
nps.responses | integer | Yes | |
nps.promoters | integer | Yes | |
nps.passives | integer | Yes | |
nps.detractors | integer | Yes | |
nps.nps | number | null | Yes | |
csat | object | Yes | |
csat.responses | integer | Yes | |
csat.average | number | null | Yes | |
csat.distribution | map<string, integer> | Yes | |
trend | array<object> | Yes | |
trend[].date | string | Yes | |
trend[].responses | integer | Yes | |
trend[].promoters | integer | Yes | |
trend[].passives | integer | Yes | |
trend[].detractors | integer | Yes | |
trend[].nps | number | null | Yes | |
channels | map<string, integer> | Yes | |
questions | array<object> | Yes | |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].counts | map<string, integer> | Yes |
Used by: GET /v1/apps/{appId}/surveys/{surveyId}/report
SurveyResponse
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
survey_id | string | Yes | |
user_id | string | null | Yes | |
visitor_id | string | null | Yes | |
channel | enum | Yes | Values: "in_app", "web", "email", "api", "sdk" |
answers | map<string, number | string | array<string>> | Yes | |
nps_score | integer | null | Yes | |
nps_category | enum | null | Yes | |
csat_score | integer | null | Yes | |
created_at | string | Yes |
SurveyResponsePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].survey_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].visitor_id | string | null | Yes | |
data[].channel | enum | Yes | Values: "in_app", "web", "email", "api", "sdk" |
data[].answers | map<string, number | string | array<string>> | Yes | |
data[].nps_score | integer | null | Yes | |
data[].nps_category | enum | null | Yes | |
data[].csat_score | integer | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/surveys/{surveyId}/responses
SurveyResponseResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
response_id | string | null | Yes | |
duplicate | boolean | Yes | |
thank_you | string | Yes |
Used by: POST /sdk/v1/apps/{appId}/surveys/{surveyId}/responses, POST /v1/apps/{appId}/surveys/{surveyId}/responses
SurveyStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "closed" |
Used by: POST /v1/apps/{appId}/surveys/{surveyId}/status
SyncAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
full | boolean | No |
Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/sync
TeamInputDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | null | No | |
member_ids | array<string> | No | Items: 0–200 |
Used by: POST /v1/apps/{appId}/inbox/teams
TeamUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | null | No | |
member_ids | array<string> | No | Items: 0–200 |
Used by: PATCH /v1/apps/{appId}/inbox/teams/{teamId}
Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/templates, GET /v1/apps/{appId}/templates/{templateId}, PATCH /v1/apps/{appId}/templates/{templateId}, POST /v1/apps/{appId}/templates/{templateId}/copy_to_app, POST /v1/apps/{appId}/templates/{templateId}/versions/{version}/revert, POST /v1/apps/{appId}/mcp/template-drafts
TemplatePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].channel | enum | null | Yes | |
data[].current_version | integer | Yes | |
data[].tags | array<string> | Yes | |
data[].content | map<string, any> | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/templates
TemplateStats
| Field | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | |
messages | integer | Yes | |
campaigns | integer | Yes | |
targeted | integer | Yes | |
sent | integer | Yes | |
delivered | integer | Yes | |
opened | integer | Yes | |
clicked | integer | Yes | |
converted | integer | Yes | |
open_rate | number | Yes | |
click_rate | number | Yes | |
conversion_rate | number | Yes | |
last_used_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/templates/{templateId}/stats
TemplateVersionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].version | integer | Yes | |
data[].content | map<string, any> | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/templates/{templateId}/versions
TestDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | Length: 1–256 |
user_id | string | No | Length: 1–64 |
Used by: POST /v1/apps/{appId}/data-feeds/{feedId}/test
TestPushDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_ids | array<string> | No | Items: 1–2000 |
headings | map<string, string> | No | |
contents | map<string, string> | Yes | |
url | string (url) | No | Length: 0–2000 |
data | map<string, string> | No |
Used by: POST /v1/apps/{appId}/mcp/test-sends
TraceResult
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | |
kind | string | Yes | |
items | array<object> | Yes | |
items[].delivery | object | Yes | |
items[].delivery.id | string | Yes | |
items[].delivery.message_id | string | Yes | |
items[].delivery.subscription_id | string | Yes | |
items[].delivery.user_id | string | null | Yes | |
items[].delivery.channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
items[].delivery.provider | string | null | Yes | |
items[].delivery.status | enum | Yes | Values: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
items[].delivery.attempt_count | integer | Yes | |
items[].delivery.provider_message_id | string | null | Yes | |
items[].delivery.error_code | string | null | Yes | |
items[].delivery.error_message | string | null | Yes | |
items[].delivery.suppression_reason | string | null | Yes | |
items[].delivery.send_after | string | null | Yes | |
items[].delivery.sent_at | string | null | Yes | |
items[].delivery.delivered_at | string | null | Yes | |
items[].delivery.opened_at | string | null | Yes | |
items[].delivery.clicked_at | string | null | Yes | |
items[].delivery.failed_at | string | null | Yes | |
items[].delivery.created_at | string | Yes | |
items[].events | array<object> | Yes | |
items[].events[].id | string | Yes | |
items[].events[].type | string | Yes | |
items[].events[].detail | map<string, any> | Yes | |
items[].events[].occurred_at | string | Yes | |
items[].subscription | object | null | Yes | |
items[].user | object | null | Yes | |
items[].render | object | null | Yes | |
items[].webhooks | array<object> | Yes | |
items[].webhooks[].id | string | Yes | |
items[].webhooks[].endpoint_id | string | Yes | |
items[].webhooks[].event_type | string | Yes | |
items[].webhooks[].status | string | Yes | |
items[].webhooks[].attempt | integer | Yes | |
items[].webhooks[].response_status | integer | null | Yes | |
items[].webhooks[].created_at | string | Yes | |
items[].message | object | null | Yes |
Used by: GET /v1/apps/{appId}/trace
TriggerRunDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | Length: 1–255 |
user_id | string | No | Length: 1–64 |
alias | object | No | |
alias.label | string | Yes | Length: 1–50 |
alias.value | string | Yes | Length: 1–255 |
context | map<string, any> | No |
Used by: POST /v1/apps/{appId}/journeys/{journeyId}/runs
UninstallReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.uninstalls | integer | Yes | |
totals.active | integer | Yes | |
totals.rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].uninstalls | integer | Yes | |
by_channel | array<object> | Yes | |
by_channel[].channel | string | Yes | |
by_channel[].uninstalls | integer | Yes | |
by_channel[].active | integer | Yes | |
last_messages | array<object> | Yes | |
last_messages[].campaign_id | string | null | Yes | |
last_messages[].name | string | null | Yes | |
last_messages[].source | string | Yes | |
last_messages[].uninstalls | integer | Yes |
Used by: GET /v1/apps/{appId}/analytics/uninstalls
UpdateAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
description | string | null | No | |
segment_id | string | No | Length: 1–64 |
identifiers | array<enum> | No | Items: 1–3 |
sync_interval_minutes | integer | No | Range: 60–360 |
status | enum | No | Values: "active", "paused" |
Used by: PATCH /v1/apps/{appId}/ads/audiences/{audienceId}
UpdateAdCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "active", "paused" |
daily_budget | string | number | No |
Used by: PATCH /v1/apps/{appId}/ads/campaigns/{entityId}
UpdateAffinityConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
attributes | array<string> | Yes | Items: 1–5 |
events | map<string, number> | Yes | |
window_days | integer | No | Range: 7–365 |
half_life_days | integer | No | Range: 1–180 |
Used by: PUT /v1/apps/{appId}/affinity/config
UpdateAiAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
channels | array<enum> | No | Items: 0–6 |
instructions | string | No | Length: 0–4000 |
faq | array<object> | No | Items: 0–50 |
faq[].question | string | Yes | Length: 1–300 |
faq[].answer | string | Yes | Length: 1–1500 |
tools | array<object> | No | Items: 0–10 |
tools[].name | string | Yes | |
tools[].description | string | Yes | Length: 1–500 |
tools[].url | string (uri) | Yes | Length: 0–2000 |
tools[].params | array<object> | No | Items: 0–8 |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | No | Length: 0–200 |
tools[].params[].required | boolean | No | |
handoff | object | No | |
handoff.keywords | array<string> | No | Items: 0–20 |
handoff.max_bot_replies | integer | No | Range: 1–50 |
handoff.on_negative_sentiment | boolean | No | |
handoff.message | string | No | Length: 0–500 |
limits | object | No | |
limits.monthly_token_cap | integer | No | Range: 1000–50000000 |
limits.max_steps | integer | No | Range: 1–6 |
ai_sentiment | boolean | No |
Used by: PATCH /v1/apps/{appId}/ai-agents/{agentId}
UpdateApiKeyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
scopes | array<enum> | No | Items: 1–8 |
ip_allowlist | array<string> | No | Items: 0–50 |
expires_at | string (date-time) | null | No |
Used by: PATCH /v1/apps/{appId}/api-keys/{keyId}
UpdateAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
platform_flags | object | No | |
platform_flags.ios | boolean | No | |
platform_flags.android | boolean | No | |
platform_flags.web | boolean | No | |
platform_flags.email | boolean | No | |
platform_flags.sms | boolean | No | |
icon_url | string (uri) | null | No | |
default_language | string | No | Length: 2–10 |
timezone | string | No | Length: 1–64 |
settings | object | No | |
settings.quietHours | object | null | No | |
settings.frequencyCap | object | null | No | |
settings.frequencyCaps | array<object> | No | Items: 0–10 |
settings.frequencyCaps[].max | integer | Yes | Range: 1–1000 |
settings.frequencyCaps[].window | object | Yes | |
settings.frequencyCaps[].channels | array<enum> | No | Items: 1–12 |
settings.inApp | object | No | |
settings.inApp.minIntervalSeconds | integer | No | Range: 0–604800 |
settings.androidChannels | array<object> | No | Items: 0–50 |
settings.androidChannels[].id | string | Yes | Length: 1–64 |
settings.androidChannels[].name | string | Yes | Length: 1–60 |
settings.androidChannels[].description | string | No | Length: 0–200 |
settings.androidChannels[].importance | enum | Yes | Values: "low", "default", "high", "urgent" |
settings.androidChannels[].sound | string | No | Length: 0–64 |
settings.androidChannels[].vibration | boolean | No | |
settings.androidChannels[].group | string | No | Length: 0–64 |
settings.sms | object | No | |
settings.sms.helpReply | string | No | Length: 0–320 |
settings.sms.stopReply | string | No | Length: 0–320 |
settings.sms.autoReply | boolean | No | |
settings.preferenceCenter | object | No | |
settings.preferenceCenter.enabled | boolean | No | |
settings.preferenceCenter.brandName | string | No | Length: 0–80 |
settings.preferenceCenter.logoUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.accentColor | string | No | |
settings.preferenceCenter.customUnsubscribeUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.texts | map<string, object> | No | |
settings.brandKit | object | No | |
settings.brandKit.website_url | string (url) | No | Length: 0–2000 |
settings.brandKit.name | string | No | Length: 0–80 |
settings.brandKit.primary_color | string | No | |
settings.brandKit.accent_color | string | No | |
settings.brandKit.font | string | No | Length: 0–40 |
settings.brandKit.logo_url | string (url) | No | Length: 0–2000 |
settings.brandKit.tone | string | No | Length: 0–240 |
settings.defaultTtlSeconds | integer | No | Range: 60–2419200 |
settings.identityVerificationRequired | boolean | No | |
settings.ipCapture | enum | No | Values: "off", "full", "masked" |
settings.ipRetentionDays | integer | No | Range: 1–365 |
settings.adaptiveFrequency | object | No | |
settings.adaptiveFrequency.enabled | boolean | Yes | |
settings.adaptiveFrequency.min | integer | Yes | Range: 1–50 |
settings.adaptiveFrequency.max | integer | Yes | Range: 1–50 |
settings.allowedOrigins | array<string> | No | Items: 0–50 |
settings.campaignApprovalRequired | boolean | No | |
settings.webPush | object | No | |
settings.webPush.serviceWorkerPath | string | No | Length: 0–200 |
settings.webPush.serviceWorkerScope | string | No | Length: 0–200 |
settings.webPush.prompt | object | No | |
settings.webPush.welcomeNotification | object | No | |
settings.webPush.clickBehavior | object | No | |
settings.webPush.customLink | object | No | |
settings.webPush.promptBackoffDays | array<integer> | No | Items: 0–10 |
settings.onboarding | object | No | |
settings.onboarding.step | integer | Yes | Range: 0–6 |
settings.onboarding.simulation | boolean | No | |
settings.onboarding.completed_at | string | null | No | |
settings.onboarding.version | integer | No | Range: 1–100 |
settings.onboarding.platforms | array<enum> | No | Items: 0–8 |
settings.onboarding.framework | enum | No | Values: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui" |
settings.onboarding.web_integration | enum | No | Values: "code", "wordpress" |
settings.sdkSetup | object | null | No | |
identity_verification_mode | enum | No | Values: "hmac", "jwt", "both" |
Used by: PATCH /v1/apps/{appId}
UpdateAppFlagDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
description | string | null | No | |
enabled | boolean | No | |
value_type | enum | No | Values: "boolean", "string", "number", "json" |
on_value | boolean | number | string | array<any> | map<string, any> | No | |
off_value | boolean | number | string | array<any> | map<string, any> | No | |
rollout_percent | integer | No | Range: 0–100 |
segment_id | string | null | No | |
rollout_schedule | array<object> | No | Items: 0–10 |
rollout_schedule[].at | string (date-time) | Yes | |
rollout_schedule[].percent | integer | Yes | Range: 0–100 |
Used by: PATCH /v1/apps/{appId}/feature-flags/{flagId}
UpdateBudgetAlertRuleDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
ad_account_id | string | null | No | |
campaign_external_id | string | null | No | |
threshold | number | No | Range: −∞–1000000000000 |
window_days | integer | No | Range: 1–30 |
recipients | array<string (email)> | No | Items: 0–20 |
enabled | boolean | No |
Used by: PATCH /v1/apps/{appId}/ads/alert-rules/{ruleId}
UpdateCatalogDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
currency | string | No |
Used by: PATCH /v1/apps/{appId}/catalogs/{catalogId}
UpdateCategoryDto
| Field | Type | Required | Description |
|---|---|---|---|
name | map<string, string> | No | |
description | map<string, string> | No | |
channels | array<enum> | null | No | |
default_opted_in | boolean | No | |
position | integer | No | Range: 0–1000 |
Used by: PATCH /v1/apps/{appId}/categories/{categoryId}
UpdateChannelScoreConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
window_days | integer | No | Range: 7–365 |
min_sends | integer | No | Range: 1–100 |
count_email_opens | boolean | No |
Used by: PUT /v1/apps/{appId}/channel-scores/config
UpdateCompanyDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | |
name | string | null | No | |
domain | string | null | No | |
properties | map<string, any> | No |
Used by: PATCH /v1/apps/{appId}/companies/{companyId}
UpdateContentTableDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No |
Used by: PATCH /v1/apps/{appId}/content-tables/{tableId}
UpdateCustomAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | No | Length: 0–300 |
enabled | boolean | No | |
instructions | string | No | Length: 0–4000 |
tools | array<enum> | No | Items: 0–5 |
schedule | object | null | No | |
limits | object | No | |
limits.max_steps | integer | No | Range: 1–10 |
limits.monthly_token_cap | integer | No | Range: 1000–20000000 |
Used by: PATCH /v1/apps/{appId}/custom-agents/{agentId}
UpdateDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
url_template | string | No | Length: 1–2048 |
method | enum | No | Values: "GET", "POST" |
body_template | string | null | No | |
headers | map<string, string> | No | |
secret_headers | map<string, string> | null | No | |
cache_ttl_seconds | integer | No | Range: 0–86400 |
timeout_ms | integer | No | Range: 100–2000 |
enabled | boolean | No |
Used by: PATCH /v1/apps/{appId}/data-feeds/{feedId}
UpdateDataSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
auth_mode | enum | No | Values: "signature", "token" |
mapping | object | No | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | No | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
auth_value | string | No | Length: 0–2000 |
Used by: PATCH /v1/apps/{appId}/data-pipelines/sources/{sourceId}
UpdateDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | No | Length: 0–500 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
rules | array<object> | No | Items: 0–50 |
code | string | No | Length: 0–20000 |
sources | array<enum> | No | Items: 0–6 |
event_names | array<string> | No | Items: 0–50 |
Used by: PATCH /v1/apps/{appId}/data-pipelines/transforms/{transformId}
UpdateDecisionAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "paused" |
reward_events | array<string> | No | Items: 1–10 |
reward_window_hours | integer | No | Range: 1–720 |
holdout_percent | integer | No | Range: 0–50 |
Used by: PATCH /v1/apps/{appId}/decision-agents/{id}
UpdateFormDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
fields | array<object> | No | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | No | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
status | enum | No | Values: "active", "archived" |
Used by: PATCH /v1/apps/{appId}/forms/{formId}
UpdateGeofenceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
lat | number | No | Range: -90–90 |
lng | number | No | Range: -180–180 |
radius_m | integer | No | Range: 100–50000 |
cooldown_minutes | integer | No | Range: 0–10080 |
enabled | boolean | No |
Used by: PATCH /v1/apps/{appId}/geofences/{geofenceId}
UpdateGlobalControlDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | Range: 1–50 |
Used by: PUT /v1/apps/{appId}/global-control
UpdateInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
triggers | array<object> | No | Items: 1–5 |
trigger_groups | array<array<object>> | No | Items: 1–10 |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
ab_test | object | No | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
display | object | No | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | No | |
placement | string | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: PATCH /v1/apps/{appId}/in-app-messages/{messageId}
UpdateJourneyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–120 |
description | string | null | No |
Used by: PATCH /v1/apps/{appId}/journeys/{journeyId}
UpdateKeywordDto
| Field | Type | Required | Description |
|---|---|---|---|
keyword | string | No | Length: 1–30 |
channels | array<enum> | No | Items: 1–3 |
actions | object | No | |
actions.add_tags | map<string, string> | No | |
actions.remove_tags | array<string> | No | Items: 0–50 |
actions.event | object | No | |
actions.event.name | string | Yes | |
actions.event.properties | map<string, string> | No | |
actions.reply | object | No | |
actions.reply.text | string | Yes | Length: 1–1600 |
actions.opt_in | boolean | No | |
enabled | boolean | No | |
description | string | null | No |
Used by: PATCH /v1/apps/{appId}/sms-keywords/{keywordId}
UpdateLandingPageDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
slug | string | No | Length: 0–80 |
document | object | No | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
seo | object | No | |
seo.title | string | No | Length: 0–120 |
seo.description | string | No | Length: 0–320 |
seo.og_image | string (url) | No | Length: 0–2000 |
seo.canonical_url | string (url) | No | Length: 0–2000 |
seo.noindex | boolean | No | |
settings | object | No | |
settings.language | string | No | Length: 2–10 |
settings.form_id | string | null | No | |
settings.form_section_id | string | null | No | |
settings.cookie_consent | object | No | |
settings.cookie_consent.enabled | boolean | Yes | |
settings.cookie_consent.text | string | No | Length: 0–1000 |
settings.cookie_consent.accept_label | string | No | Length: 0–60 |
settings.cookie_consent.reject_label | string | No | Length: 0–60 |
settings.cookie_consent.policy_url | string (url) | No | Length: 0–2000 |
settings.web_sdk | boolean | No | |
settings.favicon_url | string (url) | No | Length: 0–2000 |
custom_domain_id | string | null | No |
Used by: PATCH /v1/apps/{appId}/landing-pages/{pageId}
UpdateLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | Yes | Length: 1–100 |
content_state | map<string, string | number | boolean> | Yes | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Used by: POST /v1/apps/{appId}/live-activities/{activityType}/update
UpdateLiveActivityTypeDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
content_state_schema | object | No | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | No | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
Used by: PATCH /v1/apps/{appId}/live-activities/types/{activityType}
UpdateNodeDto
| Field | Type | Required | Description |
|---|---|---|---|
data | map<string, any> | No | |
position | object | No | |
position.x | number | Yes | |
position.y | number | Yes |
Used by: PATCH /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}
UpdatePredictionDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
enabled | boolean | No | |
event_names | array<string> | No | Items: 1–10 |
horizon_days | integer | No | Range: 7–90 |
Used by: PATCH /v1/apps/{appId}/predictions/{id}
UpdatePromoCodeListDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
expires_at | string (date-time) | null | No |
Used by: PATCH /v1/apps/{appId}/promo-code-lists/{listId}
UpdateRecommendationConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
view_events | array<string> | No | Items: 0–10 |
purchase_events | array<string> | No | Items: 0–10 |
item_property | string | No | |
window_days | integer | No | Range: 7–365 |
Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config
UpdateReverseEtlDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
schedule | enum | No | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | No | |
config | map<string, any> | No | |
credentials | map<string, any> | No |
Used by: PATCH /v1/apps/{appId}/reverse-etl/{syncId}
UpdateRfmConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
event_names | array<string> | Yes | Items: 1–10 |
value_property | string | null | No | |
use_monetary | boolean | No | |
window_days | integer | No | Range: 30–730 |
Used by: PUT /v1/apps/{appId}/rfm/config
UpdateSavedReportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
definition | object | No | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | No | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | No | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | No | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No |
Used by: PATCH /v1/apps/{appId}/analytics/reports/{id}
UpdateSiteSearchSettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | |
ai_answers | boolean | No | |
allowed_origins | array<string> | No | Items: 0–20 |
language | string | No | |
monthly_token_cap | integer | No | Range: 1000–50000000 |
query_retention_days | integer | No | Range: 7–365 |
Used by: PATCH /v1/apps/{appId}/site-search/settings
UpdateSiteSearchSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
kind | enum | No | Values: "sitemap", "urls" |
url | string | No | Length: 0–2000 |
urls | array<string> | No | Items: 1–500 |
max_pages | integer | No | Range: 1–2000 |
refresh_hours | integer | null | No | |
enabled | boolean | No |
Used by: PATCH /v1/apps/{appId}/site-search/sources/{sourceId}
UpdateSqlSegmentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
description | string | null | No | |
query | string | No | Length: 1–20000 |
refresh_interval_minutes | integer | null | No |
Used by: PATCH /v1/apps/{appId}/sql/segments/{segmentId}
UpdateSurveyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
questions | array<object> | No | Items: 1–10 |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].text | map<string, string> | Yes | |
questions[].required | boolean | No | |
questions[].options | array<object> | No | Items: 0–30 |
questions[].options[].value | string | Yes | Length: 1–100 |
questions[].options[].label | map<string, string> | Yes | |
questions[].low_label | map<string, string> | No | |
questions[].high_label | map<string, string> | No | |
questions[].placeholder | map<string, string> | No | |
settings | object | No | |
settings.thank_you | map<string, string> | No | |
settings.submit_label | map<string, string> | No | |
settings.write_properties | boolean | No | |
settings.allow_multiple | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
Used by: PATCH /v1/apps/{appId}/surveys/{surveyId}
UpdateTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
channel | enum | null | No | |
tags | array<string> | No | Items: 0–20 |
content | object | No | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.list | object | No | |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No |
Used by: PATCH /v1/apps/{appId}/templates/{templateId}
UpdateWalletConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
apple | object | null | No | |
google | object | null | No |
Used by: PUT /v1/apps/{appId}/wallet/config
UpdateWalletPassDto
| Field | Type | Required | Description |
|---|---|---|---|
barcode_value | string | No | Length: 1–500 |
values | map<string, string> | No |
Used by: PATCH /v1/apps/{appId}/wallet/passes/{id}
UpdateWalletTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "archived" |
design | object | No | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | No | Default: "#ffffff" |
design.foreground_color | string | No | Default: "#111111" |
design.label_color | string | No | Default: "#555555" |
design.barcode | enum | No | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | No | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | No | Default: ""; Length: 0–60 |
design.fields[].value | string | No | Default: ""; Length: 0–500 |
design.fields[].section | enum | No | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | map<string, string> | No |
Used by: PATCH /v1/apps/{appId}/wallet/templates/{id}
UpdateWarehouseConnectionDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
config | map<string, any> | No | |
credentials | map<string, any> | No |
Used by: PATCH /v1/apps/{appId}/warehouse-segments/connections/{connectionId}
UpdateWarehouseExportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
tables | array<enum> | No | Items: 1–6 |
schedule | enum | No | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | No | |
config | map<string, any> | No | |
credentials | map<string, any> | No |
Used by: PATCH /v1/apps/{appId}/warehouse-exports/{exportId}
UpdateWarehouseSegmentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
description | string | null | No | |
connection_id | string | No | Length: 1–∞ |
query | string | No | Length: 1–20000 |
id_column | string | No | |
id_type | enum | No | Values: "external_id", "user_id" |
refresh_interval_minutes | integer | null | No | |
limits | object | No | |
limits.timeout_seconds | integer | No | Range: 10–600 |
limits.max_rows | integer | No | Range: 1–1000000 |
limits.max_bytes_billed | integer | No | Range: 10485760–10995116277760 |
limits.max_warehouse_size | enum | null | No |
Used by: PATCH /v1/apps/{appId}/warehouse-segments/segments/{segmentId}
UpdateWarmupPlanDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "paused" |
daily_limits | array<integer> | No | Items: 1–120 |
provider_shares | object | null | No |
Used by: PATCH /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}
UpdateWebCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
display | object | No | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
trigger | object | No | |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
frequency | object | No | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: PATCH /v1/apps/{appId}/web-campaigns/{campaignId}
UpdateWebhookDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | No | Length: 1–2048 |
description | string | null | No | |
events | array<enum> | No | Items: 1–41 |
event_filters | object | No | |
event_filters.event_names | array<string> | No | Items: 0–50 |
batch | boolean | No | |
headers | map<string, string> | null | No | |
status | enum | No | Values: "active", "disabled" |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No |
Used by: PATCH /v1/apps/{appId}/webhooks/{webhookId}
UpdateWebPersonalizationDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
changes | array<object> | No | Items: 0–20 |
variants | array<object> | No | Items: 0–4 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Used by: PATCH /v1/apps/{appId}/web-personalizations/{personalizationId}
UpsertCatalogItemsDto
| Field | Type | Required | Description |
|---|---|---|---|
items | array<object> | Yes | Items: 1–1000 |
items[].id | string | Yes | Length: 1–128 |
items[].title | string | Yes | Length: 1–300 |
items[].description | string | null | No | |
items[].image_url | string (url) | null | No | |
items[].url | string (url) | null | No | |
items[].price | number | null | No | |
items[].sale_price | number | null | No | |
items[].currency | string | No | |
items[].category | string | null | No | |
items[].brand | string | null | No | |
items[].in_stock | boolean | No | |
items[].attributes | map<string, string> | No |
Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/items
UpsertCompanyDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | |
name | string | null | No | |
domain | string | null | No | |
properties | map<string, any> | No |
Used by: POST /v1/apps/{appId}/companies
UpsertUserDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | object | No | |
identity.external_id | string | Yes | Length: 1–255 |
external_id | string | No | Length: 1–255 |
properties | map<string, any> | No | |
tags | map<string, string> | No | |
subscriptions | array<object> | No | Items: 0–20 |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | Length: 1–4096 |
subscriptions[].device | object | No | Default: {} |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].status | enum | No | Values: "subscribed", "unsubscribed" |
subscriptions[].opt_in | object | No | |
subscriptions[].opt_in.source | string | Yes | Length: 1–100 |
subscriptions[].opt_in.at | string (date-time) | No |
Used by: POST /v1/apps/{appId}/users
UsageReport
| Field | Type | Required | Description |
|---|---|---|---|
org_id | string | Yes | |
plan_code | string | Yes | |
period | object | Yes | |
period.start | string | Yes | |
period.end | string | Yes | |
metrics | array<object> | Yes | |
metrics[].metric | string | Yes | |
metrics[].used | number | Yes | |
metrics[].limit | number | null | Yes | |
metrics[].percent | number | null | Yes | |
metrics[].hard | boolean | Yes | |
apps | array<object> | Yes | |
apps[].app_id | string | Yes | |
apps[].name | string | Yes | |
apps[].messages_sent | number | Yes | |
apps[].active_subscriptions | number | Yes | |
apps[].mau | number | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].messages_sent | number | Yes | |
daily[].api_requests | number | Yes | |
daily[].events_ingested | number | Yes | |
trialing | boolean | Yes | |
trial_ends_at | string | null | Yes | |
overage | object | null | No |
Used by: GET /v1/organization/usage
User
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes |
UserAffinity
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
affinities | array<object> | Yes | |
affinities[].attribute | string | Yes | |
affinities[].value | string | Yes | |
affinities[].score | number | Yes | |
affinities[].rank | integer | Yes | |
weekly_cap | integer | null | Yes | |
engagement | number | null | Yes | |
computed_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/affinity/users/{userId}
UserCompanyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].company | object | Yes | |
data[].company.id | string | Yes | |
data[].company.external_id | string | Yes | |
data[].company.name | string | null | Yes | |
data[].company.domain | string | null | Yes | |
data[].company.properties | map<string, any> | Yes | |
data[].role | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/users/{userId}/companies, GET /v1/apps/{appId}/users/by/{label}/{value}/companies
UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Used by: POST /v1/apps/{appId}/users, GET /v1/apps/{appId}/users/by/{label}/{value}, PATCH /v1/apps/{appId}/users/by/{label}/{value}, PATCH /v1/apps/{appId}/users/by/{label}/{value}/identity, DELETE /v1/apps/{appId}/users/by/{label}/{value}/identity/{aliasLabel}
UserExport
| Field | Type | Required | Description |
|---|---|---|---|
exported_at | string | Yes | |
user | object | Yes | |
user.id | string | Yes | |
user.app_id | string | Yes | |
user.external_id | string | null | Yes | |
user.properties | map<string, any> | Yes | |
user.tags | map<string, string> | Yes | |
user.first_seen_at | string | Yes | |
user.last_active_at | string | Yes | |
user.session_count | integer | Yes | |
user.usage_seconds | integer | Yes | |
user.merged_into | string | null | Yes | |
user.last_ip | string | null | Yes | |
user.last_ip_at | string | null | Yes | |
user.last_sentiment | enum | null | Yes | |
user.last_sentiment_at | string | null | Yes | |
user.created_at | string | Yes | |
user.updated_at | string | Yes | |
user.subscription_count | integer | Yes | |
user.channels | array<enum> | Yes | |
user.aliases | array<object> | Yes | |
user.aliases[].label | string | Yes | |
user.aliases[].value | string | Yes | |
user.subscriptions | array<object> | Yes | |
user.subscriptions[].id | string | Yes | |
user.subscriptions[].app_id | string | Yes | |
user.subscriptions[].user_id | string | null | Yes | |
user.subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
user.subscriptions[].token | string | Yes | |
user.subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
user.subscriptions[].unsubscribe_reason | enum | null | Yes | |
user.subscriptions[].device | object | Yes | |
user.subscriptions[].test_device | boolean | Yes | |
user.subscriptions[].test_device_name | string | null | Yes | |
user.subscriptions[].last_active_at | string | Yes | |
user.subscriptions[].last_sent_at | string | null | Yes | |
user.subscriptions[].last_delivered_at | string | null | Yes | |
user.subscriptions[].opted_in_at | string | null | Yes | |
user.subscriptions[].opt_in_source | string | null | Yes | |
user.subscriptions[].unsubscribed_at | string | null | Yes | |
user.subscriptions[].location | object | null | Yes | |
user.subscriptions[].created_at | string | Yes | |
events | array<object> | Yes | |
events[].id | string | Yes | |
events[].user_id | string | null | Yes | |
events[].subscription_id | string | null | Yes | |
events[].name | string | Yes | |
events[].properties | map<string, any> | Yes | |
events[].value | number | null | Yes | |
events[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
events[].occurred_at | string | Yes | |
derived | object | Yes | |
derived.wallet_passes | array<object> | Yes | |
derived.wallet_passes[].id | string | Yes | |
derived.wallet_passes[].template_id | string | Yes | |
derived.wallet_passes[].status | string | Yes | |
derived.wallet_passes[].barcode_value | string | Yes | |
derived.wallet_passes[].values | map<string, string> | Yes | |
derived.wallet_passes[].created_at | string | Yes | |
derived.wallet_passes[].updated_at | string | Yes | |
derived.rfm | object | null | Yes | |
derived.predictions | array<object> | Yes | |
derived.predictions[].model | string | Yes | |
derived.predictions[].score | number | Yes | |
derived.predictions[].computed_at | string | Yes | |
derived.channel_scores | array<object> | Yes | |
derived.channel_scores[].channel | string | Yes | |
derived.channel_scores[].sends | number | Yes | |
derived.channel_scores[].engaged | number | Yes | |
derived.channel_scores[].score | number | Yes | |
derived.channel_scores[].is_best | boolean | Yes | |
derived.channel_scores[].computed_at | string | Yes | |
derived.decisions | array<object> | Yes | |
derived.decisions[].agent | string | Yes | |
derived.decisions[].arm_id | string | Yes | |
derived.decisions[].context | string | Yes | |
derived.decisions[].assigned_at | string | Yes | |
derived.decisions[].rewarded_at | string | null | Yes | |
derived.recommendations | array<object> | Yes | |
derived.recommendations[].catalog_id | string | Yes | |
derived.recommendations[].personalized | array<string> | Yes | |
derived.recommendations[].recent | array<string> | Yes | |
derived.recommendations[].purchased | array<string> | Yes | |
derived.recommendations[].computed_at | string | Yes | |
derived.affinities | array<object> | Yes | |
derived.affinities[].attribute | string | Yes | |
derived.affinities[].value | string | Yes | |
derived.affinities[].score | number | Yes | |
derived.affinities[].rank | number | Yes | |
derived.affinities[].computed_at | string | Yes | |
derived.frequency_cap | object | null | Yes | |
derived.companies | array<object> | Yes | |
derived.companies[].company_id | string | Yes | |
derived.companies[].external_id | string | Yes | |
derived.companies[].name | string | null | Yes | |
derived.companies[].role | string | Yes | |
derived.companies[].joined_at | string | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/export
UserIdentity
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/identity, GET /v1/apps/{appId}/subscriptions/{subscriptionId}/user/identity
UserJourneyRuns
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].journey_id | string | Yes | |
data[].version | integer | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Yes | |
data[].next_action_at | string | null | Yes | |
data[].entered_at | string | Yes | |
data[].completed_at | string | null | Yes | |
data[].exit_reason | string | null | Yes | |
data[].goal_id | string | null | Yes | |
data[].goal_reached_at | string | null | Yes | |
data[].context | map<string, any> | Yes | |
data[].journey_name | string | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/journeys
UserList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].properties | map<string, any> | Yes | |
data[].tags | map<string, string> | Yes | |
data[].first_seen_at | string | Yes | |
data[].last_active_at | string | Yes | |
data[].session_count | integer | Yes | |
data[].usage_seconds | integer | Yes | |
data[].merged_into | string | null | Yes | |
data[].last_ip | string | null | Yes | |
data[].last_ip_at | string | null | Yes | |
data[].last_sentiment | enum | null | Yes | |
data[].last_sentiment_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].subscription_count | integer | Yes | |
data[].channels | array<enum> | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/users, POST /v1/apps/{appId}/users/search
UserMessageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].delivery_id | string | Yes | |
data[].message_id | string | Yes | |
data[].campaign_id | string | null | Yes | |
data[].source | string | Yes | |
data[].channel | string | Yes | |
data[].status | string | Yes | |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].created_at | string | Yes | |
data[].sent_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].opened_at | string | null | Yes | |
data[].clicked_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/messages
UserPreferences
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].id | string | Yes | |
categories[].app_id | string | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
categories[].position | integer | Yes | |
categories[].opted_out_users | integer | Yes | |
categories[].created_at | string | Yes | |
categories[].updated_at | string | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/preferences, PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences
UserTimeline
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].kind | enum | Yes | Values: "event", "delivery" |
data[].at | string | Yes | |
data[].title | string | Yes | |
data[].detail | string | Yes |
Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/timeline
VerifyAddressDto
| Field | Type | Required | Description |
|---|---|---|---|
address | string | Yes | Length: 3–320 |
Used by: POST /v1/apps/{appId}/email-deliverability/verify-address
WalletConfig
| Field | Type | Required | Description |
|---|---|---|---|
apple | object | Yes | |
apple.configured | boolean | Yes | |
apple.pass_type_id | string | null | Yes | |
apple.team_id | string | null | Yes | |
apple.certificate_expires_at | string | null | Yes | |
google | object | Yes | |
google.configured | boolean | Yes | |
google.issuer_id | string | null | Yes |
Used by: GET /v1/apps/{appId}/wallet/config, PUT /v1/apps/{appId}/wallet/config
WalletPass
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
template_id | string | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
barcode_value | string | Yes | |
values | map<string, string> | Yes | |
status | enum | Yes | Values: "active", "voided" |
url | string | Yes | |
apple_url | string | Yes | |
google_url | string | Yes | |
apple_devices | integer | Yes | |
version | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/wallet/passes, GET /v1/apps/{appId}/wallet/passes/{id}, PATCH /v1/apps/{appId}/wallet/passes/{id}, POST /v1/apps/{appId}/wallet/passes/{id}/void
WalletPassPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].template_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].barcode_value | string | Yes | |
data[].values | map<string, string> | Yes | |
data[].status | enum | Yes | Values: "active", "voided" |
data[].url | string | Yes | |
data[].apple_url | string | Yes | |
data[].google_url | string | Yes | |
data[].apple_devices | integer | Yes | |
data[].version | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes |
Used by: GET /v1/apps/{appId}/wallet/passes
WalletTemplate
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
status | enum | Yes | Values: "active", "archived" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | Yes | Default: "#ffffff" |
design.foreground_color | string | Yes | Default: "#111111" |
design.label_color | string | Yes | Default: "#555555" |
design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | Yes | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | Yes | Default: ""; Length: 0–60 |
design.fields[].value | string | Yes | Default: ""; Length: 0–500 |
design.fields[].section | enum | Yes | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | array<string> | Yes | |
passes | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/wallet/templates, GET /v1/apps/{appId}/wallet/templates/{id}, PATCH /v1/apps/{appId}/wallet/templates/{id}
WalletTemplateList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
data[].status | enum | Yes | Values: "active", "archived" |
data[].design | object | Yes | |
data[].design.title | string | Yes | Length: 1–100 |
data[].design.description | string | Yes | Length: 1–300 |
data[].design.organization | string | Yes | Length: 1–100 |
data[].design.background_color | string | Yes | Default: "#ffffff" |
data[].design.foreground_color | string | Yes | Default: "#111111" |
data[].design.label_color | string | Yes | Default: "#555555" |
data[].design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
data[].design.fields | array<object> | Yes | Default: []; Items: 0–12 |
data[].design.expires_at | string (date-time) | null | No | |
data[].design.relevant_at | string (date-time) | null | No | |
data[].images | array<string> | Yes | |
data[].passes | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/wallet/templates
WarehouseConnectionResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
detail | string | null | Yes | |
error | object | null | Yes |
Used by: POST /v1/apps/{appId}/warehouse-exports/test-connection, POST /v1/apps/{appId}/warehouse-exports/{exportId}/test, POST /v1/apps/{appId}/reverse-etl/test-connection, POST /v1/apps/{appId}/reverse-etl/{syncId}/test
WarehouseConnectionTest
Type: object
Used by: POST /v1/apps/{appId}/warehouse-exports/test-connection
WarehouseExport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
tables | array<enum> | Yes | |
schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
cursors | map<string, object> | Yes | |
schema_versions | map<string, integer> | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/warehouse-exports, GET /v1/apps/{appId}/warehouse-exports/{exportId}, PATCH /v1/apps/{appId}/warehouse-exports/{exportId}
WarehouseExportCreate
Type: object
Used by: POST /v1/apps/{appId}/warehouse-exports
WarehouseExportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
data[].config | map<string, any> | Yes | |
data[].credentials_hint | string | Yes | |
data[].tables | array<enum> | Yes | |
data[].schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "failing" |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].cursors | map<string, object> | Yes | |
data[].schema_versions | map<string, integer> | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/warehouse-exports
WarehouseExportRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
export_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
tables | map<string, object> | Yes | |
row_count | integer | Yes | |
attempt | integer | Yes | |
error | string | null | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes | |
duration_ms | integer | null | Yes | |
created_at | string | Yes |
Used by: POST /v1/apps/{appId}/warehouse-exports/{exportId}/run
WarehouseExportRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].export_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
data[].tables | map<string, object> | Yes | |
data[].row_count | integer | Yes | |
data[].attempt | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/warehouse-exports/{exportId}/runs
WarehouseSegmentConnection
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
type | enum | Yes | Values: "bigquery", "snowflake", "databricks" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
segment_count | integer | Yes | |
last_tested_at | string | null | Yes | |
last_test_error | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/warehouse-segments/connections, GET /v1/apps/{appId}/warehouse-segments/connections/{connectionId}, PATCH /v1/apps/{appId}/warehouse-segments/connections/{connectionId}
WarehouseSegmentConnectionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].type | enum | Yes | Values: "bigquery", "snowflake", "databricks" |
data[].config | map<string, any> | Yes | |
data[].credentials_hint | string | Yes | |
data[].segment_count | integer | Yes | |
data[].last_tested_at | string | null | Yes | |
data[].last_test_error | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/warehouse-segments/connections
WarehouseSegmentConnectionTest
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
error | object | null | Yes |
Used by: POST /v1/apps/{appId}/warehouse-segments/connections/{connectionId}/test
WarehouseSegmentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].definition | map<string, any> | Yes | |
data[].is_dynamic | boolean | Yes | |
data[].estimated_count | integer | null | Yes | |
data[].estimated_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].sql | object | null | Yes | |
data[].warehouse | object | null | Yes |
Used by: GET /v1/apps/{appId}/warehouse-segments/segments
WarehouseSegmentOptions
| Field | Type | Required | Description |
|---|---|---|---|
types | array<enum> | Yes | |
id_types | array<enum> | Yes | |
snowflake_warehouse_sizes | array<enum> | Yes | |
refresh_intervals | array<integer> | Yes | |
limits | object | Yes | |
limits.query_max | integer | Yes | |
limits.timeout_default_seconds | integer | Yes | |
limits.timeout_min_seconds | integer | Yes | |
limits.timeout_max_seconds | integer | Yes | |
limits.max_rows_default | integer | Yes | |
limits.max_rows_max | integer | Yes | |
limits.max_bytes_billed_default | integer | Yes | |
limits.max_bytes_billed_min | integer | Yes | |
limits.max_bytes_billed_max | integer | Yes | |
limits.preview_sample | integer | Yes | |
limits.connections_per_app | integer | Yes |
Used by: GET /v1/apps/{appId}/warehouse-segments/options
WarehouseSegmentPreview
| Field | Type | Required | Description |
|---|---|---|---|
run_id | string | Yes | |
mode | enum | Yes | Values: "dry_run", "sample" |
estimated_bytes | number | null | Yes | |
max_bytes_billed | number | null | Yes | |
within_limit | boolean | Yes | |
sample | array<string> | null | Yes | |
sample_truncated | boolean | Yes | |
sample_matched | integer | null | Yes | |
duration_ms | integer | Yes |
Used by: POST /v1/apps/{appId}/warehouse-segments/preview
WarehouseSegmentRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].segment_id | string | null | Yes | |
data[].connection_id | string | null | Yes | |
data[].warehouse_type | enum | Yes | Values: "bigquery", "snowflake", "databricks" |
data[].source | enum | Yes | Values: "panel", "api", "schedule" |
data[].actor_id | string | null | Yes | |
data[].query | string | Yes | |
data[].query_hash | string | Yes | |
data[].status | enum | Yes | Values: "ok", "rejected", "timeout", "failed" |
data[].reason | enum | null | Yes | |
data[].error | string | null | Yes | |
data[].row_count | integer | Yes | |
data[].matched_count | integer | null | Yes | |
data[].bytes_processed | number | null | Yes | |
data[].truncated | boolean | Yes | |
data[].duration_ms | integer | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/warehouse-segments/runs
WarehouseTables
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].name | enum | Yes | Values: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions" |
data[].mode | enum | Yes | Values: "incremental", "snapshot" |
data[].schema_version | integer | Yes | |
data[].cursor_column | string | null | Yes | |
data[].columns | array<object> | Yes | |
data[].columns[].name | string | Yes | |
data[].columns[].type | string | Yes | |
data[].columns[].nullable | boolean | Yes |
Used by: GET /v1/apps/{appId}/warehouse-exports/tables
WebCampaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
trigger | object | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/mcp/web-campaign-drafts, POST /v1/apps/{appId}/web-campaigns, GET /v1/apps/{appId}/web-campaigns/{campaignId}, PATCH /v1/apps/{appId}/web-campaigns/{campaignId}, POST /v1/apps/{appId}/web-campaigns/{campaignId}/status, POST /v1/apps/{appId}/web-campaigns/{campaignId}/winner
WebCampaignPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].priority | integer | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
data[].display.position | enum | No | Values: "left", "right" |
data[].display.background_color | string | No | |
data[].display.text_color | string | No | |
data[].display.dismissible | boolean | No | |
data[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
data[].display.max_width | integer | No | Range: 280–960 |
data[].display.blocks | array<object> | Yes | Items: 0–12 |
data[].display.form_id | string | null | No | |
data[].display.survey_id | string | null | No | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | Length: 1–64 |
data[].variants[].name | string | Yes | Length: 1–60 |
data[].variants[].weight_percent | integer | Yes | Range: 1–99 |
data[].variants[].display | object | Yes | |
data[].ab_test | object | Yes | |
data[].ab_test.winner_variant_id | string | null | Yes | |
data[].ab_test.decided_at | string | null | Yes | |
data[].ab_test.decided_by | string | null | Yes | |
data[].trigger | object | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.included_segments | array<string> | No | Items: 0–20 |
data[].targeting.excluded_segments | array<string> | No | Items: 0–20 |
data[].targeting.visitor | enum | No | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | No | Items: 0–3 |
data[].frequency | object | Yes | |
data[].frequency.max_per_session | integer | No | Range: 1–100 |
data[].frequency.max_per_day | integer | No | Range: 1–100 |
data[].frequency.max_total | integer | No | Range: 1–1000 |
data[].frequency.hide_after_close_days | integer | No | Range: 0–365 |
data[].frequency.stop_after_conversion | boolean | No | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.impressions | integer | Yes | |
data[].stats.clicks | integer | Yes | |
data[].stats.closes | integer | Yes | |
data[].stats.conversions | integer | Yes | |
data[].stats.unique_visitors | integer | Yes | |
data[].stats.ctr | number | Yes | |
data[].stats.conversion_rate | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_stats[].impressions | integer | Yes | |
data[].variant_stats[].clicks | integer | Yes | |
data[].variant_stats[].conversions | integer | Yes | |
data[].variant_stats[].ctr | number | Yes | |
data[].variant_stats[].conversion_rate | number | Yes | |
data[].variant_significance | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/web-campaigns
WebCampaignReport
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | string | Yes | |
days | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].impressions | integer | Yes | |
daily[].clicks | integer | Yes | |
daily[].closes | integer | Yes | |
daily[].conversions | integer | Yes | |
totals | object | Yes | |
totals.impressions | integer | Yes | |
totals.clicks | integer | Yes | |
totals.closes | integer | Yes | |
totals.conversions | integer | Yes | |
totals.unique_visitors | integer | Yes | |
totals.ctr | number | Yes | |
totals.conversion_rate | number | Yes |
Used by: GET /v1/apps/{appId}/web-campaigns/{campaignId}/report
WebCampaignStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Used by: POST /v1/apps/{appId}/web-campaigns/{campaignId}/status
WebCampaignWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Used by: POST /v1/apps/{appId}/web-campaigns/{campaignId}/winner
Webhook
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/webhooks/{webhookId}, PATCH /v1/apps/{appId}/webhooks/{webhookId}
WebhookBulkReplayResult
| Field | Type | Required | Description |
|---|---|---|---|
replayed | integer | Yes |
Used by: POST /v1/apps/{appId}/webhooks/{webhookId}/replay
WebhookDeliveryDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
endpoint_id | string | Yes | |
event_type | string | Yes | |
event_id | string | Yes | |
subject_id | string | null | Yes | |
attempt | integer | Yes | |
status | enum | Yes | Values: "pending", "success", "failed", "dead" |
response_status | integer | null | Yes | |
response_body_excerpt | string | null | Yes | |
error | string | null | Yes | |
duration_ms | integer | null | Yes | |
next_retry_at | string | null | Yes | |
delivered_at | string | null | Yes | |
replay_of | string | null | Yes | |
created_at | string | Yes | |
payload | map<string, any> | Yes |
Used by: POST /v1/apps/{appId}/webhooks/{webhookId}/test, GET /v1/apps/{appId}/webhooks/deliveries/{deliveryId}, POST /v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replay
WebhookDeliveryPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].endpoint_id | string | Yes | |
data[].event_type | string | Yes | |
data[].event_id | string | Yes | |
data[].subject_id | string | null | Yes | |
data[].attempt | integer | Yes | |
data[].status | enum | Yes | Values: "pending", "success", "failed", "dead" |
data[].response_status | integer | null | Yes | |
data[].response_body_excerpt | string | null | Yes | |
data[].error | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].next_retry_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].replay_of | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/webhooks/{webhookId}/deliveries
WebhookEventTypes
| Field | Type | Required | Description |
|---|---|---|---|
data | array<string> | Yes |
Used by: GET /v1/apps/{appId}/webhooks/event-types
WebhookList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].url | string | Yes | |
data[].description | string | null | Yes | |
data[].events | array<string> | Yes | |
data[].event_filters | object | Yes | |
data[].event_filters.event_names | array<string> | No | |
data[].batch | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "failing", "disabled" |
data[].disabled_reason | string | null | Yes | |
data[].failure_count | integer | Yes | |
data[].failing_since | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].last_failure_at | string | null | Yes | |
data[].header_names | array<string> | Yes | |
data[].previous_secret_expires_at | string | null | Yes | |
data[].body_template | string | null | Yes | |
data[].body_content_type | enum | Yes | Values: "application/json", "text/plain" |
data[].filters | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Used by: GET /v1/apps/{appId}/webhooks
WebhookPreviewDto
| Field | Type | Required | Description |
|---|---|---|---|
event_type | enum | Yes | Values: "message.queued", "message.completed", "message.failed", "delivery.sent", "delivery.delivered", "delivery.failed", "delivery.opened", "delivery.clicked", "delivery.bounced", "delivery.complained", "delivery.unsubscribed", "in_app.impression", "in_app.clicked", "in_app.dismissed", "subscription.created", "subscription.unsubscribed", "subscription.invalidated", "user.created", "user.updated", "user.merged", "user.deleted", "event.received", "conversion.created", "campaign.scheduled", "campaign.started", "campaign.completed", "journey.entered", "journey.step_completed", "journey.completed", "journey.exited", "conversation.created", "conversation.message", "conversation.assigned", "conversation.resolved", "audit.created", "form.submitted", "survey.responded", "ad_audience.synced", "ad_account.revoked", "ad_budget.alert", "ad_insights.imported", "webhook.test" |
data | map<string, any> | No | |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No | |
batch | boolean | No |
Used by: POST /v1/apps/{appId}/webhooks/preview
WebhookPreviewResult
| Field | Type | Required | Description |
|---|---|---|---|
payload | map<string, any> | Yes | |
matched | boolean | Yes | Whether the event passes the filter (if not, it is not sent). |
failed_conditions | array<object> | Yes | |
failed_conditions[].field | string | Yes | |
failed_conditions[].op | string | Yes | |
failed_conditions[].value | any | No | |
body | string | null | Yes | |
content_type | string | Yes | |
error | object | null | Yes |
Used by: POST /v1/apps/{appId}/webhooks/preview
WebhookSecret
| Field | Type | Required | Description |
|---|---|---|---|
secret | string | Yes |
WebhookWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | Yes | Returned only once, in the create and rotation responses. |
Used by: POST /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks/{webhookId}/rotate-secret
WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Used by: POST /v1/apps/{appId}/mcp/web-personalization-drafts, POST /v1/apps/{appId}/web-personalizations, GET /v1/apps/{appId}/web-personalizations/{personalizationId}, PATCH /v1/apps/{appId}/web-personalizations/{personalizationId}, POST /v1/apps/{appId}/web-personalizations/{personalizationId}/status, POST /v1/apps/{appId}/web-personalizations/{personalizationId}/winner
WebPersonalizationPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].priority | integer | Yes | |
data[].changes | array<object> | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | Length: 1–64 |
data[].variants[].name | string | Yes | Length: 1–60 |
data[].variants[].weight_percent | integer | Yes | Range: 1–99 |
data[].variants[].changes | array<object> | Yes | Items: 0–20 |
data[].ab_test | object | Yes | |
data[].ab_test.winner_variant_id | string | null | Yes | |
data[].ab_test.decided_at | string | null | Yes | |
data[].ab_test.decided_by | string | null | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.included_segments | array<string> | No | Items: 0–20 |
data[].targeting.excluded_segments | array<string> | No | Items: 0–20 |
data[].targeting.visitor | enum | No | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | No | Items: 0–3 |
data[].goal | object | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.visitors | integer | Yes | |
data[].stats.conversions | integer | Yes | |
data[].stats.conversion_rate | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].visitors | integer | Yes | |
data[].variant_stats[].conversions | integer | Yes | |
data[].variant_stats[].conversion_rate | number | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_significance | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Used by: GET /v1/apps/{appId}/web-personalizations
WebPersonalizationReport
| Field | Type | Required | Description |
|---|---|---|---|
personalization_id | string | Yes | |
days | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].visitors | integer | Yes | |
daily[].conversions | integer | Yes | |
totals | object | Yes | |
totals.visitors | integer | Yes | |
totals.conversions | integer | Yes | |
totals.conversion_rate | number | Yes |
Used by: GET /v1/apps/{appId}/web-personalizations/{personalizationId}/report
WebPersonalizationStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Used by: POST /v1/apps/{appId}/web-personalizations/{personalizationId}/status
WebPersonalizationWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Used by: POST /v1/apps/{appId}/web-personalizations/{personalizationId}/winner
WhatsAppTemplateList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].language | string | Yes | |
data[].category | string | Yes | |
data[].status | string | Yes | |
data[].components | array<map<string, any>> | Yes | |
data[].body_params | integer | Yes | |
data[].rejected_reason | string | null | Yes | |
data[].quality_score | string | null | Yes | |
data[].synced_at | string | Yes |
Used by: GET /v1/apps/{appId}/whatsapp/templates
WhatsAppTemplateSync
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
removed | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].language | string | Yes | |
data[].category | string | Yes | |
data[].status | string | Yes | |
data[].components | array<map<string, any>> | Yes | |
data[].body_params | integer | Yes | |
data[].rejected_reason | string | null | Yes | |
data[].quality_score | string | null | Yes | |
data[].synced_at | string | Yes |
Used by: POST /v1/apps/{appId}/whatsapp/templates/sync
ZapierHook
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
event | string | Yes | |
event_name | string | null | Yes | |
target_url | string | Yes | |
last_delivered_at | string | null | Yes | |
failure_count | integer | Yes | |
created_at | string | Yes |
Used by: POST /v1/apps/{appId}/integrations/zapier/hooks
ZapierHookList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].event | string | Yes | |
data[].event_name | string | null | Yes | |
data[].target_url | string | Yes | |
data[].last_delivered_at | string | null | Yes | |
data[].failure_count | integer | Yes | |
data[].created_at | string | Yes |
Used by: GET /v1/apps/{appId}/integrations/zapier/hooks
ZapierMe
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | |
app_name | string | Yes | |
org_id | string | Yes | |
scopes | array<string> | Yes |
Used by: GET /v1/apps/{appId}/integrations/zapier/me
ZapierSamples
Type: array<object>
Used by: GET /v1/apps/{appId}/integrations/zapier/samples
ZapierSubscribeDto
| Field | Type | Required | Description |
|---|---|---|---|
target_url | string | Yes | Length: 1–2000 |
event | enum | Yes | Values: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed" |
event_name | string | No | Length: 1–100 |