PushizoDocs
API reference

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

FieldTypeRequiredDescription
org_idstringYes
org_slugstringYes
roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"

Account

FieldTypeRequiredDescription
idstringYes
emailstringYes
namestringYes
localestringYes
timezonestringYes
email_verifiedbooleanYes
mfa_enabledbooleanYes
is_platform_adminbooleanYes
has_passwordbooleanYes
marketing_opt_inbooleanYes
preferencesobjectYes
preferences.date_formatenumYesValues: "auto", "dmy", "mdy", "iso"
preferences.time_formatenumYesValues: "auto", "24h", "12h"
preferences.table_densityenumYesValues: "comfortable", "compact"
created_atstringYes

AccountExport

FieldTypeRequiredDescription
format_versionintegerYes
generated_atstringYes
accountobjectYes
account.idstringYes
account.emailstringYes
account.namestringYes
account.localestringYes
account.timezonestringYes
account.statusstringYes
account.email_verified_atstring | nullYes
account.has_passwordbooleanYes
account.mfa_enabledbooleanYes
account.is_platform_adminbooleanYes
account.last_login_atstring | nullYes
account.preferencesobjectYes
account.preferences.date_formatenumYesValues: "auto", "dmy", "mdy", "iso"
account.preferences.time_formatenumYesValues: "auto", "24h", "12h"
account.preferences.table_densityenumYesValues: "comfortable", "compact"
account.created_atstringYes
account.updated_atstringYes
consentsobjectYes
consents.terms_accepted_atstring | nullYes
consents.terms_versionstring | nullYes
consents.marketing_opt_inbooleanYes
consents.marketing_opt_in_atstring | nullYes
membershipsarray<object>Yes
memberships[].org_idstringYes
memberships[].org_namestringYes
memberships[].org_slugstringYes
memberships[].rolestringYes
memberships[].is_primary_ownerbooleanYes
memberships[].app_scopesarray<string>Yes
memberships[].joined_atstringYes
sessionsarray<object>Yes
sessions[].idstringYes
sessions[].ipstring | nullYes
sessions[].user_agentstring | nullYes
sessions[].auth_methodstringYes
sessions[].persistentbooleanYes
sessions[].created_atstringYes
sessions[].last_seen_atstringYes
sessions[].expires_atstringYes
sessions[].revoked_atstring | nullYes
identitiesarray<object>Yes
identities[].providerstringYes
identities[].provider_user_idstringYes
identities[].emailstring | nullYes
identities[].created_atstringYes
mfa_factorsarray<object>Yes
mfa_factors[].typestringYes
mfa_factors[].verified_atstring | nullYes
mfa_factors[].last_used_atstring | nullYes
mfa_factors[].created_atstringYes
oauth_grantsarray<object>Yes
oauth_grants[].client_namestringYes
oauth_grants[].org_idstringYes
oauth_grants[].app_idstring | nullYes
oauth_grants[].scopesarray<string>Yes
oauth_grants[].created_atstringYes
oauth_grants[].revoked_atstring | nullYes
audit_entriesarray<object>Yes
audit_entries[].org_idstringYes
audit_entries[].app_idstring | nullYes
audit_entries[].actionstringYes
audit_entries[].target_typestring | nullYes
audit_entries[].target_idstring | nullYes
audit_entries[].metadatamap<string, any>Yes
audit_entries[].ipstring | nullYes
audit_entries[].created_atstringYes

AdAccount

FieldTypeRequiredDescription
idstringYes
app_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
external_idstringYes
namestringYes
currencystring | nullYes
timezonestring | nullYes
statusenumYesValues: "active", "error", "revoked"
scopesarray<string>Yes
login_customer_idstring | nullYes
token_expires_atstring | nullYes
last_refreshed_atstring | nullYes
last_errorstring | nullYes
last_error_atstring | nullYes
terms_accepted_atstring | nullYes
terms_versionstring | nullYes
audiencesintegerYes
created_atstringYes
updated_atstringYes

AdAccountList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].external_idstringYes
data[].namestringYes
data[].currencystring | nullYes
data[].timezonestring | nullYes
data[].statusenumYesValues: "active", "error", "revoked"
data[].scopesarray<string>Yes
data[].login_customer_idstring | nullYes
data[].token_expires_atstring | nullYes
data[].last_refreshed_atstring | nullYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].terms_accepted_atstring | nullYes
data[].terms_versionstring | nullYes
data[].audiencesintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/ads/accounts

AdAttributionReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
modelenumYesValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerYes
half_life_daysintegerYes
currencystringYes
group_bystringYes
conversion_eventsarray<string>Yes
rowsarray<object>Yes
rows[].keystringYes
rows[].channelenumYesValues: "meta", "google", "tiktok", "linkedin", "microsoft", "other_paid", "utm", "push", "email", "sms", "whatsapp", "rcs", "direct"
rows[].labelstringYes
rows[].paidbooleanYes
rows[].conversionsnumberYes
rows[].revenuenumberYes
rows[].new_customersnumberYes
rows[].spendnumber | nullYes
rows[].roasnumber | nullYes
rows[].cacnumber | nullYes
totalsobjectYes
totals.conversionsnumberYes
totals.revenuenumberYes
totals.spendnumberYes
totals.new_customersnumberYes
totals.roasnumber | nullYes
totals.platform_roasnumber | nullYes
totals.cacnumber | nullYes
totals.paid_cacnumber | nullYes
truncatedbooleanYes
fx_missingarray<string>Yes

Used by: GET /v1/apps/{appId}/ads/reports/attribution

AdAudience

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
sourceenumYesValues: "segment", "journey", "lookalike"
segment_idstring | nullYes
segment_namestring | nullYes
namestringYes
descriptionstring | nullYes
external_idstring | nullYes
statusenumYesValues: "pending", "active", "paused", "error"
identifiersarray<enum>Yes
sync_interval_minutesintegerYes
next_sync_atstring | nullYes
last_synced_atstring | nullYes
last_sync_statusenum | nullYes
full_reload_requestedbooleanYes
member_countintegerYes
estimated_sizeinteger | nullYes
match_ratenumber | nullYes
size_updated_atstring | nullYes
lookalike_source_idstring | nullYes
lookalike_specobject | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].ad_account_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].sourceenumYesValues: "segment", "journey", "lookalike"
data[].segment_idstring | nullYes
data[].segment_namestring | nullYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "pending", "active", "paused", "error"
data[].identifiersarray<enum>Yes
data[].sync_interval_minutesintegerYes
data[].next_sync_atstring | nullYes
data[].last_synced_atstring | nullYes
data[].last_sync_statusenum | nullYes
data[].full_reload_requestedbooleanYes
data[].member_countintegerYes
data[].estimated_sizeinteger | nullYes
data[].match_ratenumber | nullYes
data[].size_updated_atstring | nullYes
data[].lookalike_source_idstring | nullYes
data[].lookalike_specobject | nullYes
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/ads/audiences

AdAudienceSyncList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].audience_idstringYes
data[].triggerenumYesValues: "schedule", "manual", "journey"
data[].modeenumYesValues: "incremental", "full"
data[].statusenumYesValues: "running", "succeeded", "partial", "failed"
data[].addedintegerYes
data[].removedintegerYes
data[].failedintegerYes
data[].skipped_no_consentintegerYes
data[].skipped_no_identifierintegerYes
data[].batchesintegerYes
data[].retriesintegerYes
data[].errorstring | nullYes
data[].started_atstringYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes

Used by: GET /v1/apps/{appId}/ads/audiences/{audienceId}/syncs

AdAudienceSyncQueued

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes
modeenumYesValues: "incremental", "full"

Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/sync

AdBudgetAlertList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].rule_idstringYes
data[].rule_namestringYes
data[].kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
data[].daystringYes
data[].valuenumberYes
data[].thresholdnumberYes
data[].detailsmap<string, any>Yes
data[].emailedintegerYes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/ads/alerts

AdBudgetAlertRule

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
ad_account_idstring | nullYes
campaign_external_idstring | nullYes
thresholdnumberYes
window_daysintegerYes
recipientsarray<string>Yes
enabledbooleanYes
last_valuenumber | nullYes
last_evaluated_atstring | nullYes
last_triggered_onstring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/ads/alert-rules, PATCH /v1/apps/{appId}/ads/alert-rules/{ruleId}

AdBudgetAlertRuleList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
data[].ad_account_idstring | nullYes
data[].campaign_external_idstring | nullYes
data[].thresholdnumberYes
data[].window_daysintegerYes
data[].recipientsarray<string>Yes
data[].enabledbooleanYes
data[].last_valuenumber | nullYes
data[].last_evaluated_atstring | nullYes
data[].last_triggered_onstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/ads/alert-rules

AdCampaignCreated

FieldTypeRequiredDescription
campaignobjectYes
campaign.idstringYes
campaign.app_idstringYes
campaign.ad_account_idstringYes
campaign.platformenumYesValues: "meta", "google", "tiktok"
campaign.levelenumYesValues: "campaign", "ad_set", "ad"
campaign.external_idstringYes
campaign.campaign_external_idstringYes
campaign.ad_set_external_idstring | nullYes
campaign.namestringYes
campaign.statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
campaign.platform_statusstring | nullYes
campaign.objectivestring | nullYes
campaign.optimization_goalstring | nullYes
campaign.currencystring | nullYes
campaign.daily_budgetstring | nullYes
campaign.lifetime_budgetstring | nullYes
campaign.start_atstring | nullYes
campaign.end_atstring | nullYes
campaign.audience_external_idsarray<string>Yes
campaign.creativeobject | nullYes
campaign.budget_editablebooleanYes
campaign.created_by_pushizobooleanYes
campaign.last_seen_atstring | nullYes
campaign.platform_urlstringYes
campaign.metricsobject | nullYes
campaign.updated_atstringYes
ad_set_idstringYes
ad_idstring | nullYes
warningsarray<string>Yes
platform_urlstringYes

Used by: POST /v1/apps/{appId}/ads/campaigns

AdCampaignPreview

FieldTypeRequiredDescription
preview_urlstring | nullYes
platform_urlstringYes
creativeobject | nullYes

Used by: GET /v1/apps/{appId}/ads/campaigns/{entityId}/preview

AdCapiConfig

FieldTypeRequiredDescription
idstringYes
app_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
namestringYes
ad_account_idstring | nullYes
enabledbooleanYes
settingsobjectYes
settings.pixel_idstring | nullYes
settings.customer_idstring | nullYes
settings.login_customer_idstring | nullYes
settings.pixel_codestring | nullYes
event_mappingsarray<object>Yes
event_mappings[].event_namestringYes
event_mappings[].platform_eventstringYes
event_mappings[].value_propertystring | nullYes
event_mappings[].currency_propertystring | nullYes
test_event_codestring | nullYes
test_modebooleanYes
action_sourceenumYesValues: "website", "app"
default_currencystringYes
has_access_tokenbooleanYes
last_sent_atstring | nullYes
last_errorstring | nullYes
last_error_atstring | nullYes
statsobjectYes
stats.pendingintegerYes
stats.sentintegerYes
stats.failedintegerYes
stats.skippedintegerYes
created_atstringYes
updated_atstringYes

AdCapiConfigList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].namestringYes
data[].ad_account_idstring | nullYes
data[].enabledbooleanYes
data[].settingsobjectYes
data[].settings.pixel_idstring | nullYes
data[].settings.customer_idstring | nullYes
data[].settings.login_customer_idstring | nullYes
data[].settings.pixel_codestring | nullYes
data[].event_mappingsarray<object>Yes
data[].event_mappings[].event_namestringYes
data[].event_mappings[].platform_eventstringYes
data[].event_mappings[].value_propertystring | nullYes
data[].event_mappings[].currency_propertystring | nullYes
data[].test_event_codestring | nullYes
data[].test_modebooleanYes
data[].action_sourceenumYesValues: "website", "app"
data[].default_currencystringYes
data[].has_access_tokenbooleanYes
data[].last_sent_atstring | nullYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].statsobjectYes
data[].stats.pendingintegerYes
data[].stats.sentintegerYes
data[].stats.failedintegerYes
data[].stats.skippedintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/ads/conversions-api/configs

AdCapiDelivery

FieldTypeRequiredDescription
idstringYes
config_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
event_idstringYes
event_namestringYes
platform_eventstringYes
dedup_idstringYes
user_idstring | nullYes
valuenumber | nullYes
currencystring | nullYes
statusenumYesValues: "pending", "sent", "failed", "skipped"
skip_reasonstring | nullYes
attemptsintegerYes
next_attempt_atstring | nullYes
last_errorstring | nullYes
testbooleanYes
event_occurred_atstringYes
sent_atstring | nullYes
created_atstringYes

Used by: POST /v1/apps/{appId}/ads/conversions-api/deliveries/{deliveryId}/retry

AdCapiDeliveryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].config_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].event_idstringYes
data[].event_namestringYes
data[].platform_eventstringYes
data[].dedup_idstringYes
data[].user_idstring | nullYes
data[].valuenumber | nullYes
data[].currencystring | nullYes
data[].statusenumYesValues: "pending", "sent", "failed", "skipped"
data[].skip_reasonstring | nullYes
data[].attemptsintegerYes
data[].next_attempt_atstring | nullYes
data[].last_errorstring | nullYes
data[].testbooleanYes
data[].event_occurred_atstringYes
data[].sent_atstring | nullYes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/ads/conversions-api/deliveries

AdCapiTestResult

FieldTypeRequiredDescription
oktrueYes
responsemap<string, any>Yes

Used by: POST /v1/apps/{appId}/ads/conversions-api/configs/{configId}/test

AdCreative

FieldTypeRequiredDescription
idstringYes
file_namestring | nullYes
content_typestringYes
bytesintegerYes
widthinteger | nullYes
heightinteger | nullYes
preview_urlstringYes
created_atstringYes

Used by: GET /v1/apps/{appId}/ads/creatives, POST /v1/apps/{appId}/ads/creatives

AddAliasDto

FieldTypeRequiredDescription
identitymap<string, string>Yes

Used by: PATCH /v1/apps/{appId}/users/by/{label}/{value}/identity

AddSubscriptionDto

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYesLength: 1–4096
deviceobjectNoDefault: {}
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
statusenumNoValues: "subscribed", "unsubscribed"
opt_inobjectNo
opt_in.sourcestringYesLength: 1–100
opt_in.atstring (date-time)No

Used by: POST /v1/apps/{appId}/users/by/{label}/{value}/subscriptions

AdEntity

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
levelenumYesValues: "campaign", "ad_set", "ad"
external_idstringYes
campaign_external_idstringYes
ad_set_external_idstring | nullYes
namestringYes
statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
platform_statusstring | nullYes
objectivestring | nullYes
optimization_goalstring | nullYes
currencystring | nullYes
daily_budgetstring | nullYes
lifetime_budgetstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
audience_external_idsarray<string>Yes
creativeobject | nullYes
budget_editablebooleanYes
created_by_pushizobooleanYes
last_seen_atstring | nullYes
platform_urlstringYes
metricsobject | nullYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/ads/campaigns/{entityId}, PATCH /v1/apps/{appId}/ads/campaigns/{entityId}

AdEntityList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].ad_account_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].levelenumYesValues: "campaign", "ad_set", "ad"
data[].external_idstringYes
data[].campaign_external_idstringYes
data[].ad_set_external_idstring | nullYes
data[].namestringYes
data[].statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
data[].platform_statusstring | nullYes
data[].objectivestring | nullYes
data[].optimization_goalstring | nullYes
data[].currencystring | nullYes
data[].daily_budgetstring | nullYes
data[].lifetime_budgetstring | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].audience_external_idsarray<string>Yes
data[].creativeobject | nullYes
data[].budget_editablebooleanYes
data[].created_by_pushizobooleanYes
data[].last_seen_atstring | nullYes
data[].platform_urlstringYes
data[].metricsobject | nullYes
data[].updated_atstringYes
fromstringYes
tostringYes
accountsarray<object>Yes
accounts[].idstringYes
accounts[].campaigns_synced_atstring | nullYes
accounts[].insights_synced_atstring | nullYes
accounts[].campaigns_sync_errorstring | nullYes
accounts[].insights_sync_errorstring | nullYes

Used by: GET /v1/apps/{appId}/ads/campaigns

AdLtvReport

FieldTypeRequiredDescription
currencystringYes
monthsintegerYes
conversion_eventsarray<string>Yes
cohortsarray<object>Yes
cohorts[].cohortstringYes
cohorts[].sizeintegerYes
cohorts[].revenuearray<number>Yes
cohorts[].ltvarray<number>Yes
averagearray<number | null>Yes
fx_missingarray<string>Yes

Used by: GET /v1/apps/{appId}/ads/reports/ltv

AdOAuthPending

FieldTypeRequiredDescription
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
scopesarray<string>Yes
accountsarray<object>Yes
accounts[].external_idstringYes
accounts[].namestringYes
accounts[].currencystring | nullYes
accounts[].timezonestring | nullYes
accounts[].statusstring | nullYes
accounts[].manager_idstring | nullYes
accounts[].already_connectedbooleanYes

AdOAuthStartResult

FieldTypeRequiredDescription
urlstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"

AdOk

FieldTypeRequiredDescription
oktrueYes

Used by: DELETE /v1/apps/{appId}/ads/audiences/{audienceId}, DELETE /v1/apps/{appId}/ads/alert-rules/{ruleId}

AdPageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes

Used by: GET /v1/apps/{appId}/ads/accounts/{accountId}/pages

AdPlatformList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].enabledbooleanYes
data[].mockbooleanYes
data[].identifiersarray<enum>Yes
data[].lookalikebooleanYes
data[].batch_sizeintegerYes

Used by: GET /v1/apps/{appId}/ads/platforms

AdRefreshQueued

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes

Used by: POST /v1/apps/{appId}/ads/accounts/{accountId}/refresh

AdReportingSettings

FieldTypeRequiredDescription
reporting_currencystringYes
attribution_modelenumYesValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerYes
half_life_daysintegerYes
conversion_eventsarray<string>Yes
effective_conversion_eventsarray<string>Yes
fxobjectYes
fx.latest_daystring | nullYes
fx.sourcestring | nullYes

Used by: GET /v1/apps/{appId}/ads/settings, PUT /v1/apps/{appId}/ads/settings

AdReportingSettingsInputDto

FieldTypeRequiredDescription
reporting_currencystringNo
attribution_modelenumNoValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerNoRange: 1–90
half_life_daysintegerNoRange: 1–30
conversion_eventsarray<string>NoItems: 0–20

Used by: PUT /v1/apps/{appId}/ads/settings

AdSpendReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
currencystringYes
group_bystringYes
rowsarray<object>Yes
rows[].keystringYes
rows[].labelstringYes
rows[].platformstring | nullYes
rows[].impressionsnumberYes
rows[].clicksnumberYes
rows[].spendnumberYes
rows[].conversionsnumberYes
rows[].conversion_valuenumberYes
rows[].ctrnumber | nullYes
rows[].cpcnumber | nullYes
rows[].cpanumber | nullYes
rows[].roasnumber | nullYes
totalsobjectYes
totals.impressionsnumberYes
totals.clicksnumberYes
totals.spendnumberYes
totals.conversionsnumberYes
totals.conversion_valuenumberYes
totals.ctrnumber | nullYes
totals.cpcnumber | nullYes
totals.cpanumber | nullYes
totals.roasnumber | nullYes
fx_missingarray<string>Yes
storeenumYesValues: "postgres", "clickhouse"

Used by: GET /v1/apps/{appId}/ads/reports/spend

AffinityConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
attributesarray<string>Yes
eventsmap<string, number>Yes
window_daysintegerYes
half_life_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

Used by: GET /v1/apps/{appId}/affinity/config, PUT /v1/apps/{appId}/affinity/config, POST /v1/apps/{appId}/affinity/compute

AffinityOverview

FieldTypeRequiredDescription
last_computed_atstring | nullYes
scored_usersintegerYes
attributesarray<object>Yes
attributes[].attributestringYes
attributes[].valuesarray<object>Yes
attributes[].values[].valuestringYes
attributes[].values[].usersintegerYes
attributes[].values[].top_usersintegerYes

Used by: GET /v1/apps/{appId}/affinity/overview

AgentUpdateDto

FieldTypeRequiredDescription
max_concurrentinteger | nullNo
languagesarray<string>NoItems: 0–20

Used by: PATCH /v1/apps/{appId}/inbox/agents/{accountId}

AiAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/ai-agents/{agentId}, PATCH /v1/apps/{appId}/ai-agents/{agentId}

AiAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].enabledbooleanYes
data[].channelsarray<enum>Yes
data[].instructionsstringYes
data[].faqarray<object>Yes
data[].faq[].questionstringYes
data[].faq[].answerstringYes
data[].toolsarray<object>Yes
data[].tools[].namestringYes
data[].tools[].descriptionstringYes
data[].tools[].urlstringYes
data[].tools[].paramsarray<object>Yes
data[].handoffobjectYes
data[].handoff.keywordsarray<string>Yes
data[].handoff.max_bot_repliesintegerYes
data[].handoff.on_negative_sentimentbooleanYes
data[].handoff.messagestringYes
data[].limitsobjectYes
data[].limits.monthly_token_capintegerYes
data[].limits.max_stepsintegerYes
data[].ai_sentimentbooleanYes
data[].has_tool_secretbooleanYes
data[].usageobjectYes
data[].usage.tokens_this_monthintegerYes
data[].usage.period_startstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/ai-agents

AiAgentMetrics

FieldTypeRequiredDescription
period_daysintegerYes
runsintegerYes
repliedintegerYes
handed_offintegerYes
skipped_capintegerYes
failedintegerYes
conversationsintegerYes
resolution_ratenumberYes
avg_stepsnumberYes
tool_callsintegerYes
tool_error_ratenumberYes
tokensintegerYes
handoff_reasonsmap<string, integer>Yes

Used by: GET /v1/apps/{appId}/ai-agents/{agentId}/metrics

AiAgentRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].conversation_idstringYes
data[].statusenumYesValues: "pending", "replied", "handed_off", "skipped_cap", "failed"
data[].stepsarray<object>Yes
data[].steps[].kindenumYesValues: "reply", "tool", "handoff"
data[].steps[].toolstringNo
data[].steps[].statusinteger | nullNo
data[].steps[].okbooleanNo
data[].steps[].duration_msintegerNo
data[].input_tokensintegerYes
data[].output_tokensintegerYes
data[].handoff_reasonstring | nullYes
data[].errorstring | nullYes
data[].created_atstringYes
data[].finished_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/ai-agents/runs

AiAgentWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes
tool_secretstring | nullYes

Used by: POST /v1/apps/{appId}/ai-agents, POST /v1/apps/{appId}/ai-agents/{agentId}/rotate-secret

AiConversationSummary

FieldTypeRequiredDescription
summarystringYes
key_pointsarray<string>Yes
sentimentenumYesValues: "positive", "neutral", "negative"
metaobjectYes
meta.modelstringYes
meta.messagesintegerYes

AiGlossaryEntry

FieldTypeRequiredDescription
idstringYes
termstringYes
translationsmap<string, string>Yes
notestring | nullYes
created_atstringYes
updated_atstringYes

AiGlossaryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].termstringYes
data[].translationsmap<string, string>Yes
data[].notestring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

AiPanelApplyResult

FieldTypeRequiredDescription
segment_idstring | nullYes
campaign_idstring | nullYes
journey_idstring | nullYes

AiPanelResult

FieldTypeRequiredDescription
answerstringYes
segmentobject | nullYes
campaignobject | nullYes
journeyobject | nullYes
journey_editobject | nullYes
metaobjectYes
meta.modelstringYes

AiReplySuggestions

FieldTypeRequiredDescription
suggestionsarray<object>Yes
suggestions[].textstringYes
metaobjectYes
meta.modelstringYes
meta.filteredintegerYes
meta.messagesintegerYes

AiSettings

FieldTypeRequiredDescription
enabledbooleanYes
monthly_token_quotaintegerYes
banned_phrasesarray<string>Yes
providerenumYesValues: "anthropic", "openrouter", "mock"
availablebooleanYes
modelsobjectYes
models.defaultstringYes
models.longstringYes
usageobjectYes
usage.used_tokensintegerYes
usage.quota_tokensintegerYes
usage.period_startstringYes

AiStatus

FieldTypeRequiredDescription
enabledbooleanYes
availablebooleanYes
providerenumYesValues: "anthropic", "openrouter", "mock"
usageobjectYes
usage.used_tokensintegerYes
usage.quota_tokensintegerYes
usage.period_startstringYes
languagesarray<string>Yes
default_languagestringYes
field_limitsmap<string, integer>Yes
pending_translationsintegerYes

AiSubjectScoreResult

FieldTypeRequiredDescription
scoreintegerYes
reasonsarray<string>Yes
improvedarray<string>Yes
metaobjectYes
meta.modelstringYes
meta.filteredintegerYes
meta.warningsarray<string>Yes

AiSuggestions

FieldTypeRequiredDescription
suggestionsarray<object>Yes
suggestions[].textstringYes
suggestions[].lengthintegerYes
metaobjectYes
meta.modelstringYes
meta.filteredintegerYes
meta.warningsarray<string>Yes

AiTranslateResult

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].source_languagestringYes
data[].target_languagestringYes
data[].sourceobjectYes
data[].source.headingsstringNo
data[].source.contentsstringNo
data[].source.subtitlestringNo
data[].source.email_subjectstringNo
data[].source.email_preheaderstringNo
data[].resultobjectYes
data[].result.headingsstringNo
data[].result.contentsstringNo
data[].result.subtitlestringNo
data[].result.email_subjectstringNo
data[].result.email_preheaderstringNo
data[].statusenumYesValues: "pending", "approved", "rejected"
data[].ref_typestring | nullYes
data[].ref_idstring | nullYes
data[].warningsarray<string>Yes
data[].created_atstringYes
data[].reviewed_atstring | nullYes
data[].reviewed_bystring | nullYes
metaobjectYes
meta.modelstringYes
meta.filteredintegerYes
meta.warningsarray<string>Yes

AiTranslation

FieldTypeRequiredDescription
idstringYes
source_languagestringYes
target_languagestringYes
sourceobjectYes
source.headingsstringNo
source.contentsstringNo
source.subtitlestringNo
source.email_subjectstringNo
source.email_preheaderstringNo
resultobjectYes
result.headingsstringNo
result.contentsstringNo
result.subtitlestringNo
result.email_subjectstringNo
result.email_preheaderstringNo
statusenumYesValues: "pending", "approved", "rejected"
ref_typestring | nullYes
ref_idstring | nullYes
warningsarray<string>Yes
created_atstringYes
reviewed_atstring | nullYes
reviewed_bystring | nullYes

AiTranslationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].source_languagestringYes
data[].target_languagestringYes
data[].sourceobjectYes
data[].source.headingsstringNo
data[].source.contentsstringNo
data[].source.subtitlestringNo
data[].source.email_subjectstringNo
data[].source.email_preheaderstringNo
data[].resultobjectYes
data[].result.headingsstringNo
data[].result.contentsstringNo
data[].result.subtitlestringNo
data[].result.email_subjectstringNo
data[].result.email_preheaderstringNo
data[].statusenumYesValues: "pending", "approved", "rejected"
data[].ref_typestring | nullYes
data[].ref_idstring | nullYes
data[].warningsarray<string>Yes
data[].created_atstringYes
data[].reviewed_atstring | nullYes
data[].reviewed_bystring | nullYes

AiUsageReport

FieldTypeRequiredDescription
period_startstringYes
used_tokensintegerYes
quota_tokensintegerYes
by_featurearray<object>Yes
by_feature[].featurestringYes
by_feature[].modelstringYes
by_feature[].requestsintegerYes
by_feature[].input_tokensintegerYes
by_feature[].output_tokensintegerYes

AiVariantsResult

FieldTypeRequiredDescription
variantsarray<object>Yes
variants[].namestringYes
variants[].titlestringYes
variants[].bodystringYes
variants[].rationalestringYes
metaobjectYes
meta.modelstringYes
meta.filteredintegerYes
meta.warningsarray<string>Yes

AndroidDeliveryReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
devicesobjectYes
devices.totalintegerYes
devices.reportingintegerYes
devices.reporting_ratenumber | nullYes
devices.restrictedintegerYes
devices.restricted_ratenumber | nullYes
devices.background_restrictedintegerYes
devices.battery_optimizedintegerYes
devices.low_standby_bucketintegerYes
devices.power_saveintegerYes
devices.data_saverintegerYes
devices.channel_blockedintegerYes
devices.notifications_blockedintegerYes
devices.aggressive_vendorintegerYes
devices.aggressive_vendor_ratenumber | nullYes
totalsobjectYes
totals.sentintegerYes
totals.deliveredintegerYes
totals.openedintegerYes
totals.delivery_ratenumber | nullYes
totals.open_ratenumber | nullYes
totals.median_delay_secondsinteger | nullYes
totals.p90_delay_secondsinteger | nullYes
previousobject | nullYes
deprioritizedintegerYes
aggressiveobjectYes
aggressive.sentintegerYes
aggressive.deliveredintegerYes
aggressive.delivery_ratenumber | nullYes
othersobjectYes
others.sentintegerYes
others.deliveredintegerYes
others.delivery_ratenumber | nullYes
vendorsarray<object>Yes
vendors[].vendorstringYes
vendors[].aggressivebooleanYes
vendors[].devicesintegerYes
vendors[].reportingintegerYes
vendors[].restrictedintegerYes
vendors[].battery_optimizedintegerYes
vendors[].sentintegerYes
vendors[].deliveredintegerYes
vendors[].openedintegerYes
vendors[].delivery_ratenumber | nullYes
vendors[].open_ratenumber | nullYes
vendors[].median_delay_secondsinteger | nullYes
vendors[].p90_delay_secondsinteger | nullYes
vendors[].deprioritizedintegerYes
romsarray<object>Yes
roms[].romstringYes
roms[].devicesintegerYes
roms[].restrictedintegerYes
roms[].sentintegerYes
roms[].deliveredintegerYes
roms[].delivery_ratenumber | nullYes
roms[].median_delay_secondsinteger | nullYes
recommendationsarray<enum>Yes

Used by: GET /v1/apps/{appId}/analytics/android-delivery

ApiEventsDto

FieldTypeRequiredDescription
eventsarray<object>YesItems: 1–500
events[].namestringYesLength: 1–100
events[].propertiesmap<string, any>NoDefault: {}
events[].valuenumberNo
events[].occurred_atstring (date-time)No
events[].event_idstringNoLength: 8–64
events[].subscription_idstringNoLength: 1–∞
events[].external_idstringNoLength: 1–255

Used by: POST /v1/apps/{appId}/events

ApiKey

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
namestringYes
prefixstringYes
scopesarray<string>Yes
last_used_atstring | nullYes
expires_atstring | nullYes
revoked_atstring | nullYes
ip_allowlistarray<string>Yes
rotated_atstring | nullYes
created_bystring | nullYes
created_atstringYes

Used by: PATCH /v1/apps/{appId}/api-keys/{keyId}

ApiKeyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].namestringYes
data[].prefixstringYes
data[].scopesarray<string>Yes
data[].last_used_atstring | nullYes
data[].expires_atstring | nullYes
data[].revoked_atstring | nullYes
data[].ip_allowlistarray<string>Yes
data[].rotated_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/api-keys

App

FieldTypeRequiredDescription
idstringYes
org_idstringYes
namestringYes
slugstringYes
platform_flagsobjectYes
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring | nullYes
default_languagestringYes
timezonestringYes
settingsobjectYes
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
statusenumYesValues: "active", "suspended", "deleted"
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps, GET /v1/apps/{appId}, PATCH /v1/apps/{appId}, POST /v1/mcp/apps

AppFlag

FieldTypeRequiredDescription
idstringYes
app_idstringYes
keystringYes
namestringYes
descriptionstring | nullYes
enabledbooleanYes
value_typeenumYesValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>Yes
off_valueboolean | number | string | array<any> | map<string, any>Yes
rollout_percentintegerYes
segment_idstring | nullYes
rollout_schedulearray<object>Yes
rollout_schedule[].atstringYes
rollout_schedule[].percentintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/feature-flags, GET /v1/apps/{appId}/feature-flags/{flagId}, PATCH /v1/apps/{appId}/feature-flags/{flagId}

AppFlagEvaluation

FieldTypeRequiredDescription
flagsmap<string, object>Yes

Used by: POST /v1/apps/{appId}/feature-flags/evaluate

AppFlagList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].keystringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].enabledbooleanYes
data[].value_typeenumYesValues: "boolean", "string", "number", "json"
data[].on_valueboolean | number | string | array<any> | map<string, any>Yes
data[].off_valueboolean | number | string | array<any> | map<string, any>Yes
data[].rollout_percentintegerYes
data[].segment_idstring | nullYes
data[].rollout_schedulearray<object>Yes
data[].rollout_schedule[].atstringYes
data[].rollout_schedule[].percentintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/feature-flags

AppList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].namestringYes
data[].slugstringYes
data[].platform_flagsobjectYes
data[].platform_flags.iosbooleanNo
data[].platform_flags.androidbooleanNo
data[].platform_flags.webbooleanNo
data[].platform_flags.emailbooleanNo
data[].platform_flags.smsbooleanNo
data[].icon_urlstring | nullYes
data[].default_languagestringYes
data[].timezonestringYes
data[].settingsobjectYes
data[].settings.quietHoursobject | nullNo
data[].settings.frequencyCapobject | nullNo
data[].settings.frequencyCapsarray<object>NoItems: 0–10
data[].settings.inAppobjectNo
data[].settings.androidChannelsarray<object>NoItems: 0–50
data[].settings.smsobjectNo
data[].settings.preferenceCenterobjectNo
data[].settings.brandKitobjectNo
data[].settings.defaultTtlSecondsintegerNoRange: 60–2419200
data[].settings.identityVerificationRequiredbooleanNo
data[].settings.ipCaptureenumNoValues: "off", "full", "masked"
data[].settings.ipRetentionDaysintegerNoRange: 1–365
data[].settings.adaptiveFrequencyobjectNo
data[].settings.allowedOriginsarray<string>NoItems: 0–50
data[].settings.campaignApprovalRequiredbooleanNo
data[].settings.webPushobjectNo
data[].settings.onboardingobjectNo
data[].settings.sdkSetupobject | nullNo
data[].identity_verification_modeenumYesValues: "hmac", "jwt", "both"
data[].statusenumYesValues: "active", "suspended", "deleted"
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps

AppTransfer

FieldTypeRequiredDescription
idstringYes
app_idstringYes
app_namestring | nullYes
from_orgobjectYes
from_org.idstringYes
from_org.namestring | nullYes
from_org.slugstring | nullYes
to_orgobjectYes
to_org.idstringYes
to_org.namestring | nullYes
to_org.slugstring | nullYes
statusenumYesValues: "pending", "completed", "cancelled", "rejected", "failed"
source_approved_atstring | nullYes
target_approved_atstring | nullYes
completed_atstring | nullYes
failure_reasonstring | nullYes
created_atstringYes

AppTransferList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].app_namestring | nullYes
data[].from_orgobjectYes
data[].from_org.idstringYes
data[].from_org.namestring | nullYes
data[].from_org.slugstring | nullYes
data[].to_orgobjectYes
data[].to_org.idstringYes
data[].to_org.namestring | nullYes
data[].to_org.slugstring | nullYes
data[].statusenumYesValues: "pending", "completed", "cancelled", "rejected", "failed"
data[].source_approved_atstring | nullYes
data[].target_approved_atstring | nullYes
data[].completed_atstring | nullYes
data[].failure_reasonstring | nullYes
data[].created_atstringYes

AssignmentRule

FieldTypeRequiredDescription
idstringYes
namestringYes
enabledbooleanYes
positionintegerYes
conditionsobjectYes
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumYesValues: "round_robin", "least_busy", "team_only"
team_idstring | nullYes
agent_idsarray<string>Yes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/inbox/assignment-rules, PATCH /v1/apps/{appId}/inbox/assignment-rules/{ruleId}

AssignmentRuleInputDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
positionintegerNoRange: 0–10000
conditionsobjectNo
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumNoValues: "round_robin", "least_busy", "team_only"
team_idstring | nullNo
agent_idsarray<string>NoItems: 0–200

Used by: POST /v1/apps/{appId}/inbox/assignment-rules

AssignmentRuleList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].enabledbooleanYes
data[].positionintegerYes
data[].conditionsobjectYes
data[].conditions.channelsarray<enum>NoItems: 0–7
data[].conditions.languagesarray<string>NoItems: 0–20
data[].conditions.tagsmap<string, string>No
data[].strategyenumYesValues: "round_robin", "least_busy", "team_only"
data[].team_idstring | nullYes
data[].agent_idsarray<string>Yes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/inbox/assignment-rules

AssignmentRuleUpdateDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
positionintegerNoRange: 0–10000
conditionsobjectNo
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumNoValues: "round_robin", "least_busy", "team_only"
team_idstring | nullNo
agent_idsarray<string>NoItems: 0–200

Used by: PATCH /v1/apps/{appId}/inbox/assignment-rules/{ruleId}

AuditActions

FieldTypeRequiredDescription
actionsarray<string>Yes

AuditEntry

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
actor_typeenumYesValues: "account", "api_key", "system"
actor_idstring | nullYes
actionstringYes
target_typestring | nullYes
target_idstring | nullYes
metadatamap<string, any>Yes
ipstring | nullYes
request_idstring | nullYes
created_atstringYes

AuditPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].actor_typeenumYesValues: "account", "api_key", "system"
data[].actor_idstring | nullYes
data[].actionstringYes
data[].target_typestring | nullYes
data[].target_idstring | nullYes
data[].metadatamap<string, any>Yes
data[].ipstring | nullYes
data[].request_idstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/organization/audit-logs

AuthConfig

FieldTypeRequiredDescription
turnstile_site_keystring | nullYes

BatchMembersDto

FieldTypeRequiredDescription
membersarray<object>YesItems: 1–1000
members[].user_idstringNoLength: 1–64
members[].external_idstringNoLength: 1–255
members[].rolestringNo

Used by: POST /v1/apps/{appId}/companies/{companyId}/members/batch

BatchUpsertCompaniesDto

FieldTypeRequiredDescription
companiesarray<object>YesItems: 1–1000
companies[].external_idstringYes
companies[].namestring | nullNo
companies[].domainstring | nullNo
companies[].propertiesmap<string, any>No

Used by: POST /v1/apps/{appId}/companies/batch

BillingStatus

FieldTypeRequiredDescription
org_idstringYes
providerstringYesstripe | iyzico | creem | mock | none (no payment provider configured; checkout/portal returns 503)
planobjectYes
plan.codestringYes
plan.namestringYes
plan.monthly_priceintegerYes
plan.currencystringYes
plan.pricesobjectNo
plan.prices.USDintegerYes
plan.prices.TRYintegerYes
plan.positionintegerYes
plan.is_publicbooleanYes
plan.limitsobjectYes
plan.limits.subscriptionsinteger | nullYes
plan.limits.messages_per_monthinteger | nullYes
plan.limits.api_rpsinteger | nullYes
plan.limits.membersinteger | nullYes
plan.limits.appsinteger | nullYes
plan.limits.retention_daysinteger | nullYes
plan.limits.journeysinteger | nullYes
plan.limits.segmentsinteger | nullYes
plan.limits.ab_variantsinteger | nullYes
plan.limits.tags_per_userinteger | nullYes
plan.limits.aliases_per_userinteger | nullYes
plan.limits.subscriptions_per_userinteger | nullYes
plan.limits.report_history_daysinteger | nullYes
plan.limits.webhooksinteger | nullYes
plan.limits.api_keysinteger | nullYes
plan.limits.mauinteger | nullNo
plan.limits.emails_per_monthinteger | nullNo
plan.limits.sms_per_monthinteger | nullNo
plan.limits.whatsapp_conversations_per_monthinteger | nullNo
plan.limits.rcs_messages_per_monthinteger | nullNo
plan.limits.ai_credits_per_monthinteger | nullNo
plan.limits.data_feedsinteger | nullNo
plan.limits.content_tablesinteger | nullNo
plan.limits.event_streamsinteger | nullNo
plan.limits.warehouse_destinationsinteger | nullNo
plan.limits.custom_domainsinteger | nullNo
plan.featuresobjectYes
plan.features.journeysbooleanYes
plan.features.ab_testingbooleanYes
plan.features.emailbooleanYes
plan.features.smsbooleanYes
plan.features.in_appbooleanYes
plan.features.approval_flowbooleanYes
plan.features.ssobooleanYes
plan.features.scimbooleanNo
plan.features.audit_exportbooleanYes
plan.features.white_labelbooleanNo
plan.features.hide_powered_bybooleanNo
plan.features.resellerbooleanNo
plan.features.whatsappbooleanNo
plan.features.rcsbooleanNo
plan.features.live_activitiesbooleanNo
plan.features.inboxbooleanNo
plan.features.ai_assistantbooleanNo
plan.features.dynamic_contentbooleanNo
plan.features.event_streamsbooleanNo
plan.features.warehouse_exportbooleanNo
plan.features.custom_domainbooleanNo
plan.features.data_residencybooleanNo
plan.features.priority_supportbooleanNo
plan.features.mcp_serverbooleanNo
plan.features.overagebooleanNo
plan.features.rolesarray<string>Yes
plan.purchasablebooleanYes
effective_plan_codestringYes
trialingbooleanYes
trial_ends_atstring | nullYes
suspendedbooleanYes
suspended_reasonstring | nullYes
subscriptionobject | nullYes
billing_infoobject | nullYes

Branding

FieldTypeRequiredDescription
product_namestring | nullYes
logo_urlstring | nullYes
primary_colorstring | nullYes
secondary_colorstring | nullYes
support_emailstring | nullYes
hide_powered_bybooleanYes
effectiveobjectYes
effective.product_namestringYes
effective.logo_urlstring | nullYes
effective.primary_colorstring | nullYes
effective.secondary_colorstring | nullYes
effective.support_emailstring | nullYes
effective.powered_bybooleanYes
effective.inheritedbooleanYes
featuresobjectYes
features.white_labelbooleanYes
features.hide_powered_bybooleanYes

BrandKitExtract

FieldTypeRequiredDescription
website_urlstringNo
namestringNo
primary_colorstringNo
accent_colorstringNo
fontstringNo
logo_urlstringNo
tonestringNo

BrandResolution

FieldTypeRequiredDescription
kindenumYesValues: "dashboard", "tracking", "preference_center", "status_page"
org_slugstringYes
product_namestringYes
logo_urlstring | nullYes
primary_colorstring | nullYes
secondary_colorstring | nullYes
support_emailstring | nullYes
powered_bybooleanYes

BulkReplayDto

FieldTypeRequiredDescription
statusenumNoValues: "failed", "dead", "failed_or_dead"
fromstring (date-time)No
tostring (date-time)No

Used by: POST /v1/apps/{appId}/webhooks/{webhookId}/replay

Campaign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
labelsarray<string>Yes
categorystring | nullYes
goalsobjectYes
goals.primarystringNo
goals.secondaryarray<string>No
ab_testobjectYes
ab_test.enabledbooleanNo
ab_test.test_percentageintegerNoRange: 1–100
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.metricenumYesValues: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerNoRange: 5–10080
ab_test.phaseenumNoValues: "testing", "winner_sent"
ab_test.winner_variant_idstringNo
ab_test.decided_atstringNo
ab_test.decided_bystringNo
ab_test.significanceobjectNo
ab_test.significance.p_valuenumberYes
ab_test.significance.significantbooleanYes
ab_test.significance.metricstringYes
variantsarray<object>Yes
variants[].idstringYes
variants[].namestringYes
variants[].weight_percentintegerYes
variants[].contentmap<string, any> | nullYes
variants[].is_controlbooleanYes
variants[].positionintegerYes
typeenumYesValues: "one_time", "scheduled", "recurring", "automated", "transactional"
statusenumYesValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
audiencemap<string, any>Yes
contentmap<string, any>Yes
template_idstring | nullYes
template_versioninteger | nullYes
deliveryobjectYes
delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
delivery.delivery_time_of_daystringNo
delivery.throttle_per_minuteintegerNoRange: 1–1000000
delivery.ttlintegerNoRange: 60–2419200
delivery.priority5 | 10No
delivery.collapse_idstringNoLength: 0–64
delivery.frequency_cap_exemptbooleanNo
delivery.frequency_priorityenumNoValues: "low", "normal", "high"
delivery.global_control_exemptbooleanNo
delivery.quiet_hours_exemptbooleanNo
delivery.one_per_userbooleanNo
recurrenceobject | nullYes
approvalobjectYes
approval.requiredbooleanYes
approval.pending_actionenumNoValues: "send", "schedule"
approval.requested_bystringNo
approval.requested_atstringNo
approval.approved_bystringNo
approval.approved_atstringNo
approval.rejected_bystringNo
approval.rejected_atstringNo
statsobjectYes
stats.runsintegerNo
stats.targetedintegerNo
stats.suppressedintegerNo
stats.sentintegerNo
stats.deliveredintegerNo
stats.failedintegerNo
stats.openedintegerNo
stats.clickedintegerNo
stats.convertedintegerNo
stats.bouncedintegerNo
stats.complainedintegerNo
stats.unsubscribedintegerNo
stats.sms_segmentsintegerNo
send_atstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
run_countintegerYes
errorstring | nullYes
created_bystring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes
estimated_recipientsinteger | nullYes
preflightobject | nullYes

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

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
goalenumYesValues: "retention", "revenue", "reactivation", "engagement"
min_audienceintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_run_atstring | nullYes

CampaignEmailRisk

FieldTypeRequiredDescription
appliesbooleanYes
recipientsintegerYes
flagged_invalidintegerYes
sendableintegerYes
validintegerYes
unknownintegerYes
uncheckedintegerYes
estimated_invalid_rationumberYes
max_invalid_rationumberYes
blockedbooleanYes
bounce_rate_7dnumber | nullYes
bounce_rate_30dnumber | nullYes

Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/email-risk

CampaignPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].labelsarray<string>Yes
data[].categorystring | nullYes
data[].goalsobjectYes
data[].goals.primarystringNo
data[].goals.secondaryarray<string>No
data[].ab_testobjectYes
data[].ab_test.enabledbooleanNo
data[].ab_test.test_percentageintegerNoRange: 1–100
data[].ab_test.winnerobjectNo
data[].ab_test.phaseenumNoValues: "testing", "winner_sent"
data[].ab_test.winner_variant_idstringNo
data[].ab_test.decided_atstringNo
data[].ab_test.decided_bystringNo
data[].ab_test.significanceobjectNo
data[].variantsarray<object>Yes
data[].variants[].idstringYes
data[].variants[].namestringYes
data[].variants[].weight_percentintegerYes
data[].variants[].contentmap<string, any> | nullYes
data[].variants[].is_controlbooleanYes
data[].variants[].positionintegerYes
data[].typeenumYesValues: "one_time", "scheduled", "recurring", "automated", "transactional"
data[].statusenumYesValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
data[].audiencemap<string, any>Yes
data[].contentmap<string, any>Yes
data[].template_idstring | nullYes
data[].template_versioninteger | nullYes
data[].deliveryobjectYes
data[].delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
data[].delivery.delivery_time_of_daystringNo
data[].delivery.throttle_per_minuteintegerNoRange: 1–1000000
data[].delivery.ttlintegerNoRange: 60–2419200
data[].delivery.priority5 | 10No
data[].delivery.collapse_idstringNoLength: 0–64
data[].delivery.frequency_cap_exemptbooleanNo
data[].delivery.frequency_priorityenumNoValues: "low", "normal", "high"
data[].delivery.global_control_exemptbooleanNo
data[].delivery.quiet_hours_exemptbooleanNo
data[].delivery.one_per_userbooleanNo
data[].recurrenceobject | nullYes
data[].approvalobjectYes
data[].approval.requiredbooleanYes
data[].approval.pending_actionenumNoValues: "send", "schedule"
data[].approval.requested_bystringNo
data[].approval.requested_atstringNo
data[].approval.approved_bystringNo
data[].approval.approved_atstringNo
data[].approval.rejected_bystringNo
data[].approval.rejected_atstringNo
data[].statsobjectYes
data[].stats.runsintegerNo
data[].stats.targetedintegerNo
data[].stats.suppressedintegerNo
data[].stats.sentintegerNo
data[].stats.deliveredintegerNo
data[].stats.failedintegerNo
data[].stats.openedintegerNo
data[].stats.clickedintegerNo
data[].stats.convertedintegerNo
data[].stats.bouncedintegerNo
data[].stats.complainedintegerNo
data[].stats.unsubscribedintegerNo
data[].stats.sms_segmentsintegerNo
data[].send_atstring | nullYes
data[].next_run_atstring | nullYes
data[].last_run_atstring | nullYes
data[].run_countintegerYes
data[].errorstring | nullYes
data[].created_bystring | nullYes
data[].started_atstring | nullYes
data[].completed_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].estimated_recipientsinteger | nullYes
data[].preflightobject | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/campaigns

CampaignPreflightReport

FieldTypeRequiredDescription
campaign_idstringYes
checked_atstringYes
links_checkedbooleanYes
summaryobjectYes
summary.criticalintegerYes
summary.warningintegerYes
summary.infointegerYes
summary.blockedbooleanYes
findingsarray<object>Yes
findings[].codeenumYesValues: "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[].categoryenumYesValues: "brand", "content", "links", "personalization", "compliance"
findings[].severityenumYesValues: "critical", "warning", "info"
findings[].fieldstringNo
findings[].paramsmap<string, string | number>No

Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/preflight

CampaignProposal

FieldTypeRequiredDescription
idstringYes
kindenumYesValues: "churn_risk", "likely_to_act", "rfm_at_risk", "inactive_30d", "recent_clickers"
statusenumYesValues: "pending", "approved", "dismissed", "expired"
audience_sizeintegerYes
model_namestring | nullYes
draftobject | nullYes
segment_idstring | nullYes
campaign_idstring | nullYes
expires_atstringYes
created_atstringYes
decided_atstring | nullYes

CampaignProposalDraft

FieldTypeRequiredDescription
namestringYesLength: 2–120
titlestringYesLength: 1–65
bodystringYesLength: 1–240
languagestringYes

CampaignProposalList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kindenumYesValues: "churn_risk", "likely_to_act", "rfm_at_risk", "inactive_30d", "recent_clickers"
data[].statusenumYesValues: "pending", "approved", "dismissed", "expired"
data[].audience_sizeintegerYes
data[].model_namestring | nullYes
data[].draftobject | nullYes
data[].segment_idstring | nullYes
data[].campaign_idstring | nullYes
data[].expires_atstringYes
data[].created_atstringYes
data[].decided_atstring | nullYes

CampaignStats

FieldTypeRequiredDescription
campaignobjectYes
campaign.idstringYes
campaign.app_idstringYes
campaign.namestringYes
campaign.labelsarray<string>Yes
campaign.categorystring | nullYes
campaign.goalsobjectYes
campaign.goals.primarystringNo
campaign.goals.secondaryarray<string>No
campaign.ab_testobjectYes
campaign.ab_test.enabledbooleanNo
campaign.ab_test.test_percentageintegerNoRange: 1–100
campaign.ab_test.winnerobjectNo
campaign.ab_test.phaseenumNoValues: "testing", "winner_sent"
campaign.ab_test.winner_variant_idstringNo
campaign.ab_test.decided_atstringNo
campaign.ab_test.decided_bystringNo
campaign.ab_test.significanceobjectNo
campaign.variantsarray<object>Yes
campaign.variants[].idstringYes
campaign.variants[].namestringYes
campaign.variants[].weight_percentintegerYes
campaign.variants[].contentmap<string, any> | nullYes
campaign.variants[].is_controlbooleanYes
campaign.variants[].positionintegerYes
campaign.typeenumYesValues: "one_time", "scheduled", "recurring", "automated", "transactional"
campaign.statusenumYesValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
campaign.audiencemap<string, any>Yes
campaign.contentmap<string, any>Yes
campaign.template_idstring | nullYes
campaign.template_versioninteger | nullYes
campaign.deliveryobjectYes
campaign.delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
campaign.delivery.delivery_time_of_daystringNo
campaign.delivery.throttle_per_minuteintegerNoRange: 1–1000000
campaign.delivery.ttlintegerNoRange: 60–2419200
campaign.delivery.priority5 | 10No
campaign.delivery.collapse_idstringNoLength: 0–64
campaign.delivery.frequency_cap_exemptbooleanNo
campaign.delivery.frequency_priorityenumNoValues: "low", "normal", "high"
campaign.delivery.global_control_exemptbooleanNo
campaign.delivery.quiet_hours_exemptbooleanNo
campaign.delivery.one_per_userbooleanNo
campaign.recurrenceobject | nullYes
campaign.approvalobjectYes
campaign.approval.requiredbooleanYes
campaign.approval.pending_actionenumNoValues: "send", "schedule"
campaign.approval.requested_bystringNo
campaign.approval.requested_atstringNo
campaign.approval.approved_bystringNo
campaign.approval.approved_atstringNo
campaign.approval.rejected_bystringNo
campaign.approval.rejected_atstringNo
campaign.statsobjectYes
campaign.stats.runsintegerNo
campaign.stats.targetedintegerNo
campaign.stats.suppressedintegerNo
campaign.stats.sentintegerNo
campaign.stats.deliveredintegerNo
campaign.stats.failedintegerNo
campaign.stats.openedintegerNo
campaign.stats.clickedintegerNo
campaign.stats.convertedintegerNo
campaign.stats.bouncedintegerNo
campaign.stats.complainedintegerNo
campaign.stats.unsubscribedintegerNo
campaign.stats.sms_segmentsintegerNo
campaign.send_atstring | nullYes
campaign.next_run_atstring | nullYes
campaign.last_run_atstring | nullYes
campaign.run_countintegerYes
campaign.errorstring | nullYes
campaign.created_bystring | nullYes
campaign.started_atstring | nullYes
campaign.completed_atstring | nullYes
campaign.created_atstringYes
campaign.updated_atstringYes
campaign.estimated_recipientsinteger | nullYes
campaign.preflightobject | nullYes
ratesobjectYes
rates.delivery_ratenumber | nullYes
rates.open_ratenumber | nullYes
rates.click_ratenumber | nullYes
rates.failure_ratenumber | nullYes
rates.conversion_ratenumber | nullYes
goalsarray<object>Yes
goals[].eventstringYes
goals[].primarybooleanYes
goals[].convertedintegerYes
goals[].conversion_ratenumber | nullYes
cardsobject | nullYes
channelsarray<object>Yes
channels[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channels[].targetedintegerYes
channels[].sentintegerYes
channels[].failedintegerYes
channels[].openedintegerYes
channels[].clickedintegerYes
hourlyarray<object>Yes
hourly[].hourstringYes
hourly[].sentintegerYes
hourly[].failedintegerYes
hourly[].openedintegerYes
hourly[].clickedintegerYes
errorsarray<object>Yes
errors[].codestringYes
errors[].countintegerYes
messagesarray<object>Yes
messages[].idstringYes
messages[].app_idstringYes
messages[].sourceenumYesValues: "campaign", "api", "journey", "test"
messages[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
messages[].idempotency_keystring | nullYes
messages[].namestring | nullYes
messages[].contentmap<string, any>Yes
messages[].targetmap<string, any>Yes
messages[].optionsmap<string, any>Yes
messages[].labelsarray<string>Yes
messages[].categorystring | nullYes
messages[].template_idstring | nullYes
messages[].campaign_idstring | nullYes
messages[].variantsarray<object> | nullYes
messages[].countsobjectYes
messages[].counts.targetedintegerNo
messages[].counts.suppressedintegerNo
messages[].counts.sentintegerNo
messages[].counts.deliveredintegerNo
messages[].counts.failedintegerNo
messages[].counts.erroredintegerNo
messages[].counts.expiredintegerNo
messages[].counts.openedintegerNo
messages[].counts.clickedintegerNo
messages[].counts.convertedintegerNo
messages[].counts.bouncedintegerNo
messages[].counts.complainedintegerNo
messages[].counts.unsubscribedintegerNo
messages[].counts.sms_segmentsintegerNo
messages[].requested_byobjectYes
messages[].requested_by.typeenumYesValues: "api_key", "account", "system"
messages[].requested_by.idstringNo
messages[].errorstring | nullYes
messages[].scheduled_forstring | nullYes
messages[].started_atstring | nullYes
messages[].completed_atstring | nullYes
messages[].created_atstringYes
messages[].updated_atstringYes

Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/stats

CampaignVariantStats

FieldTypeRequiredDescription
ab_testobjectYes
ab_test.enabledbooleanNo
ab_test.test_percentageintegerNoRange: 1–100
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.metricenumYesValues: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerNoRange: 5–10080
ab_test.phaseenumNoValues: "testing", "winner_sent"
ab_test.winner_variant_idstringNo
ab_test.decided_atstringNo
ab_test.decided_bystringNo
ab_test.significanceobjectNo
ab_test.significance.p_valuenumberYes
ab_test.significance.significantbooleanYes
ab_test.significance.metricstringYes
variantsarray<object>Yes
variants[].variant_idstringYes
variants[].namestringYes
variants[].weight_percentintegerYes
variants[].is_controlbooleanYes
variants[].targetedintegerYes
variants[].sentintegerYes
variants[].deliveredintegerYes
variants[].openedintegerYes
variants[].clickedintegerYes
variants[].convertedintegerYes
variants[].holdoutintegerYes
variants[].open_ratenumberYes
variants[].click_ratenumberYes
variants[].conversion_ratenumberYes
variants[].goalsarray<object>Yes
variants[].goals[].eventstringYes
variants[].goals[].primarybooleanYes
variants[].goals[].convertedintegerYes
variants[].goals[].conversion_ratenumberYes
leaderstring | nullYes
significanceobjectYes
significance.p_valuenumberYes
significance.significantbooleanYes
significance.metricstringYes

Used by: GET /v1/apps/{appId}/campaigns/{campaignId}/variants/stats

CannedInputDto

FieldTypeRequiredDescription
shortcutstringYes
titlestringYesLength: 1–120
bodystringYesLength: 1–4000
languagestring | nullNo

Used by: POST /v1/apps/{appId}/canned-responses

CannedResponse

FieldTypeRequiredDescription
idstringYes
shortcutstringYes
titlestringYes
bodystringYes
languagestring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/canned-responses, PATCH /v1/apps/{appId}/canned-responses/{cannedId}

CannedResponseList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].shortcutstringYes
data[].titlestringYes
data[].bodystringYes
data[].languagestring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/canned-responses

CannedResponseRender

FieldTypeRequiredDescription
textstringYes

CannedUpdateDto

FieldTypeRequiredDescription
shortcutstringNo
titlestringNoLength: 1–120
bodystringNoLength: 1–4000
languagestring | nullNo

Used by: PATCH /v1/apps/{appId}/canned-responses/{cannedId}

Catalog

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
currencystringYes
item_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/catalogs, GET /v1/apps/{appId}/catalogs/{catalogId}, PATCH /v1/apps/{appId}/catalogs/{catalogId}

CatalogItem

FieldTypeRequiredDescription
idstringYes
titlestringYes
descriptionstring | nullYes
image_urlstring | nullYes
urlstring | nullYes
pricenumber | nullYes
sale_pricenumber | nullYes
currencystringYes
categorystring | nullYes
brandstring | nullYes
in_stockbooleanYes
attributesmap<string, string>Yes
updated_atstringYes

Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/items/{itemId}

CatalogItemsPage

FieldTypeRequiredDescription
totalintegerYes
dataarray<object>Yes
data[].idstringYes
data[].titlestringYes
data[].descriptionstring | nullYes
data[].image_urlstring | nullYes
data[].urlstring | nullYes
data[].pricenumber | nullYes
data[].sale_pricenumber | nullYes
data[].currencystringYes
data[].categorystring | nullYes
data[].brandstring | nullYes
data[].in_stockbooleanYes
data[].attributesmap<string, string>Yes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/items

CatalogList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].currencystringYes
data[].item_countintegerYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/catalogs

CatalogUpsertResult

FieldTypeRequiredDescription
catalogobjectYes
catalog.idstringYes
catalog.app_idstringYes
catalog.namestringYes
catalog.descriptionstring | nullYes
catalog.currencystringYes
catalog.item_countintegerYes
catalog.liquidstringYes
catalog.created_atstringYes
catalog.updated_atstringYes
upsertedintegerYes

Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/items, POST /v1/apps/{appId}/catalogs/{catalogId}/items/upload

CellHandoff

FieldTypeRequiredDescription
urlstringYes
expires_atstringYes

CellHandoffResult

FieldTypeRequiredDescription
accountobjectYes
account.idstringYes
account.emailstringYes
account.namestringYes
account.localestringYes
account.timezonestringYes
account.email_verifiedbooleanYes
account.mfa_enabledbooleanYes
account.is_platform_adminbooleanYes
account.has_passwordbooleanYes
account.marketing_opt_inbooleanYes
account.preferencesobjectYes
account.preferences.date_formatenumYesValues: "auto", "dmy", "mdy", "iso"
account.preferences.time_formatenumYesValues: "auto", "24h", "12h"
account.preferences.table_densityenumYesValues: "comfortable", "compact"
account.created_atstringYes
nextstring | nullYes

CellList

FieldTypeRequiredDescription
enabledbooleanYes
current_cell_idstring | nullYes
control_planebooleanYes
control_plane_dashboard_urlstring | nullYes
cellsarray<object>Yes
cells[].idstringYes
cells[].namestringYes
cells[].api_urlstringYes
cells[].dashboard_urlstringYes

CellOrgList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].slugstringYes
data[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].regionstring | nullYes
data[].dashboard_urlstring | nullYes
data[].localbooleanYes
unavailable_cellsarray<string>Yes

ChannelConfig

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
providerenum | nullYes
statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
configobjectYes
config.auth_typeenumNoValues: "token", "certificate"
config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
config.certificate_subjectstringNo
config.certificate_expires_atstringNo
config.key_idstringNo
config.team_idstringNo
config.bundle_idstringNo
config.environmentenumNoValues: "sandbox", "production"
config.project_idstringNo
config.client_emailstringNo
config.hms_app_idstringNo
config.high_prioritybooleanNo
config.subjectstringNo
config.vapid_public_keystringNo
config.site_urlstringNo
config.from_addressstringNo
config.from_namestringNo
config.reply_tostringNo
config.dkim_selectorstringNo
config.postal_addressstringNo
config.hoststringNo
config.portintegerNo
config.securebooleanNo
config.usernamestringNo
config.regionstringNo
config.access_key_idstringNo
config.configuration_setstringNo
config.account_sidstringNo
config.from_numberstringNo
config.messaging_service_sidstringNo
config.verify_service_sidstringNo
config.usercodestringNo
config.msgheaderstringNo
config.iys_filterenumNoValues: "0", "11", "12"
config.waba_idstringNo
config.phone_number_idstringNo
config.graph_api_versionstringNo
config.display_phone_numberstringNo
config.verified_namestringNo
config.rbm_agent_idstringNo
config.content_sidstringNo
config.sms_fallbackbooleanNo
config.telegram_bot_usernamestringNo
config.viber_uristringNo
config.viber_sender_namestringNo
config.viber_sender_avatarstringNo
config.webhook_registered_atstringNo
has_secretbooleanYes
has_hookbooleanYes
last_validated_atstring | nullYes
last_errorstring | nullYes
updated_atstring | nullYes
suspended_reasonstring | nullYes
dns_checkobject | nullYes

Used by: PUT /v1/apps/{appId}/channels/{channel}

ChannelHook

FieldTypeRequiredDescription
urlstring | nullYes
providerstringYes
pollingbooleanYes
eventsarray<string>Yes
verify_tokenstring | nullNo
secret_tokenstring | nullNo

ChannelList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].providerenum | nullYes
data[].statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
data[].configobjectYes
data[].config.auth_typeenumNoValues: "token", "certificate"
data[].config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
data[].config.certificate_subjectstringNo
data[].config.certificate_expires_atstringNo
data[].config.key_idstringNo
data[].config.team_idstringNo
data[].config.bundle_idstringNo
data[].config.environmentenumNoValues: "sandbox", "production"
data[].config.project_idstringNo
data[].config.client_emailstringNo
data[].config.hms_app_idstringNo
data[].config.high_prioritybooleanNo
data[].config.subjectstringNo
data[].config.vapid_public_keystringNo
data[].config.site_urlstringNo
data[].config.from_addressstringNo
data[].config.from_namestringNo
data[].config.reply_tostringNo
data[].config.dkim_selectorstringNo
data[].config.postal_addressstringNo
data[].config.hoststringNo
data[].config.portintegerNo
data[].config.securebooleanNo
data[].config.usernamestringNo
data[].config.regionstringNo
data[].config.access_key_idstringNo
data[].config.configuration_setstringNo
data[].config.account_sidstringNo
data[].config.from_numberstringNo
data[].config.messaging_service_sidstringNo
data[].config.verify_service_sidstringNo
data[].config.usercodestringNo
data[].config.msgheaderstringNo
data[].config.iys_filterenumNoValues: "0", "11", "12"
data[].config.waba_idstringNo
data[].config.phone_number_idstringNo
data[].config.graph_api_versionstringNo
data[].config.display_phone_numberstringNo
data[].config.verified_namestringNo
data[].config.rbm_agent_idstringNo
data[].config.content_sidstringNo
data[].config.sms_fallbackbooleanNo
data[].config.telegram_bot_usernamestringNo
data[].config.viber_uristringNo
data[].config.viber_sender_namestringNo
data[].config.viber_sender_avatarstringNo
data[].config.webhook_registered_atstringNo
data[].has_secretbooleanYes
data[].has_hookbooleanYes
data[].last_validated_atstring | nullYes
data[].last_errorstring | nullYes
data[].updated_atstring | nullYes
data[].suspended_reasonstring | nullYes
data[].dns_checkobject | nullYes

Used by: GET /v1/apps/{appId}/channels

ChannelScoreConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
window_daysintegerYes
min_sendsintegerYes
count_email_opensbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

Used by: GET /v1/apps/{appId}/channel-scores/config, PUT /v1/apps/{appId}/channel-scores/config, POST /v1/apps/{appId}/channel-scores/compute

ChannelScoreOverview

FieldTypeRequiredDescription
totalintegerYes
low_populationbooleanYes
last_computed_atstring | nullYes
channelsarray<object>Yes
channels[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
channels[].best_usersintegerYes
channels[].sharenumberYes
channels[].sendsintegerYes
channels[].engagedintegerYes
channels[].engagement_ratenumber | nullYes

Used by: GET /v1/apps/{appId}/channel-scores/overview

ChannelScoreUser

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
best_channelenum | nullYes
scoresarray<object>Yes
scores[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
scores[].sendsintegerYes
scores[].engagedintegerYes
scores[].scorenumberYes

Used by: GET /v1/apps/{appId}/channel-scores/users/{userId}

ChannelScoreUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].best_channelenum | nullYes
data[].scoresarray<object>Yes
data[].scores[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
data[].scores[].sendsintegerYes
data[].scores[].engagedintegerYes
data[].scores[].scorenumberYes
next_cursorstring | nullYes

Used by: GET /v1/apps/{appId}/channel-scores/users

ChannelStatusList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].channelstringYes
data[].providerstring | nullYes
data[].statusstringYes

Used by: GET /v1/apps/{appId}/channels/status

ChannelValidation

FieldTypeRequiredDescription
okbooleanYes
kindenum | nullYes
codestring | nullYes
messagestring | nullYes
detailsmap<string, any> | nullYes
channelobjectYes
channel.channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channel.providerenum | nullYes
channel.statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
channel.configobjectYes
channel.config.auth_typeenumNoValues: "token", "certificate"
channel.config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
channel.config.certificate_subjectstringNo
channel.config.certificate_expires_atstringNo
channel.config.key_idstringNo
channel.config.team_idstringNo
channel.config.bundle_idstringNo
channel.config.environmentenumNoValues: "sandbox", "production"
channel.config.project_idstringNo
channel.config.client_emailstringNo
channel.config.hms_app_idstringNo
channel.config.high_prioritybooleanNo
channel.config.subjectstringNo
channel.config.vapid_public_keystringNo
channel.config.site_urlstringNo
channel.config.from_addressstringNo
channel.config.from_namestringNo
channel.config.reply_tostringNo
channel.config.dkim_selectorstringNo
channel.config.postal_addressstringNo
channel.config.hoststringNo
channel.config.portintegerNo
channel.config.securebooleanNo
channel.config.usernamestringNo
channel.config.regionstringNo
channel.config.access_key_idstringNo
channel.config.configuration_setstringNo
channel.config.account_sidstringNo
channel.config.from_numberstringNo
channel.config.messaging_service_sidstringNo
channel.config.verify_service_sidstringNo
channel.config.usercodestringNo
channel.config.msgheaderstringNo
channel.config.iys_filterenumNoValues: "0", "11", "12"
channel.config.waba_idstringNo
channel.config.phone_number_idstringNo
channel.config.graph_api_versionstringNo
channel.config.display_phone_numberstringNo
channel.config.verified_namestringNo
channel.config.rbm_agent_idstringNo
channel.config.content_sidstringNo
channel.config.sms_fallbackbooleanNo
channel.config.telegram_bot_usernamestringNo
channel.config.viber_uristringNo
channel.config.viber_sender_namestringNo
channel.config.viber_sender_avatarstringNo
channel.config.webhook_registered_atstringNo
channel.has_secretbooleanYes
channel.has_hookbooleanYes
channel.last_validated_atstring | nullYes
channel.last_errorstring | nullYes
channel.updated_atstring | nullYes
channel.suspended_reasonstring | nullYes
channel.dns_checkobject | nullYes

Used by: POST /v1/apps/{appId}/channels/{channel}/validate

CheckoutResult

FieldTypeRequiredDescription
urlstringYes
session_idstringYes

CheckVerifyDto

FieldTypeRequiredDescription
idstringYesLength: 4–80
codestringYes

Used by: POST /v1/apps/{appId}/verify/sms/check

CleanupResult

FieldTypeRequiredDescription
deletedintegerYes

Used by: POST /v1/apps/{appId}/subscriptions/cleanup

Company

FieldTypeRequiredDescription
idstringYes
external_idstringYes
namestring | nullYes
domainstring | nullYes
propertiesmap<string, any>Yes
member_countintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/companies, GET /v1/apps/{appId}/companies/{companyId}, PATCH /v1/apps/{appId}/companies/{companyId}

CompanyBatchResult

FieldTypeRequiredDescription
createdintegerYes
updatedintegerYes
dataarray<object>Yes
data[].idstringYes
data[].external_idstringYes
data[].createdbooleanYes

Used by: POST /v1/apps/{appId}/companies/batch

CompanyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].external_idstringYes
data[].namestring | nullYes
data[].domainstring | nullYes
data[].propertiesmap<string, any>Yes
data[].member_countintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/companies

CompanyMember

FieldTypeRequiredDescription
company_idstringYes
user_idstringYes
external_idstring | nullYes
rolestringYes
created_atstringYes
updated_atstringYes

Used by: PUT /v1/apps/{appId}/companies/{companyId}/members/{userId}

CompanyMemberBatchResult

FieldTypeRequiredDescription
addedintegerYes
updatedintegerYes
not_foundarray<object>Yes
not_found[].indexintegerYes
not_found[].user_idstring | nullYes
not_found[].external_idstring | nullYes

Used by: POST /v1/apps/{appId}/companies/{companyId}/members/batch

CompanyMemberList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].company_idstringYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].rolestringYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/companies/{companyId}/members

ContentCard

FieldTypeRequiredDescription
idstringYes
message_idstring | nullYes
typeenumYesValues: "classic", "captioned_image", "image_only"
titlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
button_textstring | nullYes
datamap<string, string>Yes
pinnedbooleanYes
priorityintegerYes
viewedbooleanYes
clickedbooleanYes
expires_atstring | nullYes
created_atstringYes

Used by: POST /sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}

ContentCardList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstring | nullYes
data[].typeenumYesValues: "classic", "captioned_image", "image_only"
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].urlstring | nullYes
data[].image_urlstring | nullYes
data[].button_textstring | nullYes
data[].datamap<string, string>Yes
data[].pinnedbooleanYes
data[].priorityintegerYes
data[].viewedbooleanYes
data[].clickedbooleanYes
data[].expires_atstring | nullYes
data[].created_atstringYes
unviewed_countintegerYes

Used by: GET /sdk/v1/apps/{appId}/users/{userId}/cards

ContentTable

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
key_columnstringYes
columnsarray<string>Yes
row_countintegerYes
versionintegerYes
source_file_namestring | nullYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].key_columnstringYes
data[].columnsarray<string>Yes
data[].row_countintegerYes
data[].versionintegerYes
data[].source_file_namestring | nullYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/content-tables

ContentTableRows

FieldTypeRequiredDescription
columnsarray<string>Yes
key_columnstringYes
totalintegerYes
dataarray<map<string, string>>Yes

Used by: GET /v1/apps/{appId}/content-tables/{tableId}/rows

Conversation

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
statusenumYesValues: "open", "pending", "resolved", "closed"
subscription_idstring | nullYes
subscription_statusstring | nullYes
user_idstring | nullYes
external_idstring | nullYes
contactstringYes
opted_inbooleanYes
last_message_atstringYes
last_inbound_atstring | nullYes
last_directionenum | nullYes
last_message_previewstring | nullYes
unread_countintegerYes
windowobject | nullYes
created_atstringYes
assignee_idstring | nullYes
team_idstring | nullYes
assigned_atstring | nullYes
languagestring | nullYes
bot_activebooleanYes
last_seqintegerYes
visitor_last_read_seqintegerYes
visitor_last_delivered_seqintegerYes
agent_last_read_seqintegerYes
waiting_sincestring | nullYes
first_response_atstring | nullYes
sla_due_atstring | nullYes
resolved_atstring | nullYes
visitorobject | nullYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].typestringYes
data[].actor_typestringYes
data[].actor_idstring | nullYes
data[].datamap<string, any>Yes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/conversations/{conversationId}/activity

ConversationAssignDto

FieldTypeRequiredDescription
assignee_idstring | nullNo
team_idstring | nullNo

Used by: POST /v1/apps/{appId}/conversations/{conversationId}/assign

ConversationContact

FieldTypeRequiredDescription
userobject | nullYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].channelstringYes
subscriptions[].statusstringYes
subscriptions[].token_maskedstring | nullYes
subscriptions[].created_atstringYes
recent_eventsarray<object>Yes
recent_events[].namestringYes
recent_events[].occurred_atstringYes
recent_events[].propertiesmap<string, any>Yes
other_conversationsarray<object>Yes
other_conversations[].idstringYes
other_conversations[].channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
other_conversations[].statusenumYesValues: "open", "pending", "resolved", "closed"
other_conversations[].last_message_atstringYes

Used by: GET /v1/apps/{appId}/conversations/{conversationId}/contact

ConversationMessagePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].directionenumYesValues: "inbound", "outbound"
data[].statusstringYes
data[].bodystring | nullYes
data[].contentmap<string, any>Yes
data[].message_idstring | nullYes
data[].delivery_idstring | nullYes
data[].sent_bystring | nullYes
data[].error_codestring | nullYes
data[].read_atstring | nullYes
data[].created_atstringYes
data[].seqintegerYes
data[].sender_typestringYes
data[].client_message_idstring | nullYes
data[].attachmentsarray<object>Yes
data[].attachments[].idstringYes
data[].attachments[].namestringYes
data[].attachments[].typestringYes
data[].attachments[].sizeintegerYes
data[].quick_repliesarray<object> | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/conversations/{conversationId}/messages

ConversationPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
data[].statusenumYesValues: "open", "pending", "resolved", "closed"
data[].subscription_idstring | nullYes
data[].subscription_statusstring | nullYes
data[].user_idstring | nullYes
data[].external_idstring | nullYes
data[].contactstringYes
data[].opted_inbooleanYes
data[].last_message_atstringYes
data[].last_inbound_atstring | nullYes
data[].last_directionenum | nullYes
data[].last_message_previewstring | nullYes
data[].unread_countintegerYes
data[].windowobject | nullYes
data[].created_atstringYes
data[].assignee_idstring | nullYes
data[].team_idstring | nullYes
data[].assigned_atstring | nullYes
data[].languagestring | nullYes
data[].bot_activebooleanYes
data[].last_seqintegerYes
data[].visitor_last_read_seqintegerYes
data[].visitor_last_delivered_seqintegerYes
data[].agent_last_read_seqintegerYes
data[].waiting_sincestring | nullYes
data[].first_response_atstring | nullYes
data[].sla_due_atstring | nullYes
data[].resolved_atstring | nullYes
data[].visitorobject | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/conversations

ConversationReplyDto

FieldTypeRequiredDescription
textstringNoLength: 1–4096
templateobjectNo
template.namestringYes
template.languagestringYes
template.headerobjectNo
template.body_paramsarray<string>NoItems: 0–20
template.button_paramsarray<object>NoItems: 0–10
template.button_params[].indexintegerYesRange: 0–9
template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
template.button_params[].valuestringYesLength: 1–256
mediaobjectNo
media.typeenumYesValues: "image", "video", "document", "audio"
media.urlstring (url)YesLength: 0–2000
media.filenamestringNoLength: 1–240
interactiveobjectNo
interactive.typeenumYesValues: "button", "list"
interactive.headerstringNoLength: 1–60
interactive.footerstringNoLength: 1–60
interactive.buttonsarray<object>NoItems: 1–3
interactive.buttons[].idstringYesLength: 1–256
interactive.buttons[].titlestringYesLength: 1–20
interactive.listobjectNo
interactive.list.buttonstringYesLength: 1–20
interactive.list.sectionsarray<object>YesItems: 1–10
client_message_idstringNo
sourceenumNoValues: "manual", "canned", "ai_suggestion"

Used by: POST /v1/apps/{appId}/conversations/{conversationId}/messages

ConversationReplyResult

FieldTypeRequiredDescription
message_idstring | nullYes
conversation_messageobjectYes
conversation_message.idstringYes
conversation_message.directionenumYesValues: "inbound", "outbound"
conversation_message.statusstringYes
conversation_message.bodystring | nullYes
conversation_message.contentmap<string, any>Yes
conversation_message.message_idstring | nullYes
conversation_message.delivery_idstring | nullYes
conversation_message.sent_bystring | nullYes
conversation_message.error_codestring | nullYes
conversation_message.read_atstring | nullYes
conversation_message.created_atstringYes
conversation_message.seqintegerYes
conversation_message.sender_typestringYes
conversation_message.client_message_idstring | nullYes
conversation_message.attachmentsarray<object>Yes
conversation_message.attachments[].idstringYes
conversation_message.attachments[].namestringYes
conversation_message.attachments[].typestringYes
conversation_message.attachments[].sizeintegerYes
conversation_message.quick_repliesarray<object> | nullYes

Used by: POST /v1/apps/{appId}/conversations/{conversationId}/messages

ConversationTagsDto

FieldTypeRequiredDescription
addmap<string, string>No
removearray<string>NoItems: 0–50

Used by: POST /v1/apps/{appId}/conversations/{conversationId}/tags

ConversationTagsResult

FieldTypeRequiredDescription
user_idstringYes
tagsmap<string, any>Yes

Used by: POST /v1/apps/{appId}/conversations/{conversationId}/tags

ConversationUpdateDto

FieldTypeRequiredDescription
statusenumYesValues: "open", "pending", "resolved", "closed"

Used by: PATCH /v1/apps/{appId}/conversations/{conversationId}

ConversionsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.conversionsintegerYes
totals.directintegerYes
totals.influencedintegerYes
totals.unattributedintegerYes
totals.revenuenumberYes
previousobject | nullYes
by_campaignarray<object>Yes
by_campaign[].campaign_idstring | nullYes
by_campaign[].namestringYes
by_campaign[].conversionsintegerYes
by_campaign[].directintegerYes
by_campaign[].influencedintegerYes
by_campaign[].unattributedintegerYes
by_campaign[].revenuenumberYes
by_campaign[].sentintegerYes
by_campaign[].conversion_ratenumber | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].conversionsintegerYes
rows[].revenuenumberYes

Used by: GET /v1/apps/{appId}/analytics/conversions

CopyTemplateDto

FieldTypeRequiredDescription
target_app_idstringYesLength: 1–64
namestringNoLength: 2–100

Used by: POST /v1/apps/{appId}/templates/{templateId}/copy_to_app

CreateAdAudienceDto

FieldTypeRequiredDescription
ad_account_idstringYesLength: 1–64
sourceenumYesValues: "segment", "journey"
segment_idstringNoLength: 1–64
namestringYesLength: 1–120
descriptionstringNoLength: 0–500
identifiersarray<enum>NoItems: 1–3
sync_interval_minutesintegerNoRange: 60–360

Used by: POST /v1/apps/{appId}/ads/audiences

CreateAdCampaignDto

FieldTypeRequiredDescription
ad_account_idstringYesLength: 1–64
audience_idstringYesLength: 1–64
namestringYesLength: 1–200
objectiveenumYesValues: "traffic", "conversions", "leads", "awareness"
optimization_goalenumNoValues: "clicks", "landing_page_views", "conversions", "reach", "impressions"
daily_budgetstring | numberYes
start_atstring (date-time)No
end_atstring (date-time)No
countriesarray<string>YesItems: 1–25
statusenumNoValues: "active", "paused"
pixel_idstringNoLength: 1–64
creativeobjectNo
creative.headlinestringYesLength: 1–30
creative.long_headlinestringNoLength: 1–90
creative.primary_textstringYesLength: 1–500
creative.descriptionstringNoLength: 1–90
creative.link_urlstring (uri)Yes
creative.call_to_actionenumYesValues: "LEARN_MORE", "SHOP_NOW", "SIGN_UP", "SUBSCRIBE", "DOWNLOAD", "CONTACT_US", "BOOK_NOW", "GET_OFFER"
creative.image_idstringNoLength: 1–64
creative.square_image_idstringNoLength: 1–64
creative.page_idstringNoLength: 1–64
creative.business_namestringNoLength: 1–25

Used by: POST /v1/apps/{appId}/ads/campaigns

CreateAiAgentDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
channelsarray<enum>NoItems: 0–6
instructionsstringNoLength: 0–4000
faqarray<object>NoItems: 0–50
faq[].questionstringYesLength: 1–300
faq[].answerstringYesLength: 1–1500
toolsarray<object>NoItems: 0–10
tools[].namestringYes
tools[].descriptionstringYesLength: 1–500
tools[].urlstring (uri)YesLength: 0–2000
tools[].paramsarray<object>NoItems: 0–8
tools[].params[].namestringYes
tools[].params[].descriptionstringNoLength: 0–200
tools[].params[].requiredbooleanNo
handoffobjectNo
handoff.keywordsarray<string>NoItems: 0–20
handoff.max_bot_repliesintegerNoRange: 1–50
handoff.on_negative_sentimentbooleanNo
handoff.messagestringNoLength: 0–500
limitsobjectNo
limits.monthly_token_capintegerNoRange: 1000–50000000
limits.max_stepsintegerNoRange: 1–6
ai_sentimentbooleanNo

Used by: POST /v1/apps/{appId}/ai-agents

CreateAppApiKeyDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
scopesarray<enum>YesItems: 1–8
environmentenumNoValues: "live", "test"; Default: "live"
expires_atstring (date-time) | nullNo
ip_allowlistarray<string>NoItems: 0–50

Used by: POST /v1/apps/{appId}/api-keys

CreateAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
slugstringNo
platform_flagsobjectNoDefault: {}
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
default_languagestringNoDefault: "en"; Length: 2–10
timezonestringNoDefault: "UTC"; Length: 1–64

Used by: POST /v1/apps

CreateAppFlagDto

FieldTypeRequiredDescription
keystringYes
namestringYesLength: 1–100
descriptionstring | nullNo
enabledbooleanNo
value_typeenumNoValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>No
off_valueboolean | number | string | array<any> | map<string, any>No
rollout_percentintegerNoRange: 0–100
segment_idstring | nullNo
rollout_schedulearray<object>NoItems: 0–10
rollout_schedule[].atstring (date-time)Yes
rollout_schedule[].percentintegerYesRange: 0–100

Used by: POST /v1/apps/{appId}/feature-flags

CreateBudgetAlertRuleDto

FieldTypeRequiredDescription
namestringYesLength: 1–120
kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
ad_account_idstring | nullNo
campaign_external_idstring | nullNo
thresholdnumberYesRange: −∞–1000000000000
window_daysintegerNoRange: 1–30
recipientsarray<string (email)>NoItems: 0–20
enabledbooleanNo

Used by: POST /v1/apps/{appId}/ads/alert-rules

CreateCatalogDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstringNoLength: 0–500
currencystringNo

Used by: POST /v1/apps/{appId}/catalogs

CreateCategoryDto

FieldTypeRequiredDescription
keystringYesLength: 1–64
namemap<string, string>Yes
descriptionmap<string, string>No
channelsarray<enum> | nullNo
default_opted_inbooleanNo
positionintegerNoRange: 0–1000

Used by: POST /v1/apps/{appId}/categories

CreateCustomAgentDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstringNoLength: 0–300
enabledbooleanNo
instructionsstringNoLength: 0–4000
toolsarray<enum>NoItems: 0–5
scheduleobject | nullNo
limitsobjectNo
limits.max_stepsintegerNoRange: 1–10
limits.monthly_token_capintegerNoRange: 1000–20000000

Used by: POST /v1/apps/{appId}/custom-agents

CreatedApiKey

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
namestringYes
prefixstringYes
scopesarray<string>Yes
last_used_atstring | nullYes
expires_atstring | nullYes
revoked_atstring | nullYes
ip_allowlistarray<string>Yes
rotated_atstring | nullYes
created_bystring | nullYes
created_atstringYes
keystringYes

Used by: POST /v1/apps/{appId}/api-keys, POST /v1/apps/{appId}/api-keys/{keyId}/rotate

CreateDataFeedDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstring | nullNo
url_templatestringYesLength: 1–2048
methodenumNoValues: "GET", "POST"
body_templatestring | nullNo
headersmap<string, string>No
secret_headersmap<string, string>No
cache_ttl_secondsintegerNoRange: 0–86400
timeout_msintegerNoRange: 100–2000
enabledbooleanNo

Used by: POST /v1/apps/{appId}/data-feeds

CreateDataSourceDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
auth_modeenumNoValues: "signature", "token"
mappingobjectNo
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectNo
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
auth_valuestringNoLength: 0–2000
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"

Used by: POST /v1/apps/{appId}/data-pipelines/sources

CreateDataTransformDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstringNoLength: 0–500
enabledbooleanNo
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerNoRange: 0–10000
rulesarray<object>NoItems: 0–50
codestringNoLength: 0–20000
sourcesarray<enum>NoItems: 0–6
event_namesarray<string>NoItems: 0–50

Used by: POST /v1/apps/{appId}/data-pipelines/transforms

CreateDecisionAgentDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
armsarray<object>YesItems: 2–8
arms[].idstringYes
arms[].labelstringYesLength: 1–60
reward_eventsarray<string>YesItems: 1–10
reward_window_hoursintegerNoDefault: 72; Range: 1–720
holdout_percentintegerNoDefault: 10; Range: 0–50
context_predictionstring | nullNo
use_best_channelbooleanNoDefault: false

Used by: POST /v1/apps/{appId}/decision-agents

CreateExportDto

FieldTypeRequiredDescription
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectNoDefault: {}
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64

Used by: POST /v1/apps/{appId}/exports

CreateFormDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectNo
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statusenumNoValues: "active", "archived"

Used by: POST /v1/apps/{appId}/forms

CreateGeofenceDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
latnumberYesRange: -90–90
lngnumberYesRange: -180–180
radius_mintegerYesRange: 100–50000
cooldown_minutesintegerNoRange: 0–10080
enabledbooleanNo

Used by: POST /v1/apps/{appId}/geofences

CreateIdentityKeyDto

FieldTypeRequiredDescription
kidstringNoLength: 1–64
labelstringNoLength: 0–80
public_jwkmap<string, any>No
public_key_pemstringNoLength: 0–4000

Used by: POST /v1/apps/{appId}/identity-keys

CreateInAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
triggersarray<object>YesItems: 1–5
trigger_groupsarray<array<object>>NoItems: 1–10
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
ab_testobjectNo
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanNo
placementstring | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: POST /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/mcp/in-app-drafts

CreateKeywordDto

FieldTypeRequiredDescription
keywordstringYesLength: 1–30
scopeenumNoValues: "org", "app"
channelsarray<enum>NoItems: 1–3
actionsobjectYes
actions.add_tagsmap<string, string>No
actions.remove_tagsarray<string>NoItems: 0–50
actions.eventobjectNo
actions.event.namestringYes
actions.event.propertiesmap<string, string>No
actions.replyobjectNo
actions.reply.textstringYesLength: 1–1600
actions.opt_inbooleanNo
enabledbooleanNo
descriptionstringNoLength: 0–300

Used by: POST /v1/apps/{appId}/sms-keywords

CreateLandingPageDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
slugstringYesLength: 0–80
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
seoobjectNo
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectNo
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullNo

Used by: POST /v1/apps/{appId}/mcp/landing-page-drafts, POST /v1/apps/{appId}/landing-pages

CreateLiveActivityTypeDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
descriptionstringNoLength: 0–300
content_state_schemaobjectYes
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectNo
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 0–50

Used by: POST /v1/apps/{appId}/live-activities/types

CreateLookalikeDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
countrystringYes
rationumberYesRange: 0.01–0.2

Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/lookalikes

CreateMessengerLinkDto

FieldTypeRequiredDescription
channelenumYesValues: "telegram", "viber"
user_idstringNoLength: 1–64
external_idstringNoLength: 1–255
ttl_secondsintegerNoRange: 60–2592000

Used by: POST /v1/apps/{appId}/messenger-links

CreateNotificationDto

FieldTypeRequiredDescription
app_idstringNoLength: 1–∞
idempotency_keystringNoLength: 1–255
targetobjectYes
target.allbooleanNo
target.include_subscription_idsarray<string>NoItems: 0–2000
target.include_external_idsarray<string>NoItems: 0–2000
target.include_aliasesmap<string, array<string>>No
target.included_segmentsarray<string>NoItems: 0–50
target.excluded_segmentsarray<string>NoItems: 0–50
target.filtersanyNo
target.channelsarray<enum>NoItems: 1–∞
target.test_devices_onlybooleanNo
target.email_toarray<string>NoItems: 1–2000
target.include_phone_numbersarray<string>NoItems: 1–2000
headingsmap<string, string>No
contentsmap<string, string>No
subtitlemap<string, string>No
urlstring (url)NoLength: 0–2000
app_urlstring (url)NoLength: 0–2000
datamap<string, string>No
buttonsarray<object>NoItems: 0–3
buttons[].idstringYesLength: 1–64
buttons[].textstringYesLength: 1–100
buttons[].iconstring (url)NoLength: 0–2000
buttons[].urlstring (url)NoLength: 0–2000
big_picturestring (url)NoLength: 0–2000
ios_attachmentsmap<string, string (url)>No
ios_soundstringNoLength: 0–100
ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
ios_badge_countintegerNoRange: 0–99999
ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
ios_categorystringNoLength: 0–100
thread_idstringNoLength: 0–100
ios_relevance_scorenumberNoRange: 0–1
target_content_identifierstringNoLength: 0–200
android_channel_idstringNoLength: 0–100
android_groupstringNoLength: 0–100
android_soundstringNoLength: 0–100
small_iconstringNoLength: 0–100
large_iconstring (url) | stringNo
android_accent_colorstringNo
android_visibility1 | 0 | -1No
ios_carouselarray<object>NoItems: 0–5
ios_carousel[].urlstring (url)YesLength: 0–2000
ios_carousel[].titlestringNoLength: 0–80
android_live_updateobjectNo
android_live_update.progressintegerYesRange: 0–100
android_live_update.ongoingbooleanNo
voipbooleanNo
app_clipbooleanNo
chrome_web_iconstring (url)NoLength: 0–2000
chrome_web_imagestring (url)NoLength: 0–2000
chrome_web_badgestring (url)NoLength: 0–2000
web_push_topicstringNoLength: 0–32
web_buttonsarray<object>NoItems: 0–2
web_buttons[].idstringYesLength: 1–64
web_buttons[].textstringYesLength: 1–100
web_buttons[].iconstring (url)NoLength: 0–2000
web_buttons[].urlstring (url)NoLength: 0–2000
require_interactionbooleanNo
content_availablebooleanNo
mutable_contentbooleanNo
collapse_idstringNoLength: 0–64
priority5 | 10No
ttlintegerNoRange: 60–2419200
send_afterstring (date-time)No
delayed_optionenumNoValues: "timezone", "optimized"
delivery_time_of_daystringNo
template_idstringNo
custom_datamap<string, any>No
email_subjectstringNoLength: 0–998
email_bodystringNoLength: 0–500000
email_mjmlstringNoLength: 0–500000
email_preheaderstringNoLength: 0–500
email_from_namestringNoLength: 0–200
email_from_addressstring (email)NoLength: 0–320
email_reply_to_addressstring (email)NoLength: 0–320
disable_email_click_trackingbooleanNo
sms_fromstringNoLength: 1–20
sms_media_urlsarray<string (url)>NoItems: 1–10
disable_sms_link_shorteningbooleanNo
whatsapp_templateobjectNo
whatsapp_template.namestringYes
whatsapp_template.languagestringYes
whatsapp_template.headerobjectNo
whatsapp_template.body_paramsarray<string>NoItems: 0–20
whatsapp_template.button_paramsarray<object>NoItems: 0–10
whatsapp_template.button_params[].indexintegerYesRange: 0–9
whatsapp_template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
whatsapp_template.button_params[].valuestringYesLength: 1–256
whatsapp_mediaobjectNo
whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
whatsapp_media.urlstring (url)YesLength: 0–2000
whatsapp_media.filenamestringNoLength: 1–240
whatsapp_interactiveobjectNo
whatsapp_interactive.typeenumYesValues: "button", "list"
whatsapp_interactive.headerstringNoLength: 1–60
whatsapp_interactive.footerstringNoLength: 1–60
whatsapp_interactive.buttonsarray<object>NoItems: 1–3
whatsapp_interactive.buttons[].idstringYesLength: 1–256
whatsapp_interactive.buttons[].titlestringYesLength: 1–20
whatsapp_interactive.listobjectNo
whatsapp_interactive.list.buttonstringYesLength: 1–20
whatsapp_interactive.list.sectionsarray<object>YesItems: 1–10
rcs_cardobjectNo
rcs_card.titlemap<string, string>No
rcs_card.descriptionmap<string, string>No
rcs_card.media_urlstring (url)NoLength: 0–2000
rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
rcs_suggestionsarray<object>NoItems: 0–11
rcs_content_sidstringNo
rcs_content_variablesmap<string, string>No
rcs_fallback_textmap<string, string>No
messenger_image_urlstring (url)NoLength: 0–2000
messenger_buttonsarray<object>NoItems: 0–6
add_to_inboxbooleanNo
inbox_ttlintegerNoRange: 60–31536000
content_cardobjectNo
content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content_card.pinnedbooleanNo
content_card.priorityintegerNoRange: 0–100
content_card.button_textmap<string, string>No
frequency_cap_exemptbooleanNo
quiet_hours_exemptbooleanNo
one_per_userbooleanNo
throttle_rate_per_minuteintegerNoRange: 0–1000000
include_unsubscribedbooleanNo
namestringNoLength: 1–200
labelsarray<string>NoItems: 0–10
categorystringNoLength: 1–64
fallback_channelenumNoValues: "sms", "email"
form_factorenumNoValues: "phone", "watch"

Used by: POST /v1/notifications

CreateNotificationResult

FieldTypeRequiredDescription
idstringYes
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
recipients_estimateintegerYes
external_id_missingarray<string>Yes

Used by: POST /v1/notifications, POST /v1/apps/{appId}/mcp/test-sends

CreatePredictionDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
kindenumYesValues: "churn", "event"
event_namesarray<string>NoDefault: []; Items: 0–10
horizon_daysintegerNoDefault: 30; Range: 7–90

Used by: POST /v1/apps/{appId}/predictions

CreatePromoCodeListDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstringNoLength: 0–500
expires_atstring (date-time) | nullNo

Used by: POST /v1/apps/{appId}/promo-code-lists

CreateSavedReportDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>NoDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>NoDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumNoValues: "asc", "desc"; Default: "desc"
definition.limitintegerNoDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No

Used by: POST /v1/apps/{appId}/analytics/reports

CreateSetupAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
platformsarray<enum>YesItems: 1–8
frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
web_integrationenumNoValues: "code", "wordpress"
default_languagestringNoLength: 2–10
timezonestringNoLength: 1–64

Used by: POST /v1/mcp/apps

CreateSiteSearchSourceDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
kindenumYesValues: "sitemap", "urls"
urlstringNoLength: 0–2000
urlsarray<string>NoItems: 1–500
max_pagesintegerNoRange: 1–2000
refresh_hoursinteger | nullNo
enabledbooleanNo

Used by: POST /v1/apps/{appId}/site-search/sources

CreateSqlSegmentDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
descriptionstring | nullNo
querystringYesLength: 1–20000
refresh_interval_minutesinteger | nullNo

Used by: POST /v1/apps/{appId}/sql/segments

CreateSuppressionDto

FieldTypeRequiredDescription
channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
valuestringYesLength: 3–320
reasonenumNoValues: "manual", "bounce", "complaint", "unsubscribe_link", "stop"
expires_atstring (date-time)No
notestringNoLength: 0–500

Used by: POST /v1/apps/{appId}/suppressions

CreateSurveyDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
questionsarray<object>YesItems: 1–10
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].textmap<string, string>Yes
questions[].requiredbooleanNo
questions[].optionsarray<object>NoItems: 0–30
questions[].options[].valuestringYesLength: 1–100
questions[].options[].labelmap<string, string>Yes
questions[].low_labelmap<string, string>No
questions[].high_labelmap<string, string>No
questions[].placeholdermap<string, string>No
settingsobjectNo
settings.thank_youmap<string, string>No
settings.submit_labelmap<string, string>No
settings.write_propertiesbooleanNo
settings.allow_multiplebooleanNo
settings.default_languagestringNoLength: 2–10

Used by: POST /v1/apps/{appId}/mcp/survey-drafts, POST /v1/apps/{appId}/surveys

CreateTemplateDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
channelenum | nullNo
tagsarray<string>NoItems: 0–20
contentobjectYes
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.listobjectNo
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo

Used by: POST /v1/apps/{appId}/templates, POST /v1/apps/{appId}/mcp/template-drafts

CreateWalletTemplateDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
kindenumYesValues: "coupon", "loyalty", "event", "generic"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringNoDefault: "#ffffff"
design.foreground_colorstringNoDefault: "#111111"
design.label_colorstringNoDefault: "#555555"
design.barcodeenumNoValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>NoDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringNoDefault: ""; Length: 0–60
design.fields[].valuestringNoDefault: ""; Length: 0–500
design.fields[].sectionenumNoValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesmap<string, string>No

Used by: POST /v1/apps/{appId}/wallet/templates

CreateWarehouseConnectionDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
typeenumYesValues: "bigquery", "snowflake", "databricks"
configmap<string, any>Yes
credentialsmap<string, any>Yes

Used by: POST /v1/apps/{appId}/warehouse-segments/connections

CreateWarehouseSegmentDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
descriptionstring | nullNo
connection_idstringYesLength: 1–∞
querystringYesLength: 1–20000
id_columnstringYes
id_typeenumNoValues: "external_id", "user_id"
refresh_interval_minutesinteger | nullNo
limitsobjectNo
limits.timeout_secondsintegerNoRange: 10–600
limits.max_rowsintegerNoRange: 1–1000000
limits.max_bytes_billedintegerNoRange: 10485760–10995116277760
limits.max_warehouse_sizeenum | nullNo

Used by: POST /v1/apps/{appId}/warehouse-segments/segments

CreateWarmupPlanDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
kindenumYesValues: "domain", "ip"
targetstringYesLength: 2–253
start_datestringNo
daily_limitsarray<integer>NoItems: 1–120
curveobjectNo
curve.startintegerYesRange: 1–1000000
curve.growthnumberYesRange: 1.05–3
curve.targetintegerYesRange: 1–10000000
provider_sharesobjectNo
provider_shares.gmailnumberYesRange: 0–1
provider_shares.outlooknumberYesRange: 0–1
provider_shares.yahoonumberYesRange: 0–1
provider_shares.othernumberYesRange: 0–1
timezonestringNoLength: 1–64

Used by: POST /v1/apps/{appId}/email-deliverability/warmup-plans

CreateWebCampaignDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
triggerobjectYes
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectNo
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: POST /v1/apps/{appId}/mcp/web-campaign-drafts, POST /v1/apps/{appId}/web-campaigns

CreateWebhookDto

FieldTypeRequiredDescription
urlstringYesLength: 1–2048
descriptionstring | nullNo
eventsarray<enum>YesItems: 1–41
event_filtersobjectNo
event_filters.event_namesarray<string>NoItems: 0–50
batchbooleanNo
headersmap<string, string>No
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo

Used by: POST /v1/apps/{appId}/webhooks

CreateWebPersonalizationDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
changesarray<object>NoItems: 0–20
variantsarray<object>NoItems: 0–4
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
goalobject | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: POST /v1/apps/{appId}/mcp/web-personalization-drafts, POST /v1/apps/{appId}/web-personalizations

CustomAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
instructionsstringYes
toolsarray<enum>Yes
scheduleobject | nullYes
limitsobjectYes
limits.max_stepsintegerYes
limits.monthly_token_capintegerYes
next_run_atstring | nullYes
last_run_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/custom-agents, GET /v1/apps/{appId}/custom-agents/{agentId}, PATCH /v1/apps/{appId}/custom-agents/{agentId}

CustomAgentDraft

FieldTypeRequiredDescription
idstringYes
agent_idstringYes
run_idstringYes
kindenumYesValues: "segment", "campaign"
statusenumYesValues: "pending", "applied", "dismissed"
payloadmap<string, any>Yes
result_idstring | nullYes
decided_atstring | nullYes
created_atstringYes

CustomAgentDraftList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].run_idstringYes
data[].kindenumYesValues: "segment", "campaign"
data[].statusenumYesValues: "pending", "applied", "dismissed"
data[].payloadmap<string, any>Yes
data[].result_idstring | nullYes
data[].decided_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/custom-agents/drafts

CustomAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstringYes
data[].enabledbooleanYes
data[].instructionsstringYes
data[].toolsarray<enum>Yes
data[].scheduleobject | nullYes
data[].limitsobjectYes
data[].limits.max_stepsintegerYes
data[].limits.monthly_token_capintegerYes
data[].next_run_atstring | nullYes
data[].last_run_atstring | nullYes
data[].usageobjectYes
data[].usage.tokens_this_monthintegerYes
data[].usage.period_startstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/custom-agents

CustomAgentRun

FieldTypeRequiredDescription
idstringYes
agent_idstringYes
triggerenumYesValues: "schedule", "manual"
statusenumYesValues: "pending", "running", "succeeded", "failed", "skipped"
stepsarray<object>Yes
steps[].kindenumYesValues: "tool", "finish"
steps[].toolstringNo
steps[].okbooleanNo
steps[].errorstringNo
steps[].duration_msintegerNo
summarystring | nullYes
input_tokensintegerYes
output_tokensintegerYes
errorstring | nullYes
draftsintegerYes
created_atstringYes
started_atstring | nullYes
finished_atstring | nullYes

Used by: POST /v1/apps/{appId}/custom-agents/{agentId}/run

CustomAgentRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].triggerenumYesValues: "schedule", "manual"
data[].statusenumYesValues: "pending", "running", "succeeded", "failed", "skipped"
data[].stepsarray<object>Yes
data[].steps[].kindenumYesValues: "tool", "finish"
data[].steps[].toolstringNo
data[].steps[].okbooleanNo
data[].steps[].errorstringNo
data[].steps[].duration_msintegerNo
data[].summarystring | nullYes
data[].input_tokensintegerYes
data[].output_tokensintegerYes
data[].errorstring | nullYes
data[].draftsintegerYes
data[].created_atstringYes
data[].started_atstring | nullYes
data[].finished_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/custom-agents/runs

CustomDomain

FieldTypeRequiredDescription
idstringYes
kindenumYesValues: "dashboard", "tracking", "preference_center", "status_page", "landing"
hostnamestringYes
statusenumYesValues: "pending", "verified", "active", "failed"
verificationobjectYes
verification.txt_namestringYes
verification.txt_valuestringYes
verification.cname_targetstring | nullYes
last_errorstring | nullYes
last_checked_atstring | nullYes
verified_atstring | nullYes
activated_atstring | nullYes
created_atstringYes

CustomDomainList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kindenumYesValues: "dashboard", "tracking", "preference_center", "status_page", "landing"
data[].hostnamestringYes
data[].statusenumYesValues: "pending", "verified", "active", "failed"
data[].verificationobjectYes
data[].verification.txt_namestringYes
data[].verification.txt_valuestringYes
data[].verification.cname_targetstring | nullYes
data[].last_errorstring | nullYes
data[].last_checked_atstring | nullYes
data[].verified_atstring | nullYes
data[].activated_atstring | nullYes
data[].created_atstringYes

DataFeed

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
url_templatestringYes
methodenumYesValues: "GET", "POST"
body_templatestring | nullYes
headersmap<string, string>Yes
secret_header_namesarray<string>Yes
cache_ttl_secondsintegerYes
timeout_msintegerYes
enabledbooleanYes
liquidstringYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, PATCH /v1/apps/{appId}/data-feeds/{feedId}

DataFeedList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].url_templatestringYes
data[].methodenumYesValues: "GET", "POST"
data[].body_templatestring | nullYes
data[].headersmap<string, string>Yes
data[].secret_header_namesarray<string>Yes
data[].cache_ttl_secondsintegerYes
data[].timeout_msintegerYes
data[].enabledbooleanYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/data-feeds

DataFeedTestResult

FieldTypeRequiredDescription
statusenumYesValues: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error"
http_statusinteger | nullYes
duration_msintegerYes
errorstring | nullYes
urlstring | nullYes
previewanyYes
truncatedbooleanYes
userobject | nullYes

Used by: POST /v1/apps/{appId}/data-feeds/{feedId}/test

DataQuarantineDiscardResult

FieldTypeRequiredDescription
discardedintegerYes

Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/discard

DataQuarantineList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].targetenumYesValues: "event", "person"
data[].sourcestringYes
data[].source_idstring | nullYes
data[].transform_idstring | nullYes
data[].payloadmap<string, any>Yes
data[].error_codeenumYesValues: "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_pathstring | nullYes
data[].error_messagestring | nullYes
data[].statusenumYesValues: "pending", "reprocessed", "discarded"
data[].attemptsintegerYes
data[].created_atstringYes
data[].updated_atstringYes
data[].resolved_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes
pending_totalintegerYes

Used by: GET /v1/apps/{appId}/data-pipelines/quarantine

DataQuarantineReprocessResult

FieldTypeRequiredDescription
reprocessedintegerYes
droppedintegerYes
failedintegerYes

Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/reprocess

DataSource

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/data-pipelines/sources/{sourceId}, PATCH /v1/apps/{appId}/data-pipelines/sources/{sourceId}

DataSourceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].kindenumYesValues: "webhook", "http_pull"
data[].targetenumYesValues: "event", "person"
data[].enabledbooleanYes
data[].auth_modeenumYesValues: "signature", "token"
data[].mappingobjectYes
data[].mapping.records_pathstringNoLength: 1–200
data[].mapping.event_namestringNoLength: 1–100
data[].mapping.event_name_pathstringNoLength: 1–200
data[].mapping.external_id_pathstringNoLength: 1–200
data[].mapping.occurred_at_pathstringNoLength: 1–200
data[].mapping.value_pathstringNoLength: 1–200
data[].mapping.event_id_pathstringNoLength: 1–200
data[].mapping.properties_pathstringNoLength: 1–200
data[].mapping.tags_pathstringNoLength: 1–200
data[].configobjectYes
data[].config.urlstring (uri)NoLength: 0–2000
data[].config.methodenumNoValues: "GET", "POST"
data[].config.headersmap<string, string>No
data[].config.bodystringNoLength: 0–10000
data[].config.interval_minutesintegerNoRange: 5–1440
data[].config.auth_headerstringNo
data[].config.next_cursor_pathstringNoLength: 1–200
data[].config.cursor_paramstringNo
data[].config.resume_cursorbooleanNo
data[].has_secretbooleanYes
data[].webhook_urlstring | nullYes
data[].next_run_atstring | nullYes
data[].last_run_atstring | nullYes
data[].last_statusstring | nullYes
data[].last_errorstring | nullYes
data[].last_statsmap<string, number>Yes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/data-pipelines/sources

DataSourceRunResult

FieldTypeRequiredDescription
statusenumYesValues: "succeeded", "partial", "failed", "skipped"
statsobjectYes
stats.receivedintegerYes
stats.processedintegerYes
stats.droppedintegerYes
stats.quarantinedintegerYes
errorstring | nullYes

Used by: POST /v1/apps/{appId}/data-pipelines/sources/{sourceId}/run

DataSourceWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes
secretstring | nullYes

Used by: POST /v1/apps/{appId}/data-pipelines/sources, POST /v1/apps/{appId}/data-pipelines/sources/{sourceId}/rotate-secret

DataTransform

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerYes
sourcesarray<enum>Yes
event_namesarray<string>Yes
rulesarray<map<string, any>>Yes
codestring | nullYes
error_countintegerYes
last_error_codeenum | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstringYes
data[].enabledbooleanYes
data[].targetenumYesValues: "event", "person"
data[].kindenumYesValues: "rules", "javascript"
data[].positionintegerYes
data[].sourcesarray<enum>Yes
data[].event_namesarray<string>Yes
data[].rulesarray<map<string, any>>Yes
data[].codestring | nullYes
data[].error_countintegerYes
data[].last_error_codeenum | nullYes
data[].last_error_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/data-pipelines/transforms

DataTransformPreview

FieldTypeRequiredDescription
resultsarray<object>Yes
results[].statusenumYesValues: "kept", "dropped", "failed"
results[].recordmap<string, any> | nullYes
results[].transform_idstring | nullYes
results[].error_codeenum | nullYes
results[].error_pathstring | nullYes
results[].error_messagestring | nullYes
results[].logsarray<string>Yes
duration_msintegerYes

Used by: POST /v1/apps/{appId}/data-pipelines/transforms/preview

DecideDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–200

Used by: POST /v1/apps/{appId}/decision-agents/{id}/decide

DecisionAgent

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
reward_eventsarray<string>Yes
reward_window_hoursintegerYes
holdout_percentintegerYes
context_predictionstring | nullYes
use_best_channelbooleanYes
statusenumYesValues: "active", "paused"
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/decision-agents, GET /v1/apps/{appId}/decision-agents/{id}, PATCH /v1/apps/{appId}/decision-agents/{id}

DecisionAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].armsarray<object>Yes
data[].arms[].idstringYes
data[].arms[].labelstringYes
data[].reward_eventsarray<string>Yes
data[].reward_window_hoursintegerYes
data[].holdout_percentintegerYes
data[].context_predictionstring | nullYes
data[].use_best_channelbooleanYes
data[].statusenumYesValues: "active", "paused"
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/decision-agents

DecisionReport

FieldTypeRequiredDescription
agent_idstringYes
daysintegerYes
learnedobjectYes
learned.assignmentsintegerYes
learned.settledintegerYes
learned.rewardsintegerYes
learned.ratenumber | nullYes
holdoutobjectYes
holdout.assignmentsintegerYes
holdout.settledintegerYes
holdout.rewardsintegerYes
holdout.ratenumber | nullYes
liftnumber | nullYes
p_valuenumber | nullYes
significantbooleanYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
arms[].sharenumberYes
arms[].assignmentsintegerYes
arms[].settledintegerYes
arms[].rewardsintegerYes
arms[].ratenumber | nullYes
contextsarray<object>Yes
contexts[].contextstringYes
contexts[].arm_idstringYes
contexts[].settledintegerYes
contexts[].ratenumber | nullYes

Used by: GET /v1/apps/{appId}/decision-agents/{id}/report

DecisionResult

FieldTypeRequiredDescription
arm_idstringYes
labelstringYes
policyenumYesValues: "thompson", "holdout"
contextstringYes

Used by: POST /v1/apps/{appId}/decision-agents/{id}/decide

DeliverabilitySettingsDto

FieldTypeRequiredDescription
bcc_addressstring (email) | nullNo
validationobjectNo
validation.enabledbooleanYes
validation.check_mxbooleanNo
validation.block_disposablebooleanNo
validation.block_rolebooleanNo
verifierobjectNo
verifier.providerenum | nullYes
verifier.api_keystringNoLength: 8–200
volume_spikeobjectNo
volume_spike.multiplierinteger | nullYes
volume_spike.floorinteger | nullYes
max_invalid_rationumber | nullNo
postmasterobjectNo
postmaster.domainstring | nullYes
postmaster.access_tokenstringNoLength: 20–4096

Used by: PUT /v1/apps/{appId}/email-deliverability

Delivery

FieldTypeRequiredDescription
idstringYes
message_idstringYes
subscription_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
providerstring | nullYes
statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
attempt_countintegerYes
provider_message_idstring | nullYes
error_codestring | nullYes
error_messagestring | nullYes
suppression_reasonstring | nullYes
send_afterstring | nullYes
sent_atstring | nullYes
delivered_atstring | nullYes
opened_atstring | nullYes
clicked_atstring | nullYes
failed_atstring | nullYes
created_atstringYes

DeliveryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstringYes
data[].subscription_idstringYes
data[].user_idstring | nullYes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].providerstring | nullYes
data[].statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
data[].attempt_countintegerYes
data[].provider_message_idstring | nullYes
data[].error_codestring | nullYes
data[].error_messagestring | nullYes
data[].suppression_reasonstring | nullYes
data[].send_afterstring | nullYes
data[].sent_atstring | nullYes
data[].delivered_atstring | nullYes
data[].opened_atstring | nullYes
data[].clicked_atstring | nullYes
data[].failed_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/notifications/{messageId}/deliveries, GET /v1/apps/{appId}/campaigns/{campaignId}/deliveries

DiscardQuarantineDto

FieldTypeRequiredDescription
idsarray<string>YesItems: 1–500

Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/discard

EmailAddressCheck

FieldTypeRequiredDescription
okbooleanYes
reasonenum | nullYes
detailstring | nullYes
checksarray<string>Yes
unknownarray<string>Yes

Used by: POST /v1/apps/{appId}/email-deliverability/verify-address

EmailBounceStats

FieldTypeRequiredDescription
daysintegerYes
target_ratenumberYes
suspend_ratenumberYes
rate_7dobjectYes
rate_7d.sentintegerYes
rate_7d.bouncedintegerYes
rate_7d.ratenumber | nullYes
rate_30dobjectYes
rate_30d.sentintegerYes
rate_30d.bouncedintegerYes
rate_30d.ratenumber | nullYes
trendarray<object>Yes
trend[].daystringYes
trend[].sentintegerYes
trend[].bouncedintegerYes
trend[].soft_bouncedintegerYes
trend[].ratenumber | nullYes
by_typeobjectYes
by_type.hardintegerYes
by_type.softintegerYes
by_type.complaintintegerYes
by_type.blocked_before_sendintegerYes
by_reasonarray<object>Yes
by_reason[].codestringYes
by_reason[].countintegerYes
top_domainsarray<object>Yes
top_domains[].domainstringYes
top_domains[].sentintegerYes
top_domains[].bouncedintegerYes
top_domains[].ratenumber | nullYes

Used by: GET /v1/apps/{appId}/email-deliverability/bounces

EmailDeliverabilitySettings

FieldTypeRequiredDescription
bcc_addressstring | nullYes
validationobjectYes
validation.enabledbooleanYes
validation.check_mxbooleanYes
validation.block_disposablebooleanYes
validation.block_rolebooleanYes
verifierobjectYes
verifier.providerenum | nullYes
verifier.has_keybooleanYes
volume_spikeobjectYes
volume_spike.multiplierinteger | nullYes
volume_spike.floorinteger | nullYes
postmasterobjectYes
postmaster.domainstring | nullYes
postmaster.has_tokenbooleanYes
max_invalid_rationumberYes

Used by: GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability

EmailDesign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
subjectstringYes
preheaderstring | nullYes
versionintegerYes
template_idstring | nullYes
template_versioninteger | nullYes
created_bystring | nullYes
updated_bystring | nullYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
issuesarray<object>Yes
issues[].codeenumYesValues: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing"
issues[].severityenumYesValues: "error", "warning"
issues[].block_idstringYes
issues[].modeenumNoValues: "light", "dark"
issues[].rationumberNo
issues[].requirednumberNo
issues[].foregroundstringNo
issues[].backgroundstringNo
warningsarray<string>Yes

EmailDesignPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].subjectstringYes
data[].preheaderstring | nullYes
data[].versionintegerYes
data[].template_idstring | nullYes
data[].template_versioninteger | nullYes
data[].created_bystring | nullYes
data[].updated_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

EmailDesignPreview

FieldTypeRequiredDescription
htmlstringYes
mjmlstringYes
warningsarray<string>Yes
issuesarray<object>Yes
issues[].codeenumYesValues: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing"
issues[].severityenumYesValues: "error", "warning"
issues[].block_idstringYes
issues[].modeenumNoValues: "light", "dark"
issues[].rationumberNo
issues[].requirednumberNo
issues[].foregroundstringNo
issues[].backgroundstringNo

EmailHygieneRun

FieldTypeRequiredDescription
idstringYes
app_idstringYes
statusenumYesValues: "queued", "running", "completed", "failed"
totalintegerYes
processedintegerYes
validintegerYes
invalidintegerYes
unknownintegerYes
reasonsmap<string, integer>Yes
errorstring | nullYes
suppressed_countinteger | nullYes
suppressed_atstring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}

EmailHygieneStart

FieldTypeRequiredDescription
runobjectYes
run.idstringYes
run.app_idstringYes
run.statusenumYesValues: "queued", "running", "completed", "failed"
run.totalintegerYes
run.processedintegerYes
run.validintegerYes
run.invalidintegerYes
run.unknownintegerYes
run.reasonsmap<string, integer>Yes
run.errorstring | nullYes
run.suppressed_countinteger | nullYes
run.suppressed_atstring | nullYes
run.started_atstring | nullYes
run.completed_atstring | nullYes
run.created_atstringYes
run.updated_atstringYes
createdbooleanYes

Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs

EmailHygieneStatus

FieldTypeRequiredDescription
statusobjectYes
status.totalintegerYes
status.validintegerYes
status.invalidintegerYes
status.unknownintegerYes
status.pendingintegerYes
status.uncheckedintegerYes
status.invalid_by_reasonmap<string, integer>Yes
status.unsendableintegerYes
latest_runobject | nullYes

Used by: GET /v1/apps/{appId}/email-deliverability/hygiene

EmailHygieneSuppress

FieldTypeRequiredDescription
suppressedintegerYes
runobjectYes
run.idstringYes
run.app_idstringYes
run.statusenumYesValues: "queued", "running", "completed", "failed"
run.totalintegerYes
run.processedintegerYes
run.validintegerYes
run.invalidintegerYes
run.unknownintegerYes
run.reasonsmap<string, integer>Yes
run.errorstring | nullYes
run.suppressed_countinteger | nullYes
run.suppressed_atstring | nullYes
run.started_atstring | nullYes
run.completed_atstring | nullYes
run.created_atstringYes
run.updated_atstringYes

Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppress

EmailProviderInsights

FieldTypeRequiredDescription
daysintegerYes
providersarray<object>Yes
providers[].providerenumYesValues: "gmail", "outlook", "yahoo", "other"
providers[].sentintegerYes
providers[].deliveredintegerYes
providers[].openedintegerYes
providers[].clickedintegerYes
providers[].bouncedintegerYes
providers[].complainedintegerYes
trendarray<object>Yes
trend[].daystringYes
trend[].providerenumYesValues: "gmail", "outlook", "yahoo", "other"
trend[].sentintegerYes
trend[].deliveredintegerYes
trend[].bouncedintegerYes

Used by: GET /v1/apps/{appId}/email-deliverability/insights

EmailSavedBlock

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "section", "block"
contentobjectYes
created_bystring | nullYes
created_atstringYes

EmailSavedBlockList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].kindenumYesValues: "section", "block"
data[].contentobjectYes
data[].created_bystring | nullYes
data[].created_atstringYes

EmailWarmupPlan

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "domain", "ip"
targetstringYes
start_datestringYes
daily_limitsarray<integer>Yes
provider_sharesmap<string, number>Yes
timezonestringYes
statusenumYesValues: "active", "paused", "completed"
todayobjectYes
today.daystringYes
today.indexintegerYes
today.limitinteger | nullYes
today.usedintegerYes
today.bucketsmap<string, object>Yes
scheduled_aheadintegerYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].kindenumYesValues: "domain", "ip"
data[].targetstringYes
data[].start_datestringYes
data[].daily_limitsarray<integer>Yes
data[].provider_sharesmap<string, number>Yes
data[].timezonestringYes
data[].statusenumYesValues: "active", "paused", "completed"
data[].todayobjectYes
data[].today.daystringYes
data[].today.indexintegerYes
data[].today.limitinteger | nullYes
data[].today.usedintegerYes
data[].today.bucketsmap<string, object>Yes
data[].scheduled_aheadintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/email-deliverability/warmup-plans

EmailWarmupUsage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].daystringYes
data[].bucketstringYes
data[].usedintegerYes
data[].limitinteger | nullYes

Used by: GET /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usage

EndLiveActivityDto

FieldTypeRequiredDescription
activity_idstringYesLength: 1–100
content_statemap<string, string | number | boolean>No
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 0–200

Used by: POST /v1/apps/{appId}/live-activities/{activityType}/end

EngagementReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
timezonestringYes
totalsobjectYes
totals.openedintegerYes
totals.clickedintegerYes
previousobject | nullYes
cellsarray<object>Yes
cells[].weekdayintegerYes
cells[].hourintegerYes
cells[].openedintegerYes
cells[].clickedintegerYes
rowsarray<object>Yes
rows[].datestringYes
rows[].openedintegerYes
rows[].clickedintegerYes

Used by: GET /v1/apps/{appId}/analytics/engagement

EstimateAudienceDto

FieldTypeRequiredDescription
app_idstringNoLength: 1–∞
targetobjectYes
target.allbooleanNo
target.include_subscription_idsarray<string>NoItems: 0–2000
target.include_external_idsarray<string>NoItems: 0–2000
target.include_aliasesmap<string, array<string>>No
target.included_segmentsarray<string>NoItems: 0–50
target.excluded_segmentsarray<string>NoItems: 0–50
target.filtersanyNo
target.channelsarray<enum>NoItems: 1–∞
target.test_devices_onlybooleanNo
target.email_toarray<string>NoItems: 1–2000
target.include_phone_numbersarray<string>NoItems: 1–2000
include_unsubscribedbooleanNo

Used by: POST /v1/notifications/estimate

EstimateAudienceResult

FieldTypeRequiredDescription
recipientsintegerYes
by_channelmap<string, integer>Yes
new_contactsintegerYes
external_id_missingarray<string>Yes

Used by: POST /v1/notifications/estimate

EvaluateAppFlagsDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–255
user_idstringNoLength: 1–64
subjectstringNoLength: 1–128

Used by: POST /v1/apps/{appId}/feature-flags/evaluate

EventDefinition

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
display_namestring | nullYes
properties_schemamap<string, string>Yes
is_conversionbooleanYes
outcome_uniquebooleanYes
outcome_unattributedbooleanYes
retention_daysinteger | nullYes
first_seen_atstringYes
last_seen_atstringYes
count_30dintegerYes
created_atstringYes
updated_atstringYes

Used by: PATCH /v1/apps/{appId}/events/definitions/{name}

EventDefinitionDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
display_namestring | nullYes
properties_schemamap<string, string>Yes
is_conversionbooleanYes
outcome_uniquebooleanYes
outcome_unattributedbooleanYes
retention_daysinteger | nullYes
first_seen_atstringYes
last_seen_atstringYes
count_30dintegerYes
created_atstringYes
updated_atstringYes
dailyarray<object>Yes
daily[].datestringYes
daily[].countintegerYes
daily[].usersintegerYes
propertiesarray<object>Yes
properties[].keystringYes
properties[].typestringYes
properties[].valuesarray<object>Yes
properties[].values[].valuestringYes
properties[].values[].countintegerYes

Used by: GET /v1/apps/{appId}/events/definitions/{name}

EventDefinitionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].display_namestring | nullYes
data[].properties_schemamap<string, string>Yes
data[].is_conversionbooleanYes
data[].outcome_uniquebooleanYes
data[].outcome_unattributedbooleanYes
data[].retention_daysinteger | nullYes
data[].first_seen_atstringYes
data[].last_seen_atstringYes
data[].count_30dintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/events/definitions

EventList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].user_idstring | nullYes
data[].subscription_idstring | nullYes
data[].namestringYes
data[].propertiesmap<string, any>Yes
data[].valuenumber | nullYes
data[].sourceenumYesValues: "sdk", "api", "system", "import"
data[].occurred_atstringYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/events

EventsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-events, POST /sdk/v1/apps/{appId}/events, POST /v1/apps/{appId}/events

EventsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
group_byenumYesValues: "day", "name"
namestring | nullYes
totalsobjectYes
totals.countintegerYes
totals.usersintegerYes
previousobject | nullYes
rowsarray<object>Yes
rows[].keystringYes
rows[].countintegerYes
rows[].usersintegerYes

Used by: GET /v1/apps/{appId}/analytics/events

Export

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectYes
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64
statusenumYesValues: "pending", "running", "completed", "failed"
row_countinteger | nullYes
errorstring | nullYes
download_urlstring | nullYes
expires_atstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
data[].filtersobjectYes
data[].filters.fromstring (date-time)No
data[].filters.tostring (date-time)No
data[].filters.namestringNoLength: 0–100
data[].filters.message_idstringNoLength: 0–64
data[].filters.campaign_idstringNoLength: 0–64
data[].filters.statusstringNoLength: 0–32
data[].filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].filters.segment_idstringNoLength: 0–64
data[].statusenumYesValues: "pending", "running", "completed", "failed"
data[].row_countinteger | nullYes
data[].errorstring | nullYes
data[].download_urlstring | nullYes
data[].expires_atstring | nullYes
data[].requested_bystring | nullYes
data[].created_atstringYes
data[].completed_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/exports

Form

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "active", "archived"
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectYes
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statsobjectYes
stats.submissionsintegerYes
stats.last_submission_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/forms, GET /v1/apps/{appId}/forms/{formId}, PATCH /v1/apps/{appId}/forms/{formId}

FormPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "active", "archived"
data[].fieldsarray<object>YesItems: 1–20
data[].fields[].idstringYes
data[].fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
data[].fields[].labelmap<string, string>Yes
data[].fields[].placeholdermap<string, string>No
data[].fields[].requiredbooleanNo
data[].fields[].optionsarray<object>NoItems: 0–30
data[].fields[].maps_tostringNo
data[].fields[].max_lengthintegerNoRange: 1–2000
data[].fields[].policy_urlstring (url)NoLength: 0–2000
data[].settingsobjectYes
data[].settings.submit_labelmap<string, string>No
data[].settings.success_messagemap<string, string>No
data[].settings.redirect_urlstring (url)NoLength: 0–2000
data[].settings.tagsmap<string, string>No
data[].settings.subscribeobjectNo
data[].settings.double_opt_inobjectNo
data[].settings.event_namestringNo
data[].settings.captchabooleanNo
data[].settings.default_languagestringNoLength: 2–10
data[].statsobjectYes
data[].stats.submissionsintegerYes
data[].stats.last_submission_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/forms

FormSubmission

FieldTypeRequiredDescription
idstringYes
form_idstringYes
user_idstring | nullYes
subscription_idsarray<string>Yes
sourceenumYesValues: "web_campaign", "landing_page", "sdk", "api"
source_idstring | nullYes
statusenumYesValues: "accepted", "pending_confirmation", "confirmed"
datamap<string, string | boolean | array<string>>Yes
consentarray<object>Yes
consent[].field_idstringYes
consent[].givenbooleanYes
consent[].textstringYes
consent[].text_hashstringYes
consent[].policy_urlstring | nullYes
consent[].languagestringYes
consent[].atstringYes
page_urlstring | nullYes
languagestring | nullYes
confirmed_atstring | nullYes
created_atstringYes

FormSubmissionPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].form_idstringYes
data[].user_idstring | nullYes
data[].subscription_idsarray<string>Yes
data[].sourceenumYesValues: "web_campaign", "landing_page", "sdk", "api"
data[].source_idstring | nullYes
data[].statusenumYesValues: "accepted", "pending_confirmation", "confirmed"
data[].datamap<string, string | boolean | array<string>>Yes
data[].consentarray<object>Yes
data[].consent[].field_idstringYes
data[].consent[].givenbooleanYes
data[].consent[].textstringYes
data[].consent[].text_hashstringYes
data[].consent[].policy_urlstring | nullYes
data[].consent[].languagestringYes
data[].consent[].atstringYes
data[].page_urlstring | nullYes
data[].languagestring | nullYes
data[].confirmed_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/forms/{formId}/submissions

FormSubmitResult

FieldTypeRequiredDescription
oktrueYes
statusenumYesValues: "accepted", "pending_confirmation"
submission_idstring | nullYes
success_messagestringYes
redirect_urlstring | nullYes

Used by: POST /sdk/v1/apps/{appId}/forms/{formId}/submissions, POST /v1/apps/{appId}/forms/{formId}/submissions

FunnelBodyDto

FieldTypeRequiredDescription
stepsarray<object>YesItems: 2–8
steps[].namestringYesLength: 1–100
steps[].whereobjectNo
steps[].where.keystringYesLength: 1–64
steps[].where.valuestringYesLength: 0–500
fromstring (date-time)No
tostring (date-time)No
window_hoursintegerNoDefault: 72; Range: 1–720
comparebooleanNoDefault: false
formatenumNoValues: "json", "csv"; Default: "json"

Used by: POST /v1/apps/{appId}/analytics/funnels

FunnelReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
window_hoursintegerYes
stepsarray<object>Yes
steps[].namestringYes
steps[].usersintegerYes
steps[].conversion_ratenumber | nullYes
steps[].drop_offintegerYes
overall_ratenumber | nullYes
previousobject | nullYes

Used by: POST /v1/apps/{appId}/analytics/funnels

Geofence

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
latnumberYes
lngnumberYes
radius_mintegerYes
cooldown_minutesintegerYes
enabledbooleanYes
enter_countintegerYes
exit_countintegerYes
inside_countintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/geofences, GET /v1/apps/{appId}/geofences/{geofenceId}, PATCH /v1/apps/{appId}/geofences/{geofenceId}

GeofenceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].latnumberYes
data[].lngnumberYes
data[].radius_mintegerYes
data[].cooldown_minutesintegerYes
data[].enabledbooleanYes
data[].enter_countintegerYes
data[].exit_countintegerYes
data[].inside_countintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/geofences

GlobalControl

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes

Used by: GET /v1/apps/{appId}/global-control, PUT /v1/apps/{appId}/global-control, POST /v1/apps/{appId}/global-control/reset

GlobalControlReport

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes
fromstringYes
tostringYes
eventsarray<string>Yes
controlobjectYes
control.usersintegerYes
control.convertedintegerYes
control.conversion_ratenumberYes
treatmentobjectYes
treatment.usersintegerYes
treatment.convertedintegerYes
treatment.conversion_ratenumberYes
lift_percentnumber | nullYes
incremental_conversionsintegerYes
p_valuenumber | nullYes
significantbooleanYes
withheld_messagesintegerYes

Used by: GET /v1/apps/{appId}/global-control/report

IdentityKey

FieldTypeRequiredDescription
idstringYes
kidstringYes
alg"ES256"Yes
public_jwkmap<string, string>Yes
labelstring | nullYes
created_atstringYes
revoked_atstring | nullYes

Used by: POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}

IdentityKeyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kidstringYes
data[].alg"ES256"Yes
data[].public_jwkmap<string, string>Yes
data[].labelstring | nullYes
data[].created_atstringYes
data[].revoked_atstring | nullYes

Used by: GET /v1/apps/{appId}/identity-keys

Import

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "legacy_players", "csv_users"
file_namestring | nullYes
statusenumYesValues: "pending", "running", "completed", "failed"
statsobjectYes
stats.processedintegerNo
stats.created_usersintegerNo
stats.updated_usersintegerNo
stats.created_subscriptionsintegerNo
stats.skippedintegerNo
stats.errorsintegerNo
stats.rejected_emailsintegerNo
stats.rejected_email_reasonsmap<string, integer>No
errorstring | nullYes
error_report_urlstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Used by: POST /v1/apps/{appId}/imports, GET /v1/apps/{appId}/imports/{importId}

ImportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "legacy_players", "csv_users"
data[].file_namestring | nullYes
data[].statusenumYesValues: "pending", "running", "completed", "failed"
data[].statsobjectYes
data[].stats.processedintegerNo
data[].stats.created_usersintegerNo
data[].stats.updated_usersintegerNo
data[].stats.created_subscriptionsintegerNo
data[].stats.skippedintegerNo
data[].stats.errorsintegerNo
data[].stats.rejected_emailsintegerNo
data[].stats.rejected_email_reasonsmap<string, integer>No
data[].errorstring | nullYes
data[].error_report_urlstring | nullYes
data[].requested_bystring | nullYes
data[].created_atstringYes
data[].completed_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/imports

InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].triggersarray<object>Yes
data[].trigger_groupsarray<array<object>> | nullYes
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].displayobjectYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstringNo
data[].display.text_colorstringNo
data[].display.dismissiblebooleanNo
data[].display.auto_dismiss_secondsintegerNoRange: 1–120
data[].display.content_typeenumNoValues: "blocks", "html"
data[].display.htmlmap<string, string>No
data[].display.html_heightintegerNoRange: 40–2000
data[].display.blocksarray<object>YesItems: 0–12
data[].audienceobjectYes
data[].audience.included_segmentsarray<string>NoItems: 0–20
data[].audience.excluded_segmentsarray<string>NoItems: 0–20
data[].audience.global_control_exemptbooleanNo
data[].frequencyobjectYes
data[].frequency.max_impressionsintegerNoRange: 1–1000
data[].frequency.min_interval_secondsintegerNoRange: 0–31536000
data[].frequency.stop_after_interactionbooleanNo
data[].journey_onlybooleanYes
data[].placementstring | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.impressionsintegerYes
data[].stats.clicksintegerYes
data[].stats.dismissalsintegerYes
data[].stats.unique_usersintegerYes
data[].stats.ctrnumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].variant_idstringYes
data[].variant_stats[].impressionsintegerYes
data[].variant_stats[].clicksintegerYes
data[].variant_stats[].ctrnumberYes
data[].ab_testobjectYes
data[].ab_test.winnerobjectNo
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/in-app-messages

InAppStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "paused", "archived"

Used by: POST /v1/apps/{appId}/in-app-messages/{messageId}/status

InAppTemplate

FieldTypeRequiredDescription
idstringYes
sourceenumYesValues: "system", "org"
categoryenumYesValues: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom"
namestringYes
descriptionstring | nullYes
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
created_atstring | nullYes
updated_atstring | nullYes

InAppTemplateList

FieldTypeRequiredDescription
gallery_versionstringYes
dataarray<object>Yes
data[].idstringYes
data[].sourceenumYesValues: "system", "org"
data[].categoryenumYesValues: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom"
data[].namestringYes
data[].descriptionstring | nullYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstringNo
data[].display.text_colorstringNo
data[].display.dismissiblebooleanNo
data[].display.auto_dismiss_secondsintegerNoRange: 1–120
data[].display.content_typeenumNoValues: "blocks", "html"
data[].display.htmlmap<string, string>No
data[].display.html_heightintegerNoRange: 40–2000
data[].display.blocksarray<object>YesItems: 0–12
data[].created_atstring | nullYes
data[].updated_atstring | nullYes

InAppWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Used by: POST /v1/apps/{appId}/in-app-messages/{messageId}/winner

InboxAgent

FieldTypeRequiredDescription
account_idstringYes
namestringYes
emailstringYes
rolestringYes
statusenumYesValues: "online", "busy", "offline"
last_heartbeat_atstring | nullYes
max_concurrentinteger | nullYes
languagesarray<string>Yes
open_conversationsintegerYes
team_idsarray<string>Yes

Used by: PATCH /v1/apps/{appId}/inbox/agents/{accountId}

InboxAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].account_idstringYes
data[].namestringYes
data[].emailstringYes
data[].rolestringYes
data[].statusenumYesValues: "online", "busy", "offline"
data[].last_heartbeat_atstring | nullYes
data[].max_concurrentinteger | nullYes
data[].languagesarray<string>Yes
data[].open_conversationsintegerYes
data[].team_idsarray<string>Yes

Used by: GET /v1/apps/{appId}/inbox/agents

InboxItem

FieldTypeRequiredDescription
idstringYes
message_idstring | nullYes
titlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
datamap<string, string>Yes
readbooleanYes
read_atstring | nullYes
archived_atstring | nullYes
expires_atstring | nullYes
created_atstringYes

Used by: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read

InboxMetrics

FieldTypeRequiredDescription
fromstringYes
tostringYes
first_responseobjectYes
first_response.countintegerYes
first_response.avg_secondsnumber | nullYes
first_response.p90_secondsnumber | nullYes
resolutionobjectYes
resolution.countintegerYes
resolution.avg_secondsnumber | nullYes
resolution.p90_secondsnumber | nullYes
slaobjectYes
sla.target_secondsintegerYes
sla.metintegerYes
sla.breachedintegerYes
sla.ratenumber | nullYes
volumeobjectYes
volume.createdintegerYes
volume.resolvedintegerYes
volume.open_nowintegerYes
volume.unassigned_nowintegerYes
volume.by_channelmap<string, integer>Yes
agentsarray<object>Yes
agents[].account_idstringYes
agents[].namestring | nullYes
agents[].first_responseobjectYes
agents[].first_response.countintegerYes
agents[].first_response.avg_secondsnumber | nullYes
agents[].first_response.p90_secondsnumber | nullYes
agents[].resolutionobjectYes
agents[].resolution.countintegerYes
agents[].resolution.avg_secondsnumber | nullYes
agents[].resolution.p90_secondsnumber | nullYes
agents[].resolvedintegerYes
agents[].open_nowintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].createdintegerYes
daily[].resolvedintegerYes
daily[].first_response_avg_secondsnumber | nullYes

Used by: GET /v1/apps/{appId}/inbox/metrics

InboxPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstring | nullYes
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].urlstring | nullYes
data[].image_urlstring | nullYes
data[].datamap<string, string>Yes
data[].readbooleanYes
data[].read_atstring | nullYes
data[].archived_atstring | nullYes
data[].expires_atstring | nullYes
data[].created_atstringYes
unread_countintegerYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /sdk/v1/apps/{appId}/users/{userId}/inbox, GET /v1/apps/{appId}/users/by/{label}/{value}/inbox

InboxReadAllResult

FieldTypeRequiredDescription
updatedintegerYes
unread_countintegerYes

Used by: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all

InboxSettings

FieldTypeRequiredDescription
widgetobjectYes
widget.enabledbooleanNo
widget.colorstringNo
widget.text_colorstringNo
widget.positionenumNoValues: "right", "left"
widget.themeenumNoValues: "light", "dark", "auto"
widget.titlemap<string, string>No
widget.greetingmap<string, string>No
widget.offline_messagemap<string, string>No
widget.collect_email_offlinebooleanNo
widget.attachmentsbooleanNo
widget.require_emailbooleanNo
business_hoursobjectYes
business_hours.enabledbooleanNo
business_hours.timezonestring | nullNo
business_hours.daysarray<object>NoItems: 0–21
business_hours.days[].dayintegerYesRange: 0–6
business_hours.days[].startstringYes
business_hours.days[].endstringYes
business_hours.holidaysarray<string>NoItems: 0–100
routingobjectYes
routing.auto_assignbooleanYes
routing.visibilityenumYesValues: "all", "team", "assigned"
routing.show_unassignedbooleanYes
routing.first_response_sla_secondsintegerYes
routing.max_concurrent_defaultinteger | nullYes
emailobjectYes
email.capture_repliesbooleanYes
email.reply_domainstring | nullYes
timezonestringYes
within_business_hoursbooleanYes
installobjectYes
install.app_idstringYes
install.sdk_urlstringYes
install.api_urlstringYes

Used by: GET /v1/apps/{appId}/inbox/settings, PUT /v1/apps/{appId}/inbox/settings

InboxSettingsUpdateDto

FieldTypeRequiredDescription
widgetobjectNo
widget.enabledbooleanNo
widget.colorstringNo
widget.text_colorstringNo
widget.positionenumNoValues: "right", "left"
widget.themeenumNoValues: "light", "dark", "auto"
widget.titlemap<string, string>No
widget.greetingmap<string, string>No
widget.offline_messagemap<string, string>No
widget.collect_email_offlinebooleanNo
widget.attachmentsbooleanNo
widget.require_emailbooleanNo
business_hoursobjectNo
business_hours.enabledbooleanNo
business_hours.timezonestring | nullNo
business_hours.daysarray<object>NoItems: 0–21
business_hours.days[].dayintegerYesRange: 0–6
business_hours.days[].startstringYes
business_hours.days[].endstringYes
business_hours.holidaysarray<string>NoItems: 0–100
routingobjectNo
routing.auto_assignbooleanNo
routing.visibilityenumNoValues: "all", "team", "assigned"
routing.show_unassignedbooleanNo
routing.first_response_sla_secondsintegerNoRange: 30–604800
routing.max_concurrent_defaultinteger | nullNo
emailobjectNo
email.capture_repliesbooleanNo

Used by: PUT /v1/apps/{appId}/inbox/settings

InboxTeam

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
member_idsarray<string>Yes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/inbox/teams, PATCH /v1/apps/{appId}/inbox/teams/{teamId}

InboxTeamList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].member_idsarray<string>Yes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/inbox/teams

Integration

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
namestringYes
statusenumYesValues: "active", "paused", "error"
settingsmap<string, any>Yes
eventsarray<string>Yes
credentialsmap<string, string>Yes
statemap<string, any>Yes
inbound_urlstring | nullYes
interactions_urlstring | nullYes
pending_eventsintegerYes
dead_eventsintegerYes
hooksintegerYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
last_success_atstring | nullYes
last_run_atstring | nullYes
next_sync_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/integrations/{type}

IntegrationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
data[].namestringYes
data[].statusenumYesValues: "active", "paused", "error"
data[].settingsmap<string, any>Yes
data[].eventsarray<string>Yes
data[].credentialsmap<string, string>Yes
data[].statemap<string, any>Yes
data[].inbound_urlstring | nullYes
data[].interactions_urlstring | nullYes
data[].pending_eventsintegerYes
data[].dead_eventsintegerYes
data[].hooksintegerYes
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].last_success_atstring | nullYes
data[].last_run_atstring | nullYes
data[].next_sync_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
catalogarray<object>Yes
catalog[].typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
catalog[].eventsarray<string>Yes
catalog[].cohortsbooleanYes
catalog[].inboundbooleanYes

Used by: GET /v1/apps/{appId}/integrations

IntegrationOk

FieldTypeRequiredDescription
oktrueYes

Used by: DELETE /v1/apps/{appId}/integrations/zapier/hooks/{hookId}

IntegrationRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kindenumYesValues: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test"
data[].triggerenumYesValues: "schedule", "manual", "event", "inbound"
data[].statusenumYesValues: "running", "succeeded", "partial", "failed"
data[].statsmap<string, number>Yes
data[].errorstring | nullYes
data[].started_atstringYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes

Used by: GET /v1/apps/{appId}/integrations/{type}/runs

IntegrationSyncResult

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes

Used by: POST /v1/apps/{appId}/integrations/{type}/sync

IntegrationTestResult

FieldTypeRequiredDescription
okbooleanYes
errorstring | nullYes
run_idstringYes

Used by: POST /v1/apps/{appId}/integrations/{type}/test

Invite

FieldTypeRequiredDescription
idstringYes
emailstringYes
roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
expires_atstringYes
invited_bystring | nullYes
created_atstringYes

InviteList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].emailstringYes
data[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].expires_atstringYes
data[].invited_bystring | nullYes
data[].created_atstringYes

InvitePreview

FieldTypeRequiredDescription
org_namestringYes
emailstringYes
roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
expires_atstringYes
inviter_namestring | nullYes

InvoiceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].provider_invoice_idstringYes
data[].amountintegerYes
data[].currencystringYes
data[].statusstringYes
data[].pdf_urlstring | nullYes
data[].hosted_urlstring | nullYes
data[].period_startstring | nullYes
data[].period_endstring | nullYes
data[].issued_atstring | nullYes

IssueWalletPassDto

FieldTypeRequiredDescription
template_idstringYesLength: 0–64
external_idstringNoLength: 1–200
barcode_valuestringNoLength: 1–500
valuesmap<string, string>No

Used by: POST /v1/apps/{appId}/wallet/passes

Journey

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes

JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].current_versioninteger | nullYes
data[].draft_versioninteger | nullYes
data[].trigger_kindstring | nullYes
data[].published_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].summaryobjectYes
data[].summary.runs_totalintegerYes
data[].summary.activeintegerYes
data[].summary.completedintegerYes
data[].summary.exitedintegerYes
data[].summary.failedintegerYes
data[].summary.goal_reachedintegerYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/journeys

JourneyPublishResult

FieldTypeRequiredDescription
journeyobjectYes
journey.idstringYes
journey.app_idstringYes
journey.namestringYes
journey.descriptionstring | nullYes
journey.statusenumYesValues: "draft", "active", "paused", "archived"
journey.current_versioninteger | nullYes
journey.draft_versioninteger | nullYes
journey.trigger_kindstring | nullYes
journey.published_atstring | nullYes
journey.created_bystring | nullYes
journey.created_atstringYes
journey.updated_atstringYes
journey.summaryobjectYes
journey.summary.runs_totalintegerYes
journey.summary.activeintegerYes
journey.summary.completedintegerYes
journey.summary.exitedintegerYes
journey.summary.failedintegerYes
journey.summary.goal_reachedintegerYes
versionintegerYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Used by: POST /v1/apps/{appId}/journeys/{journeyId}/publish

JourneyRun

FieldTypeRequiredDescription
idstringYes
journey_idstringYes
versionintegerYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullYes
next_action_atstring | nullYes
entered_atstringYes
completed_atstring | nullYes
exit_reasonstring | nullYes
goal_idstring | nullYes
goal_reached_atstring | nullYes
contextmap<string, any>Yes

JourneyRunDetail

FieldTypeRequiredDescription
idstringYes
journey_idstringYes
versionintegerYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullYes
next_action_atstring | nullYes
entered_atstringYes
completed_atstring | nullYes
exit_reasonstring | nullYes
goal_idstring | nullYes
goal_reached_atstring | nullYes
contextmap<string, any>Yes
journey_namestringYes
stepsarray<object>Yes
steps[].idstringYes
steps[].node_idstringYes
steps[].node_typestringYes
steps[].statusenumYesValues: "completed", "waiting", "failed", "skipped"
steps[].branchstring | nullYes
steps[].resultmap<string, any>Yes
steps[].started_atstringYes
steps[].finished_atstring | nullYes

Used by: GET /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}, DELETE /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}

JourneyRunPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].journey_idstringYes
data[].versionintegerYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullYes
data[].next_action_atstring | nullYes
data[].entered_atstringYes
data[].completed_atstring | nullYes
data[].exit_reasonstring | nullYes
data[].goal_idstring | nullYes
data[].goal_reached_atstring | nullYes
data[].contextmap<string, any>Yes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/journeys/{journeyId}/runs

JourneyStats

FieldTypeRequiredDescription
versioninteger | nullYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
summary.waitingintegerYes
summary.goal_conversion_ratenumberYes
nodesarray<object>Yes
nodes[].node_idstringYes
nodes[].node_typestringYes
nodes[].enteredintegerYes
nodes[].completedintegerYes
nodes[].waiting_nowintegerYes
nodes[].skippedintegerYes
nodes[].failedintegerYes
nodes[].branchesmap<string, integer>Yes
nodes[].messagesmap<string, integer>No
nodes[].variantsarray<object>No
nodes[].variants[].variant_idstringYes
nodes[].variants[].sentintegerYes
nodes[].variants[].openedintegerYes
nodes[].variants[].clickedintegerYes
nodes[].variants[].convertedintegerYes
nodes[].variants[].winnerbooleanYes
goalsarray<object>Yes
goals[].goal_idstringYes
goals[].reachedintegerYes
exit_reasonsmap<string, integer>Yes

Used by: GET /v1/apps/{appId}/journeys/{journeyId}/stats

JourneyTriggerResult

FieldTypeRequiredDescription
enteredbooleanYes
runobject | nullYes
reasonenum | nullYes

Used by: POST /v1/apps/{appId}/journeys/{journeyId}/runs

JourneyVersionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].versionintegerYes
data[].graphmap<string, any>Yes
data[].settingsmap<string, any>Yes
data[].published_atstring | nullYes
data[].published_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/journeys/{journeyId}/versions

LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].slugstringYes
data[].statusenumYesValues: "draft", "published", "archived"
data[].seoobjectYes
data[].seo.titlestringNoLength: 0–120
data[].seo.descriptionstringNoLength: 0–320
data[].seo.og_imagestring (url)NoLength: 0–2000
data[].seo.canonical_urlstring (url)NoLength: 0–2000
data[].seo.noindexbooleanNo
data[].settingsobjectYes
data[].settings.languagestringNoLength: 2–10
data[].settings.form_idstring | nullNo
data[].settings.form_section_idstring | nullNo
data[].settings.cookie_consentobjectNo
data[].settings.web_sdkbooleanNo
data[].settings.favicon_urlstring (url)NoLength: 0–2000
data[].custom_domain_idstring | nullYes
data[].versionintegerYes
data[].published_versioninteger | nullYes
data[].published_atstring | nullYes
data[].has_unpublished_changesbooleanYes
data[].urlstringYes
data[].domain_urlstring | nullYes
data[].statsobjectYes
data[].stats.submissionsintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/landing-pages

LandingPageVersions

FieldTypeRequiredDescription
dataarray<object>Yes
data[].versionintegerYes
data[].published_atstringYes
data[].published_bystring | nullYes

Used by: GET /v1/apps/{appId}/landing-pages/{pageId}/versions

LandingPreviewResult

FieldTypeRequiredDescription
htmlstringYes

LiveActivitySendResult

FieldTypeRequiredDescription
message_idstringYes
activity_idstringYes
eventenumYesValues: "start", "update", "end"
recipients_estimateintegerYes

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

FieldTypeRequiredDescription
oktrueYes

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

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
content_state_schemaobjectYes
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectYes
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 0–50
push_to_start_tokensintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}

LiveActivityTypeList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].content_state_schemaobjectYes
data[].content_state_schema.type"object"Yes
data[].content_state_schema.propertiesmap<string, object>Yes
data[].content_state_schema.requiredarray<string>NoItems: 0–50
data[].attributes_schemaobjectYes
data[].attributes_schema.type"object"Yes
data[].attributes_schema.propertiesmap<string, object>Yes
data[].attributes_schema.requiredarray<string>NoItems: 0–50
data[].push_to_start_tokensintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/live-activities/types

LoginResult

FieldTypeRequiredDescription
mfa_requiredbooleanYes
mfa_tokenstringNo
accountobjectNo
account.idstringYes
account.emailstringYes
account.namestringYes
account.localestringYes
account.timezonestringYes
account.email_verifiedbooleanYes
account.mfa_enabledbooleanYes
account.is_platform_adminbooleanYes
account.has_passwordbooleanYes
account.marketing_opt_inbooleanYes
account.preferencesobjectYes
account.preferences.date_formatenumYesValues: "auto", "dmy", "mdy", "iso"
account.preferences.time_formatenumYesValues: "auto", "24h", "12h"
account.preferences.table_densityenumYesValues: "comfortable", "compact"
account.created_atstringYes

Me

FieldTypeRequiredDescription
accountobjectYes
account.idstringYes
account.emailstringYes
account.namestringYes
account.localestringYes
account.timezonestringYes
account.email_verifiedbooleanYes
account.mfa_enabledbooleanYes
account.is_platform_adminbooleanYes
account.has_passwordbooleanYes
account.marketing_opt_inbooleanYes
account.preferencesobjectYes
account.preferences.date_formatenumYesValues: "auto", "dmy", "mdy", "iso"
account.preferences.time_formatenumYesValues: "auto", "24h", "12h"
account.preferences.table_densityenumYesValues: "comfortable", "compact"
account.created_atstringYes
membershipsarray<object>Yes
memberships[].org_idstringYes
memberships[].org_namestringYes
memberships[].org_slugstringYes
memberships[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
memberships[].app_scopesarray<string>Yes
memberships[].mfa_requiredbooleanYes
admin_mfa_requiredbooleanYes
mock_providers_availablebooleanYes

Member

FieldTypeRequiredDescription
idstringYes
account_idstringYes
emailstringYes
namestringYes
roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
app_scopesarray<string>Yes
app_rolesarray<object>Yes
app_roles[].app_idstringYes
app_roles[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
accepted_atstring | nullYes
created_atstringYes
last_login_atstring | nullYes

MemberList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].account_idstringYes
data[].emailstringYes
data[].namestringYes
data[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].app_scopesarray<string>Yes
data[].app_rolesarray<object>Yes
data[].app_roles[].app_idstringYes
data[].app_roles[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].accepted_atstring | nullYes
data[].created_atstringYes
data[].last_login_atstring | nullYes

Used by: GET /v1/organization/members

Message

FieldTypeRequiredDescription
idstringYes
app_idstringYes
sourceenumYesValues: "campaign", "api", "journey", "test"
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
idempotency_keystring | nullYes
namestring | nullYes
contentmap<string, any>Yes
targetmap<string, any>Yes
optionsmap<string, any>Yes
labelsarray<string>Yes
categorystring | nullYes
template_idstring | nullYes
campaign_idstring | nullYes
variantsarray<object> | nullYes
countsobjectYes
counts.targetedintegerNo
counts.suppressedintegerNo
counts.sentintegerNo
counts.deliveredintegerNo
counts.failedintegerNo
counts.erroredintegerNo
counts.expiredintegerNo
counts.openedintegerNo
counts.clickedintegerNo
counts.convertedintegerNo
counts.bouncedintegerNo
counts.complainedintegerNo
counts.unsubscribedintegerNo
counts.sms_segmentsintegerNo
requested_byobjectYes
requested_by.typeenumYesValues: "api_key", "account", "system"
requested_by.idstringNo
errorstring | nullYes
scheduled_forstring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: GET /v1/notifications/{messageId}, DELETE /v1/notifications/{messageId}

MessageCategory

FieldTypeRequiredDescription
idstringYes
app_idstringYes
keystringYes
namemap<string, string>Yes
descriptionmap<string, string>Yes
channelsarray<string> | nullYes
default_opted_inbooleanYes
positionintegerYes
opted_out_usersintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}

MessageCategoryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].keystringYes
data[].namemap<string, string>Yes
data[].descriptionmap<string, string>Yes
data[].channelsarray<string> | nullYes
data[].default_opted_inbooleanYes
data[].positionintegerYes
data[].opted_out_usersintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/categories

MessageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].sourceenumYesValues: "campaign", "api", "journey", "test"
data[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
data[].idempotency_keystring | nullYes
data[].namestring | nullYes
data[].contentmap<string, any>Yes
data[].targetmap<string, any>Yes
data[].optionsmap<string, any>Yes
data[].labelsarray<string>Yes
data[].categorystring | nullYes
data[].template_idstring | nullYes
data[].campaign_idstring | nullYes
data[].variantsarray<object> | nullYes
data[].countsobjectYes
data[].counts.targetedintegerNo
data[].counts.suppressedintegerNo
data[].counts.sentintegerNo
data[].counts.deliveredintegerNo
data[].counts.failedintegerNo
data[].counts.erroredintegerNo
data[].counts.expiredintegerNo
data[].counts.openedintegerNo
data[].counts.clickedintegerNo
data[].counts.convertedintegerNo
data[].counts.bouncedintegerNo
data[].counts.complainedintegerNo
data[].counts.unsubscribedintegerNo
data[].counts.sms_segmentsintegerNo
data[].requested_byobjectYes
data[].requested_by.typeenumYesValues: "api_key", "account", "system"
data[].requested_by.idstringNo
data[].errorstring | nullYes
data[].scheduled_forstring | nullYes
data[].started_atstring | nullYes
data[].completed_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/notifications, GET /v1/apps/{appId}/campaigns/{campaignId}/messages

MessagesReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
group_byenumYesValues: "day", "channel", "campaign"
totalsobjectYes
totals.sentintegerYes
totals.deliveredintegerYes
totals.failedintegerYes
totals.openedintegerYes
totals.clickedintegerYes
totals.convertedintegerYes
totals.delivery_ratenumber | nullYes
totals.open_ratenumber | nullYes
totals.click_ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].keystringYes
rows[].labelstringYes
rows[].sentintegerYes
rows[].deliveredintegerYes
rows[].failedintegerYes
rows[].openedintegerYes
rows[].clickedintegerYes
rows[].convertedintegerYes

Used by: GET /v1/apps/{appId}/analytics/messages

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "telegram", "viber"
user_idstringYes
urlstringYes
tokenstringYes
expires_atstringYes

Used by: POST /v1/apps/{appId}/messenger-links

MfaSetup

FieldTypeRequiredDescription
secretstringYes
otpauth_uristringYes

OAuthApproveResult

FieldTypeRequiredDescription
redirect_tostringYes

OAuthConsentContext

FieldTypeRequiredDescription
clientobjectYes
client.client_idstringYes
client.client_namestringYes
client.client_uristring | nullYes
client.redirect_hoststringYes
requested_scopesarray<string>Yes
available_scopesarray<string>Yes
deny_urlstringYes
organizationsarray<object>Yes
organizations[].idstringYes
organizations[].namestringYes
organizations[].slugstringYes
organizations[].rolestringYes
organizations[].org_wide_allowedbooleanYes
organizations[].grantable_scopesarray<string>Yes
organizations[].appsarray<object>Yes
organizations[].apps[].idstringYes
organizations[].apps[].namestringYes

Ok

FieldTypeRequiredDescription
oktrueYes

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

FieldTypeRequiredDescription
button_idstringNoLength: 0–64

Used by: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened

Org

FieldTypeRequiredDescription
idstringYes
namestringYes
slugstringYes
plan_codestringYes
statusenumYesValues: "active", "suspended", "deleted"
settingsobjectYes
settings.mfaRequiredbooleanNo
settings.ipAllowlistarray<string>NoItems: 0–50
settings.retentionDaysintegerNoRange: 7–3650
settings.sessionMaxHoursintegerNoRange: 1–2160
settings.auditStreamobjectNo
settings.auditStream.s3booleanNo
settings.auditStream.webhookAppIdstring | nullNo
created_atstringYes
regionstring | nullYes
managed_by_resellerbooleanYes

Used by: GET /v1/organization

OrgDataExport

FieldTypeRequiredDescription
dataarray<object>Yes
data[].app_idstringYes
data[].app_namestringYes
data[].export_idsarray<string>Yes

OrgList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].slugstringYes
data[].plan_codestringYes
data[].statusenumYesValues: "active", "suspended", "deleted"
data[].settingsobjectYes
data[].settings.mfaRequiredbooleanNo
data[].settings.ipAllowlistarray<string>NoItems: 0–50
data[].settings.retentionDaysintegerNoRange: 7–3650
data[].settings.sessionMaxHoursintegerNoRange: 1–2160
data[].settings.auditStreamobjectNo
data[].created_atstringYes
data[].regionstring | nullYes
data[].managed_by_resellerbooleanYes
data[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].app_scopesarray<string>Yes

OrgNotificationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kindenumYesValues: "channel_invalid", "channel_expiring", "campaign_approval", "message_failed", "export_ready", "import_finished", "webhook_unhealthy"
data[].severityenumYesValues: "error", "warning", "info", "success"
data[].app_idstringYes
data[].app_namestringYes
data[].titlestringYes
data[].detailstring | nullYes
data[].target_idstring | nullYes
data[].atstringYes

OverageChargeList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].period_startstringYes
data[].period_endstringYes
data[].providerstringYes
data[].plan_codestringYes
data[].currencystringYes
data[].amountintegerYes
data[].statusenumYesValues: "pending", "invoiced", "awaiting_payment", "paid", "failed", "waived"
data[].linesarray<object>Yes
data[].lines[].metricstringYes
data[].lines[].includednumberYes
data[].lines[].usednumberYes
data[].lines[].billablenumberYes
data[].lines[].amountintegerYes
data[].lines[].descriptionstringYes
data[].charged_atstring | nullYes
data[].paid_atstring | nullYes
data[].created_atstringYes

OverviewStats

FieldTypeRequiredDescription
rangeenumYesValues: "7d", "30d", "custom"
fromstringYes
tostringYes
kpisobjectYes
kpis.sentintegerYes
kpis.deliveredintegerYes
kpis.failedintegerYes
kpis.openedintegerYes
kpis.clickedintegerYes
kpis.delivery_ratenumber | nullYes
kpis.open_ratenumber | nullYes
kpis.click_ratenumber | nullYes
kpis.active_subscriptionsintegerYes
kpis.new_subscriptionsintegerYes
kpis.opt_outsintegerYes
seriesarray<object>Yes
series[].datestringYes
series[].sentintegerYes
series[].deliveredintegerYes
series[].failedintegerYes
series[].openedintegerYes
recent_messagesarray<object>Yes
recent_messages[].idstringYes
recent_messages[].app_idstringYes
recent_messages[].sourceenumYesValues: "campaign", "api", "journey", "test"
recent_messages[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
recent_messages[].idempotency_keystring | nullYes
recent_messages[].namestring | nullYes
recent_messages[].contentmap<string, any>Yes
recent_messages[].targetmap<string, any>Yes
recent_messages[].optionsmap<string, any>Yes
recent_messages[].labelsarray<string>Yes
recent_messages[].categorystring | nullYes
recent_messages[].template_idstring | nullYes
recent_messages[].campaign_idstring | nullYes
recent_messages[].variantsarray<object> | nullYes
recent_messages[].countsobjectYes
recent_messages[].counts.targetedintegerNo
recent_messages[].counts.suppressedintegerNo
recent_messages[].counts.sentintegerNo
recent_messages[].counts.deliveredintegerNo
recent_messages[].counts.failedintegerNo
recent_messages[].counts.erroredintegerNo
recent_messages[].counts.expiredintegerNo
recent_messages[].counts.openedintegerNo
recent_messages[].counts.clickedintegerNo
recent_messages[].counts.convertedintegerNo
recent_messages[].counts.bouncedintegerNo
recent_messages[].counts.complainedintegerNo
recent_messages[].counts.unsubscribedintegerNo
recent_messages[].counts.sms_segmentsintegerNo
recent_messages[].requested_byobjectYes
recent_messages[].requested_by.typeenumYesValues: "api_key", "account", "system"
recent_messages[].requested_by.idstringNo
recent_messages[].errorstring | nullYes
recent_messages[].scheduled_forstring | nullYes
recent_messages[].started_atstring | nullYes
recent_messages[].completed_atstring | nullYes
recent_messages[].created_atstringYes
recent_messages[].updated_atstringYes
recent_campaignsarray<object>Yes
recent_campaigns[].idstringYes
recent_campaigns[].namestringYes
recent_campaigns[].typestringYes
recent_campaigns[].statusstringYes
recent_campaigns[].sentintegerYes
recent_campaigns[].openedintegerYes
recent_campaigns[].clickedintegerYes
recent_campaigns[].updated_atstringYes
top_errorsarray<object>Yes
top_errors[].codestringYes
top_errors[].countintegerYes
channelsarray<object>Yes
channels[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channels[].providerenum | nullYes
channels[].statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
channels[].last_errorstring | nullYes
channels[].active_subscriptionsintegerYes

Used by: GET /v1/apps/{appId}/analytics/overview

PatchEventDefinitionDto

FieldTypeRequiredDescription
display_namestring | nullNo
is_conversionbooleanNo
outcome_uniquebooleanNo
outcome_unattributedbooleanNo
retention_daysinteger | nullNo

Used by: PATCH /v1/apps/{appId}/events/definitions/{name}

PatchSubscriptionDto

FieldTypeRequiredDescription
tokenstringNoLength: 1–4096
deviceobjectNo
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
statusenumNoValues: "subscribed", "unsubscribed"
test_devicebooleanNo
test_device_namestringNoLength: 0–100

Used by: PATCH /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}

PatchUserDto

FieldTypeRequiredDescription
propertiesmap<string, any>No
tagsmap<string, string | null>No
deltasobjectNo
deltas.session_countintegerNoRange: -1000000–1000000
deltas.session_timeintegerNoRange: 0–31536000
deltas.purchasesarray<object>NoItems: 0–100
deltas.purchases[].skustringYesLength: 1–100
deltas.purchases[].amountnumberYesRange: 0–∞
deltas.purchases[].isostringNoLength: 3–3
deltas.purchases[].countintegerNoDefault: 1; Range: 1–1000

Used by: PATCH /v1/apps/{appId}/users/by/{label}/{value}

PathBodyDto

FieldTypeRequiredDescription
eventstringYesLength: 1–100
directionenumNoValues: "after", "before"; Default: "after"
depthintegerNoDefault: 3; Range: 1–5
topintegerNoDefault: 5; Range: 2–10
window_hoursintegerNoDefault: 24; Range: 1–720
excludearray<string>NoDefault: []; Items: 0–20
fromstring (date-time)No
tostring (date-time)No
formatenumNoValues: "json", "csv"; Default: "json"

Used by: POST /v1/apps/{appId}/analytics/paths

PathReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
eventstringYes
directionenumYesValues: "after", "before"
window_hoursintegerYes
total_usersintegerYes
truncatedbooleanYes
levelsarray<object>Yes
levels[].stepintegerYes
levels[].nodesarray<object>Yes
levels[].nodes[].idstringYes
levels[].nodes[].namestring | nullYes
levels[].nodes[].kindenumYesValues: "event", "other", "end"
levels[].nodes[].usersintegerYes
levels[].nodes[].sharenumberYes
linksarray<object>Yes
links[].sourcestringYes
links[].targetstringYes
links[].usersintegerYes
top_pathsarray<object>Yes
top_paths[].patharray<string>Yes
top_paths[].usersintegerYes
top_paths[].sharenumberYes

Used by: POST /v1/apps/{appId}/analytics/paths

PlanList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].codestringYes
data[].namestringYes
data[].monthly_priceintegerYes
data[].currencystringYes
data[].pricesobjectNo
data[].prices.USDintegerYes
data[].prices.TRYintegerYes
data[].positionintegerYes
data[].is_publicbooleanYes
data[].limitsobjectYes
data[].limits.subscriptionsinteger | nullYes
data[].limits.messages_per_monthinteger | nullYes
data[].limits.api_rpsinteger | nullYes
data[].limits.membersinteger | nullYes
data[].limits.appsinteger | nullYes
data[].limits.retention_daysinteger | nullYes
data[].limits.journeysinteger | nullYes
data[].limits.segmentsinteger | nullYes
data[].limits.ab_variantsinteger | nullYes
data[].limits.tags_per_userinteger | nullYes
data[].limits.aliases_per_userinteger | nullYes
data[].limits.subscriptions_per_userinteger | nullYes
data[].limits.report_history_daysinteger | nullYes
data[].limits.webhooksinteger | nullYes
data[].limits.api_keysinteger | nullYes
data[].limits.mauinteger | nullNo
data[].limits.emails_per_monthinteger | nullNo
data[].limits.sms_per_monthinteger | nullNo
data[].limits.whatsapp_conversations_per_monthinteger | nullNo
data[].limits.rcs_messages_per_monthinteger | nullNo
data[].limits.ai_credits_per_monthinteger | nullNo
data[].limits.data_feedsinteger | nullNo
data[].limits.content_tablesinteger | nullNo
data[].limits.event_streamsinteger | nullNo
data[].limits.warehouse_destinationsinteger | nullNo
data[].limits.custom_domainsinteger | nullNo
data[].featuresobjectYes
data[].features.journeysbooleanYes
data[].features.ab_testingbooleanYes
data[].features.emailbooleanYes
data[].features.smsbooleanYes
data[].features.in_appbooleanYes
data[].features.approval_flowbooleanYes
data[].features.ssobooleanYes
data[].features.scimbooleanNo
data[].features.audit_exportbooleanYes
data[].features.white_labelbooleanNo
data[].features.hide_powered_bybooleanNo
data[].features.resellerbooleanNo
data[].features.whatsappbooleanNo
data[].features.rcsbooleanNo
data[].features.live_activitiesbooleanNo
data[].features.inboxbooleanNo
data[].features.ai_assistantbooleanNo
data[].features.dynamic_contentbooleanNo
data[].features.event_streamsbooleanNo
data[].features.warehouse_exportbooleanNo
data[].features.custom_domainbooleanNo
data[].features.data_residencybooleanNo
data[].features.priority_supportbooleanNo
data[].features.mcp_serverbooleanNo
data[].features.overagebooleanNo
data[].features.rolesarray<string>Yes
data[].purchasablebooleanYes

PortalResult

FieldTypeRequiredDescription
urlstringYes

PostmasterStats

FieldTypeRequiredDescription
domainstring | nullYes
dataarray<object>Yes
data[].daystringYes
data[].domain_reputationstring | nullYes
data[].spam_ratestring | nullYes

Used by: GET /v1/apps/{appId}/email-deliverability/postmaster, POST /v1/apps/{appId}/email-deliverability/postmaster/sync

PredictionModel

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "churn", "event"
event_namesarray<string>Yes
horizon_daysintegerYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
outcomeenum | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes
metricsobject | nullYes
distributionarray<object>Yes
distribution[].bucketenumYesValues: "low", "medium", "high"
distribution[].usersintegerYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].kindenumYesValues: "churn", "event"
data[].event_namesarray<string>Yes
data[].horizon_daysintegerYes
data[].enabledbooleanYes
data[].statusenumYesValues: "idle", "queued", "running", "failed"
data[].outcomeenum | nullYes
data[].last_computed_atstring | nullYes
data[].scored_usersintegerYes
data[].metricsobject | nullYes
data[].distributionarray<object>Yes
data[].distribution[].bucketenumYesValues: "low", "medium", "high"
data[].distribution[].usersintegerYes

Used by: GET /v1/apps/{appId}/predictions

PredictionUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].scoreintegerYes
data[].bucketenumYesValues: "low", "medium", "high"
next_cursorstring | nullYes

Used by: GET /v1/apps/{appId}/predictions/{id}/users

PreviewDataTransformDto

FieldTypeRequiredDescription
targetenumYesValues: "event", "person"
sourceenumNoValues: "sdk", "api", "import", "system", "webhook_source", "pull_source"
recordsarray<map<string, any>>YesItems: 1–20
transformobjectNo
transform.kindenumYesValues: "rules", "javascript"
transform.rulesarray<object>NoItems: 0–50
transform.codestringNoLength: 0–20000
transform.sourcesarray<enum>NoItems: 0–6
transform.event_namesarray<string>NoItems: 0–50
transform_idstringNo

Used by: POST /v1/apps/{appId}/data-pipelines/transforms/preview

PreviewWarehouseQueryDto

FieldTypeRequiredDescription
connection_idstringYesLength: 1–∞
querystringYesLength: 1–20000
id_columnstringYes
id_typeenumNoValues: "external_id", "user_id"
limitsobjectNo
limits.timeout_secondsintegerNoRange: 10–600
limits.max_rowsintegerNoRange: 1–1000000
limits.max_bytes_billedintegerNoRange: 10485760–10995116277760
limits.max_warehouse_sizeenum | nullNo
modeenumNoValues: "dry_run", "sample"

Used by: POST /v1/apps/{appId}/warehouse-segments/preview

PromoCodeList

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
expires_atstring | nullYes
total_countintegerYes
assigned_countintegerYes
available_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].expires_atstring | nullYes
data[].total_countintegerYes
data[].assigned_countintegerYes
data[].available_countintegerYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/promo-code-lists

PromoCodesPage

FieldTypeRequiredDescription
totalintegerYes
dataarray<object>Yes
data[].codestringYes
data[].delivery_idstring | nullYes
data[].message_idstring | nullYes
data[].assigned_atstring | nullYes

Used by: GET /v1/apps/{appId}/promo-code-lists/{listId}/codes

PromoCodeUploadResult

FieldTypeRequiredDescription
listobjectYes
list.idstringYes
list.app_idstringYes
list.namestringYes
list.descriptionstring | nullYes
list.expires_atstring | nullYes
list.total_countintegerYes
list.assigned_countintegerYes
list.available_countintegerYes
list.liquidstringYes
list.created_atstringYes
list.updated_atstringYes
addedintegerYes
skippedintegerYes

Used by: POST /v1/apps/{appId}/promo-code-lists/{listId}/codes

ProvidersReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.sentintegerYes
totals.failedintegerYes
totals.failure_ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].channelstringYes
rows[].providerstring | nullYes
rows[].sentintegerYes
rows[].failedintegerYes
rows[].failure_ratenumber | nullYes
rows[].latency_p50_msnumber | nullYes
rows[].latency_p95_msnumber | nullYes
rows[].errorsarray<object>Yes
rows[].errors[].codestringYes
rows[].errors[].countintegerYes

Used by: GET /v1/apps/{appId}/analytics/providers

PublicCleanupSubscriptionsDto

FieldTypeRequiredDescription
statusenumNoValues: "invalid", "unsubscribed"

Used by: POST /v1/apps/{appId}/subscriptions/cleanup

PublicFormSubmitDto

FieldTypeRequiredDescription
valuesmap<string, string | boolean | number | array<string>>Yes
external_idstringNoLength: 1–128
page_urlstringNoLength: 0–2000
languagestringNoLength: 2–10

Used by: POST /v1/apps/{appId}/forms/{formId}/submissions

PublicSurveyResponseDto

FieldTypeRequiredDescription
answersmap<string, string | boolean | number | array<string>>Yes
external_idstringNoLength: 1–128

Used by: POST /v1/apps/{appId}/surveys/{surveyId}/responses

PutSiteSearchDocumentDto

FieldTypeRequiredDescription
urlstringYesLength: 0–2000
titlestringNoLength: 0–300
contentstringNoLength: 0–300000
htmlstringNoLength: 0–900000
languagestringNo

Used by: PUT /v1/apps/{appId}/site-search/documents/{documentKey}

ReceivedDto

FieldTypeRequiredDescription
received_atstring (date-time)No
deprioritizedbooleanNo

Used by: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/received

RecentEvents

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].user_idstring | nullYes
data[].subscription_idstring | nullYes
data[].namestringYes
data[].propertiesmap<string, any>Yes
data[].valuenumber | nullYes
data[].sourceenumYesValues: "sdk", "api", "system", "import"
data[].occurred_atstringYes

Used by: GET /v1/apps/{appId}/events/recent

RecommendationConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
view_eventsarray<string>Yes
purchase_eventsarray<string>Yes
item_propertystringYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_itemsintegerYes
scored_usersintegerYes

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

FieldTypeRequiredDescription
strategyenumYesValues: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals"
sourceenum | nullYes
dataarray<object>Yes
data[].idstringYes
data[].titlestringYes
data[].descriptionstring | nullYes
data[].image_urlstring | nullYes
data[].urlstring | nullYes
data[].pricenumber | nullYes
data[].sale_pricenumber | nullYes
data[].currencystringYes
data[].categorystring | nullYes
data[].brandstring | nullYes
data[].in_stockbooleanYes
data[].attributesmap<string, string>Yes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/catalogs/{catalogId}/recommendations

RecoveryCodes

FieldTypeRequiredDescription
recovery_codesarray<string>Yes

RenderPreview

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
languagestringYes
titlestring | nullYes
subtitlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
icon_urlstring | nullYes
buttonsarray<object>Yes
buttons[].idstringYes
buttons[].textstringYes
buttons[].urlstring | nullYes
datamap<string, string>Yes
warningsarray<string>Yes
emailobject | nullNo
smsobject | nullNo

Used by: POST /v1/apps/{appId}/templates/{templateId}/render

RenderTemplateDto

FieldTypeRequiredDescription
channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"; Default: "ios_push"
languagestringNoLength: 2–10
userobjectNo
user.external_idstringNoLength: 0–255
user.tagsmap<string, string>No
user.propertiesmap<string, any>No
custom_datamap<string, any>No
contentobjectNo
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.listobjectNo
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo
versionintegerNoRange: 1–∞

Used by: POST /v1/apps/{appId}/templates/{templateId}/render

ReportResult

FieldTypeRequiredDescription
fromstringYes
tostringYes
columnsarray<object>Yes
columns[].keystringYes
columns[].kindenumYesValues: "dimension", "metric"
columns[].formatenumYesValues: "text", "date", "number", "percent"
rowsarray<map<string, string | number | null>>Yes
totalsmap<string, number | null> | nullYes
truncatedbooleanYes

Used by: POST /v1/apps/{appId}/analytics/reports/run

ReportRunBodyDto

FieldTypeRequiredDescription
sourceenumYesValues: "deliveries", "events", "conversions"
metricsarray<enum>YesItems: 1–8
dimensionsarray<enum>NoDefault: []; Items: 0–2
filtersmap<string, array<string>>NoDefault: {}
sortobjectNo
sort.bystringYesLength: 0–64
sort.directionenumNoValues: "asc", "desc"; Default: "desc"
limitintegerNoDefault: 100; Range: 1–1000
daysintegerNoRange: 1–730
fromstring (date-time)No
tostring (date-time)No
formatenumNoValues: "json", "csv"; Default: "json"

Used by: POST /v1/apps/{appId}/analytics/reports/run

ReprocessQuarantineDto

FieldTypeRequiredDescription
idsarray<string>NoItems: 1–500

Used by: POST /v1/apps/{appId}/data-pipelines/quarantine/reprocess

RequestLog

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
api_key_idstring | nullYes
methodstringYes
pathstringYes
routestring | nullYes
statusintegerYes
duration_msintegerYes
request_idstring | nullYes
ipstring | nullYes
error_codestring | nullYes
created_atstringYes

RequestLogPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].api_key_idstring | nullYes
data[].methodstringYes
data[].pathstringYes
data[].routestring | nullYes
data[].statusintegerYes
data[].duration_msintegerYes
data[].request_idstring | nullYes
data[].ipstring | nullYes
data[].error_codestring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/organization/logs

ResellerChildOrg

FieldTypeRequiredDescription
idstringYes
namestringYes
slugstringYes
plan_codestringYes
statusenumYesValues: "active", "suspended", "deleted"
suspended_reasonstring | nullYes
membersnumberYes
accessenumYesValues: "owner", "member", "support", "none"
regionstring | nullYes
created_atstringYes

ResellerChildOrgList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].slugstringYes
data[].plan_codestringYes
data[].statusenumYesValues: "active", "suspended", "deleted"
data[].suspended_reasonstring | nullYes
data[].membersnumberYes
data[].accessenumYesValues: "owner", "member", "support", "none"
data[].regionstring | nullYes
data[].created_atstringYes

ResellerStatement

FieldTypeRequiredDescription
monthstringYes
currencystringYes
itemsarray<object>Yes
items[].org_idstringYes
items[].namestringYes
items[].slugstringYes
items[].plan_codestringYes
items[].statusstringYes
items[].amountnumberYes
items[].messages_sentnumberYes
items[].events_ingestednumberYes
items[].api_requestsnumberYes
items[].active_subscriptionsnumberYes
items[].maunumberYes
totalsobjectYes
totals.amountnumberYes
totals.messages_sentnumberYes
totals.events_ingestednumberYes
totals.child_orgsnumberYes

RetentionReport

FieldTypeRequiredDescription
weeksintegerYes
cohortsarray<object>Yes
cohorts[].weekstringYes
cohorts[].usersintegerYes
cohorts[].retentionarray<number | null>Yes
averagearray<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

FieldTypeRequiredDescription
idstringYes
sync_idstringYes
triggerenumYesValues: "schedule", "manual"
statusenumYesValues: "queued", "running", "succeeded", "failed"
row_countintegerYes
attemptintegerYes
errorstring | nullYes
started_atstring | nullYes
finished_atstring | nullYes
duration_msinteger | nullYes
created_atstringYes

Used by: POST /v1/apps/{appId}/reverse-etl/{syncId}/run

ReverseEtlRunPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].sync_idstringYes
data[].triggerenumYesValues: "schedule", "manual"
data[].statusenumYesValues: "queued", "running", "succeeded", "failed"
data[].row_countintegerYes
data[].attemptintegerYes
data[].errorstring | nullYes
data[].started_atstring | nullYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/reverse-etl/{syncId}/runs

ReverseEtlSync

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
sourceenumYesValues: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub"
targetenumYesValues: "event", "user"
configmap<string, any>Yes
credentials_hintstringYes
scheduleenumYesValues: "every_5_minutes", "hourly", "daily"
enabledbooleanYes
statusenumYesValues: "active", "paused", "failing"
cursorstring | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_run_atstring | nullYes
last_success_atstring | nullYes
next_run_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/reverse-etl, GET /v1/apps/{appId}/reverse-etl/{syncId}, PATCH /v1/apps/{appId}/reverse-etl/{syncId}

ReverseEtlSyncList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].sourceenumYesValues: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub"
data[].targetenumYesValues: "event", "user"
data[].configmap<string, any>Yes
data[].credentials_hintstringYes
data[].scheduleenumYesValues: "every_5_minutes", "hourly", "daily"
data[].enabledbooleanYes
data[].statusenumYesValues: "active", "paused", "failing"
data[].cursorstring | nullYes
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].last_run_atstring | nullYes
data[].last_success_atstring | nullYes
data[].next_run_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/reverse-etl

RfmConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
event_namesarray<string>Yes
value_propertystring | nullYes
use_monetarybooleanYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
first_computed_atstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

Used by: GET /v1/apps/{appId}/rfm/config, PUT /v1/apps/{appId}/rfm/config, POST /v1/apps/{appId}/rfm/compute

RfmOverview

FieldTypeRequiredDescription
totalintegerYes
low_populationbooleanYes
last_computed_atstring | nullYes
segmentsarray<object>Yes
segments[].segmentenumYesValues: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost"
segments[].usersintegerYes
segments[].sharenumberYes
segments[].avg_recency_daysnumber | nullYes
segments[].avg_frequencynumber | nullYes
segments[].avg_monetarynumber | nullYes

Used by: GET /v1/apps/{appId}/rfm/overview

RfmTransitions

FieldTypeRequiredDescription
fromstringYes
tostringYes
first_computed_atstring | nullYes
transitionsarray<object>Yes
transitions[].fromenum | nullYes
transitions[].toenum | nullYes
transitions[].usersintegerYes

Used by: GET /v1/apps/{appId}/rfm/transitions

RfmUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].segmentenumYesValues: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost"
data[].rintegerYes
data[].fintegerYes
data[].minteger | nullYes
data[].recency_daysintegerYes
data[].frequencyintegerYes
data[].monetarynumberYes
data[].last_event_atstringYes
data[].segment_sincestringYes
next_cursorstring | nullYes

Used by: GET /v1/apps/{appId}/rfm/users

RunSqlQueryDto

FieldTypeRequiredDescription
querystringYesLength: 1–20000
row_limitintegerNoRange: 1–5000
timeout_msintegerNoRange: 1000–30000

Used by: POST /v1/apps/{appId}/sql/query

SavedReport

FieldTypeRequiredDescription
idstringYes
namestringYes
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>YesDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumYesValues: "asc", "desc"; Default: "desc"
definition.limitintegerYesDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No
created_bystring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/analytics/reports, GET /v1/apps/{appId}/analytics/reports/{id}, PATCH /v1/apps/{appId}/analytics/reports/{id}

SavedReportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].definitionobjectYes
data[].definition.sourceenumYesValues: "deliveries", "events", "conversions"
data[].definition.metricsarray<enum>YesItems: 1–8
data[].definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
data[].definition.filtersmap<string, array<string>>YesDefault: {}
data[].definition.sortobjectNo
data[].definition.limitintegerYesDefault: 100; Range: 1–1000
data[].definition.daysintegerNoRange: 1–730
data[].definition.fromstring (date-time)No
data[].definition.tostring (date-time)No
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/analytics/reports

ScheduleCampaignDto

FieldTypeRequiredDescription
send_atstring (date-time)No
recurrenceobjectNo
recurrence.cronstringYesLength: 9–100
recurrence.untilstring (date-time) | nullNo
recurrence.timezonestringNoLength: 1–64

Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/schedule

ScimTokenCreated

FieldTypeRequiredDescription
tokenstringYes
scim_base_urlstringYes
dataobjectYes
data.idstringYes
data.namestringYes
data.prefixstringYes
data.last_used_atstring | nullYes
data.revoked_atstring | nullYes
data.created_atstringYes

ScimTokenList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].prefixstringYes
data[].last_used_atstring | nullYes
data[].revoked_atstring | nullYes
data[].created_atstringYes

SdkAttributionAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Used by: POST /sdk/v1/apps/{appId}/attribution

SdkAttributionDto

FieldTypeRequiredDescription
subscription_idstringNoLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64
external_idstringNoLength: 1–128
touchesarray<object>YesItems: 1–10
touches[].touch_idstringYesLength: 8–64
touches[].occurred_atstring (date-time)Yes
touches[].utm_sourcestringNoLength: 1–200
touches[].utm_mediumstringNoLength: 1–200
touches[].utm_campaignstringNoLength: 1–200
touches[].utm_termstringNoLength: 1–200
touches[].utm_contentstringNoLength: 1–200
touches[].utm_idstringNoLength: 1–200
touches[].click_id_typeenumNoValues: "fbclid", "gclid", "gbraid", "wbraid", "ttclid", "li_fat_id", "msclkid"
touches[].click_idstringNoLength: 1–500
touches[].landing_urlstringNoLength: 0–2000
touches[].referrerstringNoLength: 0–255

Used by: POST /sdk/v1/apps/{appId}/attribution

SdkChatAckDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
read_seqintegerNoRange: 0–∞
delivered_seqintegerNoRange: 0–∞

Used by: POST /sdk/v1/apps/{appId}/chat/ack

SdkChatConfig

FieldTypeRequiredDescription
enabledbooleanYes
onlinebooleanYes
within_business_hoursbooleanYes
colorstring | nullYes
text_colorstring | nullYes
positionenumYesValues: "right", "left"
themeenumYesValues: "light", "dark", "auto"
titlestring | nullYes
greetingstring | nullYes
offline_messagestring | nullYes
collect_email_offlinebooleanYes
require_emailbooleanYes
attachmentsobjectYes
attachments.enabledbooleanYes
attachments.max_bytesintegerYes
attachments.typesarray<string>Yes
languagestringYes

Used by: GET /sdk/v1/apps/{appId}/chat/config

SdkChatConversation

FieldTypeRequiredDescription
conversationobject | nullYes
unread_countintegerYes

Used by: GET /sdk/v1/apps/{appId}/chat/conversation, POST /sdk/v1/apps/{appId}/chat/ack

SdkChatIdentifyDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
external_idstringNoLength: 1–255
identity_hashstringNoLength: 16–128
subscription_idstringNoLength: 1–64
token_hashstringNo
namestringNoLength: 1–120
emailstring (email)NoLength: 0–320
languagestringNo

Used by: POST /sdk/v1/apps/{appId}/chat/identify

SdkChatIdentifyResult

FieldTypeRequiredDescription
user_idstring | nullYes
conversationobject | nullYes

Used by: POST /sdk/v1/apps/{appId}/chat/identify

SdkChatMessagePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].seqintegerYes
data[].client_message_idstring | nullYes
data[].senderenumYesValues: "visitor", "agent", "bot", "system"
data[].author_namestring | nullYes
data[].textstring | nullYes
data[].attachmentsarray<object>Yes
data[].attachments[].idstringYes
data[].attachments[].namestringYes
data[].attachments[].typestringYes
data[].attachments[].sizeintegerYes
data[].quick_repliesarray<object> | nullYes
data[].statusenumYesValues: "sent", "delivered", "read"
data[].created_atstringYes
has_morebooleanYes

Used by: GET /sdk/v1/apps/{appId}/chat/messages

SdkChatOfflineDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
client_message_idstringYes
emailstring (email)YesLength: 0–320
namestringNoLength: 1–120
textstringYesLength: 1–4000
languagestringNo

Used by: POST /sdk/v1/apps/{appId}/chat/offline

SdkChatSendDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
client_message_idstringYes
textstringYesLength: 1–4000
option_idstringNoLength: 1–64
namestringNoLength: 1–120
emailstring (email)NoLength: 0–320
languagestringNo
page_urlstringNoLength: 0–2000

Used by: POST /sdk/v1/apps/{appId}/chat/messages

SdkChatSendResult

FieldTypeRequiredDescription
messageobjectYes
message.idstringYes
message.seqintegerYes
message.client_message_idstring | nullYes
message.senderenumYesValues: "visitor", "agent", "bot", "system"
message.author_namestring | nullYes
message.textstring | nullYes
message.attachmentsarray<object>Yes
message.attachments[].idstringYes
message.attachments[].namestringYes
message.attachments[].typestringYes
message.attachments[].sizeintegerYes
message.quick_repliesarray<object> | nullYes
message.statusenumYesValues: "sent", "delivered", "read"
message.created_atstringYes
conversationobjectYes
conversation.idstringYes
conversation.statusenumYesValues: "open", "pending", "resolved", "closed"
conversation.last_seqintegerYes
conversation.agent_last_read_seqintegerYes
conversation.visitor_last_read_seqintegerYes
conversation.unread_countintegerYes
conversation.bot_activebooleanYes
conversation.assignee_namestring | nullYes
conversation.created_atstringYes
duplicatebooleanYes

Used by: POST /sdk/v1/apps/{appId}/chat/messages, POST /sdk/v1/apps/{appId}/chat/attachments, POST /sdk/v1/apps/{appId}/chat/offline

SdkChatTypingDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
typingbooleanYes

Used by: POST /sdk/v1/apps/{appId}/chat/typing

SdkConfig

FieldTypeRequiredDescription
app_idstringYes
namestringYes
api_urlstringYes
cell_idstring | nullYes
identity_verification_requiredbooleanYes
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
platformsobjectYes
platforms.iosbooleanYes
platforms.androidbooleanYes
platforms.webbooleanYes
platforms.emailbooleanYes
platforms.smsbooleanYes
webobjectYes
web.vapid_public_keystring | nullYes
web.allowed_originsarray<string>Yes
web.service_worker_pathstring | nullYes
web.service_worker_scopestring | nullYes
web.promptobject | nullYes
web.welcome_notificationobject | nullYes
web.click_behaviorobject | nullYes
web.custom_linkobject | nullYes
web.prompt_backoff_daysarray<integer> | nullYes
sessionobjectYes
session.timeout_secondsintegerYes
in_appobjectYes
in_app.min_interval_secondsintegerYes
android_channelsarray<object>Yes
android_channels[].idstringYes
android_channels[].namestringYes
android_channels[].descriptionstring | nullYes
android_channels[].importanceenumYesValues: "low", "default", "high", "urgent"
android_channels[].soundstring | nullYes
android_channels[].vibrationbooleanYes
android_channels[].groupstring | nullYes
categoriesarray<object>Yes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes

Used by: GET /sdk/v1/apps/{appId}/config

SdkErrorPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].subscription_idstring | nullYes
data[].platformstringYes
data[].sdk_versionstring | nullYes
data[].levelstringYes
data[].codestring | nullYes
data[].messagestringYes
data[].contextmap<string, any>Yes
data[].occurred_atstringYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/sdk-errors

SdkErrorsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Used by: POST /sdk/v1/apps/{appId}/errors

SdkErrorsDto

FieldTypeRequiredDescription
errorsarray<object>YesItems: 1–20
errors[].levelenumNoValues: "error", "warning"; Default: "error"
errors[].platformenumYesValues: "web", "android", "ios", "flutter", "react_native", "node"
errors[].sdk_versionstringNoLength: 0–50
errors[].codestringNoLength: 0–100
errors[].messagestringYesLength: 1–2000
errors[].subscription_idstringNoLength: 0–64
errors[].contextmap<string, any>No
errors[].occurred_atstring (date-time)No

Used by: POST /sdk/v1/apps/{appId}/errors

SdkEventsDto

FieldTypeRequiredDescription
eventsarray<object>YesItems: 1–100
events[].namestringYesLength: 1–100
events[].propertiesmap<string, any>NoDefault: {}
events[].valuenumberNo
events[].occurred_atstring (date-time)No
events[].event_idstringNoLength: 8–64
events[].subscription_idstringNoLength: 1–∞
events[].external_idstringNoLength: 1–255
events[].token_hashstringNo
events[].identity_hashstringNoLength: 64–64

Used by: POST /sdk/v1/apps/{appId}/events

SdkFeatureFlags

FieldTypeRequiredDescription
flagsmap<string, object>Yes

Used by: POST /sdk/v1/apps/{appId}/feature-flags/evaluate

SdkFlagsEvaluateDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
subscription_idstringNoLength: 1–64
subjectstringNoLength: 1–128

Used by: POST /sdk/v1/apps/{appId}/feature-flags/evaluate

SdkFormSubmitDto

FieldTypeRequiredDescription
valuesmap<string, string | boolean | number | array<string>>Yes
visitor_idstringNo
subscription_idstringNoLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64
web_campaign_idstringNoLength: 0–64
page_urlstringNoLength: 0–2000
languagestringNoLength: 2–10
websitestringNoLength: 0–500
elapsed_msintegerNoRange: 0–86400000

Used by: POST /sdk/v1/apps/{appId}/forms/{formId}/submissions

SdkGeofenceEventsDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
eventsarray<object>YesItems: 1–20
events[].geofence_idstringYesLength: 1–64
events[].transitionenumYesValues: "enter", "exit"
events[].occurred_atstring (date-time)No

Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-events

SdkGeofenceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].latnumberYes
data[].lngnumberYes
data[].radius_mintegerYes

Used by: GET /sdk/v1/apps/{appId}/geofences

SdkIdentityDto

FieldTypeRequiredDescription
identitymap<string, string>Yes
identity_hashstringNoLength: 64–64

Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity

SdkIdentityResult

FieldTypeRequiredDescription
identitymap<string, string>Yes

Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity, DELETE /sdk/v1/apps/{appId}/users/{userId}/identity/{label}

SdkInAppEventDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
token_hashstringNo
typeenumYesValues: "impression", "click", "dismiss"
button_idstringNoLength: 0–64
variant_idstringNoLength: 0–64

Used by: POST /sdk/v1/apps/{appId}/in-app/{messageId}/events

SdkInAppList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].triggersarray<object>Yes
data[].trigger_groupsarray<array<object>>Yes
data[].variant_idstring | nullYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstring | nullYes
data[].display.text_colorstring | nullYes
data[].display.dismissiblebooleanYes
data[].display.auto_dismiss_secondsinteger | nullYes
data[].display.content_typeenumYesValues: "blocks", "html"
data[].display.htmlstring | nullYes
data[].display.html_heightinteger | nullYes
data[].display.blocksarray<object>Yes
data[].remaining_impressionsintegerYes
data[].min_interval_secondsintegerYes
data[].stop_after_interactionbooleanYes
data[].last_impression_atstring | nullYes
data[].end_atstring | nullYes
languagestringYes

Used by: GET /sdk/v1/apps/{appId}/in-app, GET /sdk/v1/apps/{appId}/placements/{key}

SdkInboxActionDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
identity_hashstringNoLength: 0–128
token_hashstringNo

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

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
activity_typestringYesLength: 1–100
kindenumYesValues: "push_to_start", "update"
activity_idstringNoLength: 1–100
token_hashstringNoLength: 64–64
identity_hashstringNoLength: 64–64

Used by: POST /sdk/v1/apps/{appId}/live-activities/tokens/delete

SdkLiveActivityTokenDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
activity_typestringYesLength: 1–100
kindenumYesValues: "push_to_start", "update"
activity_idstringNoLength: 1–100
tokenstringYes
token_hashstringNoLength: 64–64
identity_hashstringNoLength: 64–64

Used by: POST /sdk/v1/apps/{appId}/live-activities/tokens

SdkLoginDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–255
identity_hashstringNoLength: 64–64
token_hashstringNo

Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login

SdkLogoutDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64

Used by: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout

SdkPreferences

FieldTypeRequiredDescription
dataarray<object>Yes
data[].categorystringYes
data[].channelstring | nullYes
data[].opted_inbooleanYes
data[].explicitbooleanYes
data[].sourcestring | nullYes
data[].updated_atstring | nullYes
categoriesarray<object>Yes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes
consentsarray<object>Yes
consents[].purposeenumYesValues: "ads_personalization"
consents[].grantedbooleanYes
consents[].sourcestring | nullYes
consents[].updated_atstring | nullYes

Used by: GET /sdk/v1/apps/{appId}/preferences, PUT /sdk/v1/apps/{appId}/preferences

SdkRegisterDto

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs"
tokenstringYesLength: 1–4096
deviceobjectNoDefault: {}
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanNo
userobjectNo
user.external_idstringNoLength: 1–255
user.identity_hashstringNoLength: 64–64
user.tagsmap<string, string>No
user.propertiesmap<string, any>No
user.subscription_idstringNoLength: 1–64
user.token_hashstringNo
ownership_proofbooleanNo

Used by: POST /sdk/v1/apps/{appId}/subscriptions

SdkRegisterResult

FieldTypeRequiredDescription
subscription_idstringYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
createdbooleanYes

Used by: POST /sdk/v1/apps/{appId}/subscriptions

SdkSecret

FieldTypeRequiredDescription
sdk_secretstringYes
identity_verification_requiredbooleanYes

SdkSessionDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
subscription_idstringYesLength: 1–∞
duration_secondsintegerNoRange: 0–604800
app_versionstring | nullNo
sdk_versionstringNoLength: 0–50

Used by: POST /sdk/v1/apps/{appId}/sessions

SdkSetPreferencesDto

FieldTypeRequiredDescription
preferencesarray<object>YesItems: 1–100
preferences[].categorystringYesLength: 1–64
preferences[].channelenum | nullNo
preferences[].opted_inbooleanYes
subscription_idstringYesLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64

Used by: PUT /sdk/v1/apps/{appId}/preferences

SdkSnippet

FieldTypeRequiredDescription
platformstringYes
variantstring | nullYes
variantsarray<string>Yes
langstringYes
availabilityenumYesValues: "available", "soon"
docs_pathstring | nullYes
installarray<object>Yes
install[].keystringYes
install[].languagestringYes
install[].codestringYes
initarray<object>Yes
init[].keystringYes
init[].languagestringYes
init[].codestringYes
extrasarray<object>Yes
extras[].keystringYes
extras[].languagestringYes
extras[].codestringYes
android_modulesarray<object>Yes
android_modules[].modulestringYes
android_modules[].languagestringYes
android_modules[].codestringYes

Used by: GET /v1/apps/{appId}/setup/snippet

SdkSubscriptionPatchDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
tokenstringNoLength: 1–4096
deviceobjectNo
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
opted_inbooleanNo
locationobject | nullNo
advertising_idstring | nullNo

Used by: PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}

SdkSurveyResponseDto

FieldTypeRequiredDescription
answersmap<string, string | boolean | number | array<string>>Yes
visitor_idstringNo
subscription_idstringNoLength: 1–64
token_hashstringNo
web_campaign_idstringNoLength: 0–64

Used by: POST /sdk/v1/apps/{appId}/surveys/{surveyId}/responses

SdkUserPatchDto

FieldTypeRequiredDescription
tagsmap<string, string | null>No
propertiesmap<string, any>No
deltasobjectNo
deltas.session_countintegerNoRange: -1000000–1000000
deltas.session_timeintegerNoRange: 0–31536000
deltas.purchasesarray<object>NoItems: 0–100
deltas.purchases[].skustringYesLength: 1–100
deltas.purchases[].amountnumberYesRange: 0–∞
deltas.purchases[].isostringNoLength: 3–3
deltas.purchases[].countintegerNoDefault: 1; Range: 1–1000
identity_hashstringNoLength: 64–64

Used by: PATCH /sdk/v1/apps/{appId}/users/{userId}

SdkUserResult

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
tagsmap<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

FieldTypeRequiredDescription
typeenumYesValues: "impression", "click", "close", "conversion"
visitor_idstringYes
variant_idstringNoLength: 0–64
button_idstringNoLength: 0–64
subscription_idstringNoLength: 1–64
token_hashstringNo

Used by: POST /sdk/v1/apps/{appId}/web-campaigns/{campaignId}/events

SdkWebCampaignList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].triggerobjectYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.visitorenumYesValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>Yes
data[].frequencyobjectYes
data[].frequency.max_per_sessionintegerNoRange: 1–100
data[].frequency.max_per_dayintegerNoRange: 1–100
data[].frequency.max_totalintegerNoRange: 1–1000
data[].frequency.hide_after_close_daysintegerNoRange: 0–365
data[].frequency.stop_after_conversionbooleanNo
data[].displayobjectYes
data[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
data[].display.positionenumYesValues: "left", "right"
data[].display.background_colorstring | nullYes
data[].display.text_colorstring | nullYes
data[].display.dismissiblebooleanYes
data[].display.auto_dismiss_secondsinteger | nullYes
data[].display.max_widthinteger | nullYes
data[].display.blocksarray<object>Yes
data[].display.form_idstring | nullYes
data[].display.survey_idstring | nullYes
data[].variantsarray<object>Yes
data[].variants[].idstringYes
data[].variants[].weight_percentintegerYes
data[].variants[].displayobjectYes
data[].end_atstring | nullYes
formsmap<string, object>Yes
surveysmap<string, object>Yes
languagestringYes

Used by: GET /sdk/v1/apps/{appId}/web-campaigns

SdkWebPersonalizationEventDto

FieldTypeRequiredDescription
typeenumYesValues: "impression", "conversion"
visitor_idstringYes
variant_idstringNoLength: 0–64
subscription_idstringNoLength: 1–64
token_hashstringNo

Used by: POST /sdk/v1/apps/{appId}/web-personalizations/{personalizationId}/events

SdkWebPersonalizationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.visitorenumYesValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>Yes
data[].changesarray<object>Yes
data[].changes[].selectorstringYes
data[].changes[].actionenumYesValues: "text", "image", "link", "hide", "show"
data[].changes[].textstring | nullYes
data[].changes[].urlstring | nullYes
data[].changes[].altstring | nullYes
data[].changes[].new_tabbooleanYes
data[].variantsarray<object>Yes
data[].variants[].idstringYes
data[].variants[].weight_percentintegerYes
data[].variants[].changesarray<object>Yes
data[].winner_variant_idstring | nullYes
data[].goalobject | nullYes
data[].end_atstring | nullYes
editor_originsarray<string>Yes
languagestringYes

Used by: GET /sdk/v1/apps/{appId}/web-personalizations

Segment

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
definitionmap<string, any>Yes
is_dynamicbooleanYes
estimated_countinteger | nullYes
estimated_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
sqlobject | nullYes
warehouseobject | nullYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].statusstringYes
data[].typestringYes
data[].usageenumYesValues: "include", "exclude"
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/segments/{segmentId}/campaigns

SegmentEstimate

FieldTypeRequiredDescription
segment_idstring | nullYes
subscriptionsintegerYes
usersintegerYes
estimated_atstringYes
cachedbooleanYes
sampledbooleanYes

Used by: POST /v1/apps/{appId}/segments/{segmentId}/estimate

SegmentPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].definitionmap<string, any>Yes
data[].is_dynamicbooleanYes
data[].estimated_countinteger | nullYes
data[].estimated_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].sqlobject | nullYes
data[].warehouseobject | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/segments

SegmentPreview

FieldTypeRequiredDescription
subscriptionsintegerYes
usersintegerYes
sampledbooleanYes
samplearray<object>Yes
sample[].idstringYes
sample[].external_idstring | nullYes
sample[].tagsmap<string, string>Yes
sample[].last_active_atstringYes

Used by: POST /v1/apps/{appId}/segments/preview

SelectWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–∞

Used by: POST /v1/apps/{appId}/campaigns/{campaignId}/winner

SessionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].ipstring | nullYes
data[].user_agentstring | nullYes
data[].created_atstringYes
data[].last_seen_atstringYes
data[].expires_atstringYes
data[].currentbooleanYes

SessionVolume

FieldTypeRequiredDescription
daysarray<object>Yes
days[].daystringYes
days[].sessionsintegerYes
days[].usersintegerYes

Used by: GET /v1/apps/{appId}/analytics/sessions

SetMemberDto

FieldTypeRequiredDescription
rolestringNo

Used by: PUT /v1/apps/{appId}/companies/{companyId}/members/{userId}

SetOwnerDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–255

Used by: POST /v1/apps/{appId}/subscriptions/{subscriptionId}/owner

SetPreferencesDto

FieldTypeRequiredDescription
preferencesarray<object>YesItems: 1–100
preferences[].categorystringYesLength: 1–64
preferences[].channelenum | nullNo
preferences[].opted_inbooleanYes

Used by: PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences

SetupStatus

FieldTypeRequiredDescription
app_idstringYes
namestringYes
platformsarray<string>Yes
frameworkstringYes
web_integrationstringYes
sdk_platformsarray<string>Yes
channelsarray<object>Yes
channels[].platformstringYes
channels[].channelstringYes
channels[].providerstring | nullYes
channels[].statusstringYes
first_subscriberbooleanYes
completedbooleanYes
missingarray<object>Yes
missing[].stepenumYesValues: "credentials", "install", "first_subscriber"
missing[].platformstringNo
missing[].channelstringNo
missing[].statusstringNo
missing[].local_uploadbooleanNo
missing[].sdk_platformsarray<string>No
missing[].urlstringYes
linksobjectYes
links.getting_startedstringYes
links.channelsstringYes

Used by: GET /v1/apps/{appId}/setup/status

ShopifyWebhookStatus

FieldTypeRequiredDescription
configuredbooleanYes

SiteSearchCrawlRequest

FieldTypeRequiredDescription
queuedbooleanYes
sourceobjectYes
source.idstringYes
source.namestringYes
source.kindenumYesValues: "sitemap", "urls"
source.urlstring | nullYes
source.urlsarray<string>Yes
source.max_pagesintegerYes
source.refresh_hoursinteger | nullYes
source.enabledbooleanYes
source.statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
source.documentsintegerYes
source.crawl_requested_atstring | nullYes
source.last_crawled_atstring | nullYes
source.next_crawl_atstring | nullYes
source.last_errorstring | nullYes
source.statsobjectYes
source.stats.pages_foundintegerYes
source.stats.pages_indexedintegerYes
source.stats.pages_unchangedintegerYes
source.stats.pages_skippedintegerYes
source.stats.pages_failedintegerYes
source.stats.pages_removedintegerYes
source.stats.duration_msintegerYes
source.created_atstringYes
source.updated_atstringYes

Used by: POST /v1/apps/{appId}/site-search/sources/{sourceId}/crawl

SiteSearchDocument

FieldTypeRequiredDescription
idstringYes
keystringYes
source_idstring | nullYes
urlstringYes
titlestringYes
languagestring | nullYes
chunksintegerYes
charsintegerYes
indexed_atstringYes
created_atstringYes

SiteSearchDocumentPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].keystringYes
data[].source_idstring | nullYes
data[].urlstringYes
data[].titlestringYes
data[].languagestring | nullYes
data[].chunksintegerYes
data[].charsintegerYes
data[].indexed_atstringYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/site-search/documents

SiteSearchDocumentResult

FieldTypeRequiredDescription
outcomeenumYesValues: "created", "updated", "unchanged"
documentobjectYes
document.idstringYes
document.keystringYes
document.source_idstring | nullYes
document.urlstringYes
document.titlestringYes
document.languagestring | nullYes
document.chunksintegerYes
document.charsintegerYes
document.indexed_atstringYes
document.created_atstringYes

Used by: PUT /v1/apps/{appId}/site-search/documents/{documentKey}

SiteSearchEventDto

FieldTypeRequiredDescription
query_idstringYesLength: 0–60
typeenumYesValues: "click"
urlstringYesLength: 0–2000
positionintegerNoRange: 1–100

Used by: POST /sdk/v1/apps/{appId}/search/events

SiteSearchOverview

FieldTypeRequiredDescription
settingsobjectYes
settings.enabledbooleanYes
settings.ai_answersbooleanYes
settings.allowed_originsarray<string>Yes
settings.languagestringYes
settings.text_search_configstringYes
settings.monthly_token_capintegerYes
settings.query_retention_daysintegerYes
settings.updated_atstring | nullYes
indexobjectYes
index.documentsintegerYes
index.chunksintegerYes
index.sourcesintegerYes
index.last_indexed_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.monthly_token_capintegerYes
usage.period_startstringYes
aiobjectYes
ai.availablebooleanYes
ai.reasonenum | nullYes

Used by: GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings

SiteSearchPreview

FieldTypeRequiredDescription
query_idstringYes
modeenumYesValues: "search", "answer"
resultsarray<object>Yes
results[].idstringYes
results[].urlstringYes
results[].titlestringYes
results[].headingstringYes
results[].snippetstringYes
results[].snippet_htmlstringYes
answerobject | nullYes
answer_statusenum | nullYes
answers_availablebooleanYes
fallback_reasonenum | nullYes

SiteSearchReport

FieldTypeRequiredDescription
period_daysintegerYes
searchesintegerYes
zero_resultsintegerYes
click_through_ratenumberYes
answers_requestedintegerYes
answeredintegerYes
not_foundintegerYes
answer_fallbacksintegerYes
tokensintegerYes
top_queriesarray<object>Yes
top_queries[].querystringYes
top_queries[].searchesintegerYes
top_queries[].clicksintegerYes
top_queries[].avg_resultsnumberYes
zero_result_queriesarray<object>Yes
zero_result_queries[].querystringYes
zero_result_queries[].searchesintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].searchesintegerYes
daily[].zero_resultsintegerYes
daily[].answeredintegerYes

Used by: GET /v1/apps/{appId}/site-search/report

SiteSearchRequestDto

FieldTypeRequiredDescription
querystringYesLength: 0–1000
modeenumNoValues: "search", "answer"
languagestringNo
limitintegerNoRange: 1–20

Used by: POST /sdk/v1/apps/{appId}/search

SiteSearchResponse

FieldTypeRequiredDescription
query_idstringYes
modeenumYesValues: "search", "answer"
resultsarray<object>Yes
results[].idstringYes
results[].urlstringYes
results[].titlestringYes
results[].headingstringYes
results[].snippetstringYes
results[].snippet_htmlstringYes
answerobject | nullYes
answer_statusenum | nullYes
answers_availablebooleanYes

Used by: POST /sdk/v1/apps/{appId}/search

SiteSearchSource

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "sitemap", "urls"
urlstring | nullYes
urlsarray<string>Yes
max_pagesintegerYes
refresh_hoursinteger | nullYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
documentsintegerYes
crawl_requested_atstring | nullYes
last_crawled_atstring | nullYes
next_crawl_atstring | nullYes
last_errorstring | nullYes
statsobjectYes
stats.pages_foundintegerYes
stats.pages_indexedintegerYes
stats.pages_unchangedintegerYes
stats.pages_skippedintegerYes
stats.pages_failedintegerYes
stats.pages_removedintegerYes
stats.duration_msintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/site-search/sources, PATCH /v1/apps/{appId}/site-search/sources/{sourceId}

SiteSearchSourceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].kindenumYesValues: "sitemap", "urls"
data[].urlstring | nullYes
data[].urlsarray<string>Yes
data[].max_pagesintegerYes
data[].refresh_hoursinteger | nullYes
data[].enabledbooleanYes
data[].statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
data[].documentsintegerYes
data[].crawl_requested_atstring | nullYes
data[].last_crawled_atstring | nullYes
data[].next_crawl_atstring | nullYes
data[].last_errorstring | nullYes
data[].statsobjectYes
data[].stats.pages_foundintegerYes
data[].stats.pages_indexedintegerYes
data[].stats.pages_unchangedintegerYes
data[].stats.pages_skippedintegerYes
data[].stats.pages_failedintegerYes
data[].stats.pages_removedintegerYes
data[].stats.duration_msintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/site-search/sources

SmsKeyword

FieldTypeRequiredDescription
idstringYes
keywordstringYes
scopeenumYesValues: "org", "app"
app_idstring | nullYes
channelsarray<enum>Yes
actionsmap<string, any>Yes
enabledbooleanYes
descriptionstring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/sms-keywords, PATCH /v1/apps/{appId}/sms-keywords/{keywordId}

SmsKeywordList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].keywordstringYes
data[].scopeenumYesValues: "org", "app"
data[].app_idstring | nullYes
data[].channelsarray<enum>Yes
data[].actionsmap<string, any>Yes
data[].enabledbooleanYes
data[].descriptionstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
reservedarray<string>Yes

Used by: GET /v1/apps/{appId}/sms-keywords

SmsVerification

FieldTypeRequiredDescription
idstringYes
expires_atstringYes

Used by: POST /v1/apps/{appId}/verify/sms

SmsVerificationCheck

FieldTypeRequiredDescription
verifiedtrueYes

Used by: POST /v1/apps/{appId}/verify/sms/check

SqlQueryResult

FieldTypeRequiredDescription
run_idstringYes
columnsarray<object>Yes
columns[].namestringYes
columns[].typeenum | "unknown"Yes
rowsarray<array<any>>Yes
row_countintegerYes
truncatedbooleanYes
duration_msintegerYes

Used by: POST /v1/apps/{appId}/sql/query

SqlRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].segment_idstring | nullYes
data[].sourceenumYesValues: "panel", "api", "schedule"
data[].actor_idstring | nullYes
data[].querystringYes
data[].query_hashstringYes
data[].statusenumYesValues: "ok", "rejected", "timeout", "failed"
data[].reasonenum | nullYes
data[].errorstring | nullYes
data[].row_countintegerYes
data[].truncatedbooleanYes
data[].duration_msintegerYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/sql/runs

SqlSchema

FieldTypeRequiredDescription
viewsarray<object>Yes
views[].namestringYes
views[].columnsarray<object>Yes
views[].columns[].namestringYes
views[].columns[].typeenumYesValues: "text", "integer", "number", "boolean", "timestamp", "json"
limitsobjectYes
limits.query_maxintegerYes
limits.row_limit_defaultintegerYes
limits.row_limit_maxintegerYes
limits.timeout_default_msintegerYes
limits.timeout_max_msintegerYes
limits.segment_max_membersintegerYes
refresh_intervalsarray<integer>Yes

Used by: GET /v1/apps/{appId}/sql/schema

SqlSegmentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].definitionmap<string, any>Yes
data[].is_dynamicbooleanYes
data[].estimated_countinteger | nullYes
data[].estimated_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].sqlobject | nullYes
data[].warehouseobject | nullYes

Used by: GET /v1/apps/{appId}/sql/segments

SsoConnection

FieldTypeRequiredDescription
idstringYes
typeenumYesValues: "saml", "oidc"
namestringYes
statusenumYesValues: "draft", "active", "disabled"
configobjectYes
config.idp_entity_idstringNoLength: 1–500
config.idp_sso_urlstring (uri)NoLength: 0–2000
config.idp_certificatesarray<string>NoItems: 0–3
config.allow_idp_initiatedbooleanNo
config.groups_attributestringNoLength: 0–200
config.email_attributestringNoLength: 0–200
config.name_attributestringNoLength: 0–200
config.issuerstring (uri)NoLength: 0–2000
config.client_idstringNoLength: 1–500
config.authorization_endpointstring (uri)NoLength: 0–2000
config.token_endpointstring (uri)NoLength: 0–2000
config.jwks_uristring (uri)NoLength: 0–2000
config.scopesarray<string>NoItems: 0–20
config.groups_claimstringNoLength: 0–200
has_client_secretbooleanYes
default_rolestringYes
group_role_mapmap<string, string>Yes
jit_enabledbooleanYes
last_login_atstring | nullYes
spobjectYes
sp.entity_idstringYes
sp.acs_urlstringYes
sp.metadata_urlstringYes
sp.redirect_uristringYes
created_atstringYes
updated_atstringYes

SsoConnectionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].typeenumYesValues: "saml", "oidc"
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "disabled"
data[].configobjectYes
data[].config.idp_entity_idstringNoLength: 1–500
data[].config.idp_sso_urlstring (uri)NoLength: 0–2000
data[].config.idp_certificatesarray<string>NoItems: 0–3
data[].config.allow_idp_initiatedbooleanNo
data[].config.groups_attributestringNoLength: 0–200
data[].config.email_attributestringNoLength: 0–200
data[].config.name_attributestringNoLength: 0–200
data[].config.issuerstring (uri)NoLength: 0–2000
data[].config.client_idstringNoLength: 1–500
data[].config.authorization_endpointstring (uri)NoLength: 0–2000
data[].config.token_endpointstring (uri)NoLength: 0–2000
data[].config.jwks_uristring (uri)NoLength: 0–2000
data[].config.scopesarray<string>NoItems: 0–20
data[].config.groups_claimstringNoLength: 0–200
data[].has_client_secretbooleanYes
data[].default_rolestringYes
data[].group_role_mapmap<string, string>Yes
data[].jit_enabledbooleanYes
data[].last_login_atstring | nullYes
data[].spobjectYes
data[].sp.entity_idstringYes
data[].sp.acs_urlstringYes
data[].sp.metadata_urlstringYes
data[].sp.redirect_uristringYes
data[].created_atstringYes
data[].updated_atstringYes

SsoDiscoverResult

FieldTypeRequiredDescription
ssobooleanYes
typeenum | nullYes
start_urlstring | nullYes

SsoDomain

FieldTypeRequiredDescription
idstringYes
domainstringYes
verifiedbooleanYes
verified_atstring | nullYes
last_checked_atstring | nullYes
txt_recordobjectYes
txt_record.namestringYes
txt_record.valuestringYes
created_atstringYes

SsoDomainList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].domainstringYes
data[].verifiedbooleanYes
data[].verified_atstring | nullYes
data[].last_checked_atstring | nullYes
data[].txt_recordobjectYes
data[].txt_record.namestringYes
data[].txt_record.valuestringYes
data[].created_atstringYes

SsoSettings

FieldTypeRequiredDescription
enforcedbooleanYes
availablebooleanYes
scim_availablebooleanYes
recovery_codesarray<string>No
recovery_codes_remaininginteger | nullYes

SsoTestResult

FieldTypeRequiredDescription
connection_idstringYes
okbooleanYes
errorstring | nullYes
emailstring | nullYes
namestring | nullYes
groupsarray<string>Yes
mapped_rolestring | nullYes
domain_verifiedbooleanYes
account_existsbooleanYes
memberbooleanYes
claimsmap<string, any>Yes
tested_atstringYes

SsoTestStart

FieldTypeRequiredDescription
urlstringYes

StartHygieneDto

Type: object

Used by: POST /v1/apps/{appId}/email-deliverability/hygiene-runs, POST /v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppress

StartLiveActivityDto

FieldTypeRequiredDescription
activity_idstringNoLength: 1–100
attributesmap<string, string | number | boolean>No
targetobjectYes
target.include_external_idsarray<string>NoItems: 0–2000
target.include_subscription_idsarray<string>NoItems: 0–2000
target.included_segmentsarray<string>NoItems: 0–20
target.allbooleanNo
content_statemap<string, string | number | boolean>Yes
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 0–200

Used by: POST /v1/apps/{appId}/live-activities/{activityType}/start

StartVerifyDto

FieldTypeRequiredDescription
phonestringYesLength: 8–20
localestringNoLength: 2–12

Used by: POST /v1/apps/{appId}/verify/sms

StatusTokenResult

FieldTypeRequiredDescription
okbooleanYes

Subscription

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].user_idstring | nullYes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].tokenstringYes
data[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
data[].unsubscribe_reasonenum | nullYes
data[].deviceobjectYes
data[].device.modelstringNoLength: 0–100
data[].device.osstringNoLength: 0–50
data[].device.os_versionstringNoLength: 0–50
data[].device.app_versionstring | nullNo
data[].device.sdk_versionstringNoLength: 0–50
data[].device.sdk_platformstringNoLength: 0–50
data[].device.carrierstringNoLength: 0–100
data[].device.localestringNoLength: 0–20
data[].device.timezonestringNoLength: 0–64
data[].device.push_capablebooleanNo
data[].device.push_environmentenumNoValues: "sandbox", "production"
data[].device.form_factorenumNoValues: "phone", "watch"
data[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
data[].device.manufacturerstringNoLength: 0–50
data[].device.brandstringNoLength: 0–50
data[].device.romstringNoLength: 0–30
data[].device.rom_versionstringNoLength: 0–30
data[].device.deliveryobjectNo
data[].test_devicebooleanYes
data[].test_device_namestring | nullYes
data[].last_active_atstringYes
data[].last_sent_atstring | nullYes
data[].last_delivered_atstring | nullYes
data[].opted_in_atstring | nullYes
data[].opt_in_sourcestring | nullYes
data[].unsubscribed_atstring | nullYes
data[].locationobject | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/subscriptions

SubscriptionsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.activeintegerYes
totals.newintegerYes
totals.unsubscribedintegerYes
totals.opt_outsintegerYes
totals.netintegerYes
previousobject | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].newintegerYes
rows[].unsubscribedintegerYes
rows[].opt_outsintegerYes
rows[].netintegerYes
by_channelarray<object>Yes
by_channel[].channelstringYes
by_channel[].activeintegerYes
by_channel[].newintegerYes
by_channel[].unsubscribedintegerYes

Used by: GET /v1/apps/{appId}/analytics/subscriptions

Suppression

FieldTypeRequiredDescription
idstringYes
app_idstringYes
channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
value_maskedstringYes
reasonenumYesValues: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
sourcestringYes
detailmap<string, any>Yes
expires_atstring | nullYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/suppressions

SuppressionPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].value_maskedstringYes
data[].reasonenumYesValues: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
data[].sourcestringYes
data[].detailmap<string, any>Yes
data[].expires_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/suppressions

Survey

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "closed"
questionsarray<object>YesItems: 1–10
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].textmap<string, string>Yes
questions[].requiredbooleanNo
questions[].optionsarray<object>NoItems: 0–30
questions[].options[].valuestringYesLength: 1–100
questions[].options[].labelmap<string, string>Yes
questions[].low_labelmap<string, string>No
questions[].high_labelmap<string, string>No
questions[].placeholdermap<string, string>No
settingsobjectYes
settings.thank_youmap<string, string>No
settings.submit_labelmap<string, string>No
settings.write_propertiesbooleanNo
settings.allow_multiplebooleanNo
settings.default_languagestringNoLength: 2–10
in_app_message_idstring | nullYes
statsobjectYes
stats.responsesintegerYes
stats.npsnumber | nullYes
stats.last_response_atstring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
triggersarray<object>NoItems: 1–5
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
layoutenumNoValues: "modal", "banner_bottom", "fullscreen"
publishbooleanNo

Used by: POST /v1/apps/{appId}/surveys/{surveyId}/distribute/in-app

SurveyPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "closed"
data[].questionsarray<object>YesItems: 1–10
data[].questions[].idstringYes
data[].questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
data[].questions[].textmap<string, string>Yes
data[].questions[].requiredbooleanNo
data[].questions[].optionsarray<object>NoItems: 0–30
data[].questions[].low_labelmap<string, string>No
data[].questions[].high_labelmap<string, string>No
data[].questions[].placeholdermap<string, string>No
data[].settingsobjectYes
data[].settings.thank_youmap<string, string>No
data[].settings.submit_labelmap<string, string>No
data[].settings.write_propertiesbooleanNo
data[].settings.allow_multiplebooleanNo
data[].settings.default_languagestringNoLength: 2–10
data[].in_app_message_idstring | nullYes
data[].statsobjectYes
data[].stats.responsesintegerYes
data[].stats.npsnumber | nullYes
data[].stats.last_response_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/surveys

SurveyReport

FieldTypeRequiredDescription
survey_idstringYes
daysintegerYes
responsesintegerYes
npsobjectYes
nps.responsesintegerYes
nps.promotersintegerYes
nps.passivesintegerYes
nps.detractorsintegerYes
nps.npsnumber | nullYes
csatobjectYes
csat.responsesintegerYes
csat.averagenumber | nullYes
csat.distributionmap<string, integer>Yes
trendarray<object>Yes
trend[].datestringYes
trend[].responsesintegerYes
trend[].promotersintegerYes
trend[].passivesintegerYes
trend[].detractorsintegerYes
trend[].npsnumber | nullYes
channelsmap<string, integer>Yes
questionsarray<object>Yes
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].countsmap<string, integer>Yes

Used by: GET /v1/apps/{appId}/surveys/{surveyId}/report

SurveyResponse

FieldTypeRequiredDescription
idstringYes
survey_idstringYes
user_idstring | nullYes
visitor_idstring | nullYes
channelenumYesValues: "in_app", "web", "email", "api", "sdk"
answersmap<string, number | string | array<string>>Yes
nps_scoreinteger | nullYes
nps_categoryenum | nullYes
csat_scoreinteger | nullYes
created_atstringYes

SurveyResponsePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].survey_idstringYes
data[].user_idstring | nullYes
data[].visitor_idstring | nullYes
data[].channelenumYesValues: "in_app", "web", "email", "api", "sdk"
data[].answersmap<string, number | string | array<string>>Yes
data[].nps_scoreinteger | nullYes
data[].nps_categoryenum | nullYes
data[].csat_scoreinteger | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/surveys/{surveyId}/responses

SurveyResponseResult

FieldTypeRequiredDescription
oktrueYes
response_idstring | nullYes
duplicatebooleanYes
thank_youstringYes

Used by: POST /sdk/v1/apps/{appId}/surveys/{surveyId}/responses, POST /v1/apps/{appId}/surveys/{surveyId}/responses

SurveyStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "closed"

Used by: POST /v1/apps/{appId}/surveys/{surveyId}/status

SyncAdAudienceDto

FieldTypeRequiredDescription
fullbooleanNo

Used by: POST /v1/apps/{appId}/ads/audiences/{audienceId}/sync

TeamInputDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstring | nullNo
member_idsarray<string>NoItems: 0–200

Used by: POST /v1/apps/{appId}/inbox/teams

TeamUpdateDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstring | nullNo
member_idsarray<string>NoItems: 0–200

Used by: PATCH /v1/apps/{appId}/inbox/teams/{teamId}

Template

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].channelenum | nullYes
data[].current_versionintegerYes
data[].tagsarray<string>Yes
data[].contentmap<string, any>Yes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/templates

TemplateStats

FieldTypeRequiredDescription
template_idstringYes
messagesintegerYes
campaignsintegerYes
targetedintegerYes
sentintegerYes
deliveredintegerYes
openedintegerYes
clickedintegerYes
convertedintegerYes
open_ratenumberYes
click_ratenumberYes
conversion_ratenumberYes
last_used_atstring | nullYes

Used by: GET /v1/apps/{appId}/templates/{templateId}/stats

TemplateVersionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].versionintegerYes
data[].contentmap<string, any>Yes
data[].created_bystring | nullYes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/templates/{templateId}/versions

TestDataFeedDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–256
user_idstringNoLength: 1–64

Used by: POST /v1/apps/{appId}/data-feeds/{feedId}/test

TestPushDto

FieldTypeRequiredDescription
subscription_idsarray<string>NoItems: 1–2000
headingsmap<string, string>No
contentsmap<string, string>Yes
urlstring (url)NoLength: 0–2000
datamap<string, string>No

Used by: POST /v1/apps/{appId}/mcp/test-sends

TraceResult

FieldTypeRequiredDescription
querystringYes
kindstringYes
itemsarray<object>Yes
items[].deliveryobjectYes
items[].delivery.idstringYes
items[].delivery.message_idstringYes
items[].delivery.subscription_idstringYes
items[].delivery.user_idstring | nullYes
items[].delivery.channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
items[].delivery.providerstring | nullYes
items[].delivery.statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
items[].delivery.attempt_countintegerYes
items[].delivery.provider_message_idstring | nullYes
items[].delivery.error_codestring | nullYes
items[].delivery.error_messagestring | nullYes
items[].delivery.suppression_reasonstring | nullYes
items[].delivery.send_afterstring | nullYes
items[].delivery.sent_atstring | nullYes
items[].delivery.delivered_atstring | nullYes
items[].delivery.opened_atstring | nullYes
items[].delivery.clicked_atstring | nullYes
items[].delivery.failed_atstring | nullYes
items[].delivery.created_atstringYes
items[].eventsarray<object>Yes
items[].events[].idstringYes
items[].events[].typestringYes
items[].events[].detailmap<string, any>Yes
items[].events[].occurred_atstringYes
items[].subscriptionobject | nullYes
items[].userobject | nullYes
items[].renderobject | nullYes
items[].webhooksarray<object>Yes
items[].webhooks[].idstringYes
items[].webhooks[].endpoint_idstringYes
items[].webhooks[].event_typestringYes
items[].webhooks[].statusstringYes
items[].webhooks[].attemptintegerYes
items[].webhooks[].response_statusinteger | nullYes
items[].webhooks[].created_atstringYes
items[].messageobject | nullYes

Used by: GET /v1/apps/{appId}/trace

TriggerRunDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–255
user_idstringNoLength: 1–64
aliasobjectNo
alias.labelstringYesLength: 1–50
alias.valuestringYesLength: 1–255
contextmap<string, any>No

Used by: POST /v1/apps/{appId}/journeys/{journeyId}/runs

UninstallReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.uninstallsintegerYes
totals.activeintegerYes
totals.ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].uninstallsintegerYes
by_channelarray<object>Yes
by_channel[].channelstringYes
by_channel[].uninstallsintegerYes
by_channel[].activeintegerYes
last_messagesarray<object>Yes
last_messages[].campaign_idstring | nullYes
last_messages[].namestring | nullYes
last_messages[].sourcestringYes
last_messages[].uninstallsintegerYes

Used by: GET /v1/apps/{appId}/analytics/uninstalls

UpdateAdAudienceDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
descriptionstring | nullNo
segment_idstringNoLength: 1–64
identifiersarray<enum>NoItems: 1–3
sync_interval_minutesintegerNoRange: 60–360
statusenumNoValues: "active", "paused"

Used by: PATCH /v1/apps/{appId}/ads/audiences/{audienceId}

UpdateAdCampaignDto

FieldTypeRequiredDescription
statusenumNoValues: "active", "paused"
daily_budgetstring | numberNo

Used by: PATCH /v1/apps/{appId}/ads/campaigns/{entityId}

UpdateAffinityConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
attributesarray<string>YesItems: 1–5
eventsmap<string, number>Yes
window_daysintegerNoRange: 7–365
half_life_daysintegerNoRange: 1–180

Used by: PUT /v1/apps/{appId}/affinity/config

UpdateAiAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
channelsarray<enum>NoItems: 0–6
instructionsstringNoLength: 0–4000
faqarray<object>NoItems: 0–50
faq[].questionstringYesLength: 1–300
faq[].answerstringYesLength: 1–1500
toolsarray<object>NoItems: 0–10
tools[].namestringYes
tools[].descriptionstringYesLength: 1–500
tools[].urlstring (uri)YesLength: 0–2000
tools[].paramsarray<object>NoItems: 0–8
tools[].params[].namestringYes
tools[].params[].descriptionstringNoLength: 0–200
tools[].params[].requiredbooleanNo
handoffobjectNo
handoff.keywordsarray<string>NoItems: 0–20
handoff.max_bot_repliesintegerNoRange: 1–50
handoff.on_negative_sentimentbooleanNo
handoff.messagestringNoLength: 0–500
limitsobjectNo
limits.monthly_token_capintegerNoRange: 1000–50000000
limits.max_stepsintegerNoRange: 1–6
ai_sentimentbooleanNo

Used by: PATCH /v1/apps/{appId}/ai-agents/{agentId}

UpdateApiKeyDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
scopesarray<enum>NoItems: 1–8
ip_allowlistarray<string>NoItems: 0–50
expires_atstring (date-time) | nullNo

Used by: PATCH /v1/apps/{appId}/api-keys/{keyId}

UpdateAppDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
platform_flagsobjectNo
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring (uri) | nullNo
default_languagestringNoLength: 2–10
timezonestringNoLength: 1–64
settingsobjectNo
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumNoValues: "hmac", "jwt", "both"

Used by: PATCH /v1/apps/{appId}

UpdateAppFlagDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
descriptionstring | nullNo
enabledbooleanNo
value_typeenumNoValues: "boolean", "string", "number", "json"
on_valueboolean | number | string | array<any> | map<string, any>No
off_valueboolean | number | string | array<any> | map<string, any>No
rollout_percentintegerNoRange: 0–100
segment_idstring | nullNo
rollout_schedulearray<object>NoItems: 0–10
rollout_schedule[].atstring (date-time)Yes
rollout_schedule[].percentintegerYesRange: 0–100

Used by: PATCH /v1/apps/{appId}/feature-flags/{flagId}

UpdateBudgetAlertRuleDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
ad_account_idstring | nullNo
campaign_external_idstring | nullNo
thresholdnumberNoRange: −∞–1000000000000
window_daysintegerNoRange: 1–30
recipientsarray<string (email)>NoItems: 0–20
enabledbooleanNo

Used by: PATCH /v1/apps/{appId}/ads/alert-rules/{ruleId}

UpdateCatalogDto

FieldTypeRequiredDescription
descriptionstring | nullNo
currencystringNo

Used by: PATCH /v1/apps/{appId}/catalogs/{catalogId}

UpdateCategoryDto

FieldTypeRequiredDescription
namemap<string, string>No
descriptionmap<string, string>No
channelsarray<enum> | nullNo
default_opted_inbooleanNo
positionintegerNoRange: 0–1000

Used by: PATCH /v1/apps/{appId}/categories/{categoryId}

UpdateChannelScoreConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
window_daysintegerNoRange: 7–365
min_sendsintegerNoRange: 1–100
count_email_opensbooleanNo

Used by: PUT /v1/apps/{appId}/channel-scores/config

UpdateCompanyDto

FieldTypeRequiredDescription
external_idstringNo
namestring | nullNo
domainstring | nullNo
propertiesmap<string, any>No

Used by: PATCH /v1/apps/{appId}/companies/{companyId}

UpdateContentTableDto

FieldTypeRequiredDescription
descriptionstring | nullNo

Used by: PATCH /v1/apps/{appId}/content-tables/{tableId}

UpdateCustomAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstringNoLength: 0–300
enabledbooleanNo
instructionsstringNoLength: 0–4000
toolsarray<enum>NoItems: 0–5
scheduleobject | nullNo
limitsobjectNo
limits.max_stepsintegerNoRange: 1–10
limits.monthly_token_capintegerNoRange: 1000–20000000

Used by: PATCH /v1/apps/{appId}/custom-agents/{agentId}

UpdateDataFeedDto

FieldTypeRequiredDescription
descriptionstring | nullNo
url_templatestringNoLength: 1–2048
methodenumNoValues: "GET", "POST"
body_templatestring | nullNo
headersmap<string, string>No
secret_headersmap<string, string> | nullNo
cache_ttl_secondsintegerNoRange: 0–86400
timeout_msintegerNoRange: 100–2000
enabledbooleanNo

Used by: PATCH /v1/apps/{appId}/data-feeds/{feedId}

UpdateDataSourceDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
auth_modeenumNoValues: "signature", "token"
mappingobjectNo
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectNo
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
auth_valuestringNoLength: 0–2000

Used by: PATCH /v1/apps/{appId}/data-pipelines/sources/{sourceId}

UpdateDataTransformDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstringNoLength: 0–500
enabledbooleanNo
positionintegerNoRange: 0–10000
rulesarray<object>NoItems: 0–50
codestringNoLength: 0–20000
sourcesarray<enum>NoItems: 0–6
event_namesarray<string>NoItems: 0–50

Used by: PATCH /v1/apps/{appId}/data-pipelines/transforms/{transformId}

UpdateDecisionAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "paused"
reward_eventsarray<string>NoItems: 1–10
reward_window_hoursintegerNoRange: 1–720
holdout_percentintegerNoRange: 0–50

Used by: PATCH /v1/apps/{appId}/decision-agents/{id}

UpdateFormDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
fieldsarray<object>NoItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectNo
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statusenumNoValues: "active", "archived"

Used by: PATCH /v1/apps/{appId}/forms/{formId}

UpdateGeofenceDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
latnumberNoRange: -90–90
lngnumberNoRange: -180–180
radius_mintegerNoRange: 100–50000
cooldown_minutesintegerNoRange: 0–10080
enabledbooleanNo

Used by: PATCH /v1/apps/{appId}/geofences/{geofenceId}

UpdateGlobalControlDto

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYesRange: 1–50

Used by: PUT /v1/apps/{appId}/global-control

UpdateInAppDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
triggersarray<object>NoItems: 1–5
trigger_groupsarray<array<object>>NoItems: 1–10
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
ab_testobjectNo
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
displayobjectNo
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanNo
placementstring | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: PATCH /v1/apps/{appId}/in-app-messages/{messageId}

UpdateJourneyDto

FieldTypeRequiredDescription
namestringNoLength: 2–120
descriptionstring | nullNo

Used by: PATCH /v1/apps/{appId}/journeys/{journeyId}

UpdateKeywordDto

FieldTypeRequiredDescription
keywordstringNoLength: 1–30
channelsarray<enum>NoItems: 1–3
actionsobjectNo
actions.add_tagsmap<string, string>No
actions.remove_tagsarray<string>NoItems: 0–50
actions.eventobjectNo
actions.event.namestringYes
actions.event.propertiesmap<string, string>No
actions.replyobjectNo
actions.reply.textstringYesLength: 1–1600
actions.opt_inbooleanNo
enabledbooleanNo
descriptionstring | nullNo

Used by: PATCH /v1/apps/{appId}/sms-keywords/{keywordId}

UpdateLandingPageDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
slugstringNoLength: 0–80
documentobjectNo
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
seoobjectNo
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectNo
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullNo

Used by: PATCH /v1/apps/{appId}/landing-pages/{pageId}

UpdateLiveActivityDto

FieldTypeRequiredDescription
activity_idstringYesLength: 1–100
content_statemap<string, string | number | boolean>Yes
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 0–200

Used by: POST /v1/apps/{appId}/live-activities/{activityType}/update

UpdateLiveActivityTypeDto

FieldTypeRequiredDescription
descriptionstring | nullNo
content_state_schemaobjectNo
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectNo
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 0–50

Used by: PATCH /v1/apps/{appId}/live-activities/types/{activityType}

UpdateNodeDto

FieldTypeRequiredDescription
datamap<string, any>No
positionobjectNo
position.xnumberYes
position.ynumberYes

Used by: PATCH /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}

UpdatePredictionDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
enabledbooleanNo
event_namesarray<string>NoItems: 1–10
horizon_daysintegerNoRange: 7–90

Used by: PATCH /v1/apps/{appId}/predictions/{id}

UpdatePromoCodeListDto

FieldTypeRequiredDescription
descriptionstring | nullNo
expires_atstring (date-time) | nullNo

Used by: PATCH /v1/apps/{appId}/promo-code-lists/{listId}

UpdateRecommendationConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
view_eventsarray<string>NoItems: 0–10
purchase_eventsarray<string>NoItems: 0–10
item_propertystringNo
window_daysintegerNoRange: 7–365

Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config

UpdateReverseEtlDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
scheduleenumNoValues: "every_5_minutes", "hourly", "daily"
enabledbooleanNo
configmap<string, any>No
credentialsmap<string, any>No

Used by: PATCH /v1/apps/{appId}/reverse-etl/{syncId}

UpdateRfmConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
event_namesarray<string>YesItems: 1–10
value_propertystring | nullNo
use_monetarybooleanNo
window_daysintegerNoRange: 30–730

Used by: PUT /v1/apps/{appId}/rfm/config

UpdateSavedReportDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
definitionobjectNo
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>NoDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>NoDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumNoValues: "asc", "desc"; Default: "desc"
definition.limitintegerNoDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No

Used by: PATCH /v1/apps/{appId}/analytics/reports/{id}

UpdateSiteSearchSettingsDto

FieldTypeRequiredDescription
enabledbooleanNo
ai_answersbooleanNo
allowed_originsarray<string>NoItems: 0–20
languagestringNo
monthly_token_capintegerNoRange: 1000–50000000
query_retention_daysintegerNoRange: 7–365

Used by: PATCH /v1/apps/{appId}/site-search/settings

UpdateSiteSearchSourceDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
kindenumNoValues: "sitemap", "urls"
urlstringNoLength: 0–2000
urlsarray<string>NoItems: 1–500
max_pagesintegerNoRange: 1–2000
refresh_hoursinteger | nullNo
enabledbooleanNo

Used by: PATCH /v1/apps/{appId}/site-search/sources/{sourceId}

UpdateSqlSegmentDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
descriptionstring | nullNo
querystringNoLength: 1–20000
refresh_interval_minutesinteger | nullNo

Used by: PATCH /v1/apps/{appId}/sql/segments/{segmentId}

UpdateSurveyDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
questionsarray<object>NoItems: 1–10
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].textmap<string, string>Yes
questions[].requiredbooleanNo
questions[].optionsarray<object>NoItems: 0–30
questions[].options[].valuestringYesLength: 1–100
questions[].options[].labelmap<string, string>Yes
questions[].low_labelmap<string, string>No
questions[].high_labelmap<string, string>No
questions[].placeholdermap<string, string>No
settingsobjectNo
settings.thank_youmap<string, string>No
settings.submit_labelmap<string, string>No
settings.write_propertiesbooleanNo
settings.allow_multiplebooleanNo
settings.default_languagestringNoLength: 2–10

Used by: PATCH /v1/apps/{appId}/surveys/{surveyId}

UpdateTemplateDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
channelenum | nullNo
tagsarray<string>NoItems: 0–20
contentobjectNo
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.listobjectNo
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo

Used by: PATCH /v1/apps/{appId}/templates/{templateId}

UpdateWalletConfigDto

FieldTypeRequiredDescription
appleobject | nullNo
googleobject | nullNo

Used by: PUT /v1/apps/{appId}/wallet/config

UpdateWalletPassDto

FieldTypeRequiredDescription
barcode_valuestringNoLength: 1–500
valuesmap<string, string>No

Used by: PATCH /v1/apps/{appId}/wallet/passes/{id}

UpdateWalletTemplateDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "archived"
designobjectNo
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringNoDefault: "#ffffff"
design.foreground_colorstringNoDefault: "#111111"
design.label_colorstringNoDefault: "#555555"
design.barcodeenumNoValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>NoDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringNoDefault: ""; Length: 0–60
design.fields[].valuestringNoDefault: ""; Length: 0–500
design.fields[].sectionenumNoValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesmap<string, string>No

Used by: PATCH /v1/apps/{appId}/wallet/templates/{id}

UpdateWarehouseConnectionDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
configmap<string, any>No
credentialsmap<string, any>No

Used by: PATCH /v1/apps/{appId}/warehouse-segments/connections/{connectionId}

UpdateWarehouseExportDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
tablesarray<enum>NoItems: 1–6
scheduleenumNoValues: "every_15_minutes", "hourly", "daily"
enabledbooleanNo
configmap<string, any>No
credentialsmap<string, any>No

Used by: PATCH /v1/apps/{appId}/warehouse-exports/{exportId}

UpdateWarehouseSegmentDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
descriptionstring | nullNo
connection_idstringNoLength: 1–∞
querystringNoLength: 1–20000
id_columnstringNo
id_typeenumNoValues: "external_id", "user_id"
refresh_interval_minutesinteger | nullNo
limitsobjectNo
limits.timeout_secondsintegerNoRange: 10–600
limits.max_rowsintegerNoRange: 1–1000000
limits.max_bytes_billedintegerNoRange: 10485760–10995116277760
limits.max_warehouse_sizeenum | nullNo

Used by: PATCH /v1/apps/{appId}/warehouse-segments/segments/{segmentId}

UpdateWarmupPlanDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "paused"
daily_limitsarray<integer>NoItems: 1–120
provider_sharesobject | nullNo

Used by: PATCH /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}

UpdateWebCampaignDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
displayobjectNo
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
triggerobjectNo
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectNo
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: PATCH /v1/apps/{appId}/web-campaigns/{campaignId}

UpdateWebhookDto

FieldTypeRequiredDescription
urlstringNoLength: 1–2048
descriptionstring | nullNo
eventsarray<enum>NoItems: 1–41
event_filtersobjectNo
event_filters.event_namesarray<string>NoItems: 0–50
batchbooleanNo
headersmap<string, string> | nullNo
statusenumNoValues: "active", "disabled"
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo

Used by: PATCH /v1/apps/{appId}/webhooks/{webhookId}

UpdateWebPersonalizationDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
changesarray<object>NoItems: 0–20
variantsarray<object>NoItems: 0–4
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
goalobject | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Used by: PATCH /v1/apps/{appId}/web-personalizations/{personalizationId}

UpsertCatalogItemsDto

FieldTypeRequiredDescription
itemsarray<object>YesItems: 1–1000
items[].idstringYesLength: 1–128
items[].titlestringYesLength: 1–300
items[].descriptionstring | nullNo
items[].image_urlstring (url) | nullNo
items[].urlstring (url) | nullNo
items[].pricenumber | nullNo
items[].sale_pricenumber | nullNo
items[].currencystringNo
items[].categorystring | nullNo
items[].brandstring | nullNo
items[].in_stockbooleanNo
items[].attributesmap<string, string>No

Used by: PUT /v1/apps/{appId}/catalogs/{catalogId}/items

UpsertCompanyDto

FieldTypeRequiredDescription
external_idstringYes
namestring | nullNo
domainstring | nullNo
propertiesmap<string, any>No

Used by: POST /v1/apps/{appId}/companies

UpsertUserDto

FieldTypeRequiredDescription
identityobjectNo
identity.external_idstringYesLength: 1–255
external_idstringNoLength: 1–255
propertiesmap<string, any>No
tagsmap<string, string>No
subscriptionsarray<object>NoItems: 0–20
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYesLength: 1–4096
subscriptions[].deviceobjectNoDefault: {}
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].statusenumNoValues: "subscribed", "unsubscribed"
subscriptions[].opt_inobjectNo
subscriptions[].opt_in.sourcestringYesLength: 1–100
subscriptions[].opt_in.atstring (date-time)No

Used by: POST /v1/apps/{appId}/users

UsageReport

FieldTypeRequiredDescription
org_idstringYes
plan_codestringYes
periodobjectYes
period.startstringYes
period.endstringYes
metricsarray<object>Yes
metrics[].metricstringYes
metrics[].usednumberYes
metrics[].limitnumber | nullYes
metrics[].percentnumber | nullYes
metrics[].hardbooleanYes
appsarray<object>Yes
apps[].app_idstringYes
apps[].namestringYes
apps[].messages_sentnumberYes
apps[].active_subscriptionsnumberYes
apps[].maunumberYes
dailyarray<object>Yes
daily[].datestringYes
daily[].messages_sentnumberYes
daily[].api_requestsnumberYes
daily[].events_ingestednumberYes
trialingbooleanYes
trial_ends_atstring | nullYes
overageobject | nullNo

Used by: GET /v1/organization/usage

User

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes

UserAffinity

FieldTypeRequiredDescription
user_idstringYes
affinitiesarray<object>Yes
affinities[].attributestringYes
affinities[].valuestringYes
affinities[].scorenumberYes
affinities[].rankintegerYes
weekly_capinteger | nullYes
engagementnumber | nullYes
computed_atstring | nullYes

Used by: GET /v1/apps/{appId}/affinity/users/{userId}

UserCompanyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].companyobjectYes
data[].company.idstringYes
data[].company.external_idstringYes
data[].company.namestring | nullYes
data[].company.domainstring | nullYes
data[].company.propertiesmap<string, any>Yes
data[].rolestringYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/users/{userId}/companies, GET /v1/apps/{appId}/users/by/{label}/{value}/companies

UserDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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

FieldTypeRequiredDescription
exported_atstringYes
userobjectYes
user.idstringYes
user.app_idstringYes
user.external_idstring | nullYes
user.propertiesmap<string, any>Yes
user.tagsmap<string, string>Yes
user.first_seen_atstringYes
user.last_active_atstringYes
user.session_countintegerYes
user.usage_secondsintegerYes
user.merged_intostring | nullYes
user.last_ipstring | nullYes
user.last_ip_atstring | nullYes
user.last_sentimentenum | nullYes
user.last_sentiment_atstring | nullYes
user.created_atstringYes
user.updated_atstringYes
user.subscription_countintegerYes
user.channelsarray<enum>Yes
user.aliasesarray<object>Yes
user.aliases[].labelstringYes
user.aliases[].valuestringYes
user.subscriptionsarray<object>Yes
user.subscriptions[].idstringYes
user.subscriptions[].app_idstringYes
user.subscriptions[].user_idstring | nullYes
user.subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
user.subscriptions[].tokenstringYes
user.subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
user.subscriptions[].unsubscribe_reasonenum | nullYes
user.subscriptions[].deviceobjectYes
user.subscriptions[].test_devicebooleanYes
user.subscriptions[].test_device_namestring | nullYes
user.subscriptions[].last_active_atstringYes
user.subscriptions[].last_sent_atstring | nullYes
user.subscriptions[].last_delivered_atstring | nullYes
user.subscriptions[].opted_in_atstring | nullYes
user.subscriptions[].opt_in_sourcestring | nullYes
user.subscriptions[].unsubscribed_atstring | nullYes
user.subscriptions[].locationobject | nullYes
user.subscriptions[].created_atstringYes
eventsarray<object>Yes
events[].idstringYes
events[].user_idstring | nullYes
events[].subscription_idstring | nullYes
events[].namestringYes
events[].propertiesmap<string, any>Yes
events[].valuenumber | nullYes
events[].sourceenumYesValues: "sdk", "api", "system", "import"
events[].occurred_atstringYes
derivedobjectYes
derived.wallet_passesarray<object>Yes
derived.wallet_passes[].idstringYes
derived.wallet_passes[].template_idstringYes
derived.wallet_passes[].statusstringYes
derived.wallet_passes[].barcode_valuestringYes
derived.wallet_passes[].valuesmap<string, string>Yes
derived.wallet_passes[].created_atstringYes
derived.wallet_passes[].updated_atstringYes
derived.rfmobject | nullYes
derived.predictionsarray<object>Yes
derived.predictions[].modelstringYes
derived.predictions[].scorenumberYes
derived.predictions[].computed_atstringYes
derived.channel_scoresarray<object>Yes
derived.channel_scores[].channelstringYes
derived.channel_scores[].sendsnumberYes
derived.channel_scores[].engagednumberYes
derived.channel_scores[].scorenumberYes
derived.channel_scores[].is_bestbooleanYes
derived.channel_scores[].computed_atstringYes
derived.decisionsarray<object>Yes
derived.decisions[].agentstringYes
derived.decisions[].arm_idstringYes
derived.decisions[].contextstringYes
derived.decisions[].assigned_atstringYes
derived.decisions[].rewarded_atstring | nullYes
derived.recommendationsarray<object>Yes
derived.recommendations[].catalog_idstringYes
derived.recommendations[].personalizedarray<string>Yes
derived.recommendations[].recentarray<string>Yes
derived.recommendations[].purchasedarray<string>Yes
derived.recommendations[].computed_atstringYes
derived.affinitiesarray<object>Yes
derived.affinities[].attributestringYes
derived.affinities[].valuestringYes
derived.affinities[].scorenumberYes
derived.affinities[].ranknumberYes
derived.affinities[].computed_atstringYes
derived.frequency_capobject | nullYes
derived.companiesarray<object>Yes
derived.companies[].company_idstringYes
derived.companies[].external_idstringYes
derived.companies[].namestring | nullYes
derived.companies[].rolestringYes
derived.companies[].joined_atstringYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/export

UserIdentity

FieldTypeRequiredDescription
identitymap<string, string>Yes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/identity, GET /v1/apps/{appId}/subscriptions/{subscriptionId}/user/identity

UserJourneyRuns

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].journey_idstringYes
data[].versionintegerYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullYes
data[].next_action_atstring | nullYes
data[].entered_atstringYes
data[].completed_atstring | nullYes
data[].exit_reasonstring | nullYes
data[].goal_idstring | nullYes
data[].goal_reached_atstring | nullYes
data[].contextmap<string, any>Yes
data[].journey_namestringYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/journeys

UserList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].external_idstring | nullYes
data[].propertiesmap<string, any>Yes
data[].tagsmap<string, string>Yes
data[].first_seen_atstringYes
data[].last_active_atstringYes
data[].session_countintegerYes
data[].usage_secondsintegerYes
data[].merged_intostring | nullYes
data[].last_ipstring | nullYes
data[].last_ip_atstring | nullYes
data[].last_sentimentenum | nullYes
data[].last_sentiment_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].subscription_countintegerYes
data[].channelsarray<enum>Yes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/users, POST /v1/apps/{appId}/users/search

UserMessageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].delivery_idstringYes
data[].message_idstringYes
data[].campaign_idstring | nullYes
data[].sourcestringYes
data[].channelstringYes
data[].statusstringYes
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].error_codestring | nullYes
data[].created_atstringYes
data[].sent_atstring | nullYes
data[].delivered_atstring | nullYes
data[].opened_atstring | nullYes
data[].clicked_atstring | nullYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/messages

UserPreferences

FieldTypeRequiredDescription
user_idstringYes
dataarray<object>Yes
data[].categorystringYes
data[].channelstring | nullYes
data[].opted_inbooleanYes
data[].explicitbooleanYes
data[].sourcestring | nullYes
data[].updated_atstring | nullYes
categoriesarray<object>Yes
categories[].idstringYes
categories[].app_idstringYes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes
categories[].positionintegerYes
categories[].opted_out_usersintegerYes
categories[].created_atstringYes
categories[].updated_atstringYes
consentsarray<object>Yes
consents[].purposeenumYesValues: "ads_personalization"
consents[].grantedbooleanYes
consents[].sourcestring | nullYes
consents[].updated_atstring | nullYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/preferences, PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences

UserTimeline

FieldTypeRequiredDescription
dataarray<object>Yes
data[].kindenumYesValues: "event", "delivery"
data[].atstringYes
data[].titlestringYes
data[].detailstringYes

Used by: GET /v1/apps/{appId}/users/by/{label}/{value}/timeline

VerifyAddressDto

FieldTypeRequiredDescription
addressstringYesLength: 3–320

Used by: POST /v1/apps/{appId}/email-deliverability/verify-address

WalletConfig

FieldTypeRequiredDescription
appleobjectYes
apple.configuredbooleanYes
apple.pass_type_idstring | nullYes
apple.team_idstring | nullYes
apple.certificate_expires_atstring | nullYes
googleobjectYes
google.configuredbooleanYes
google.issuer_idstring | nullYes

Used by: GET /v1/apps/{appId}/wallet/config, PUT /v1/apps/{appId}/wallet/config

WalletPass

FieldTypeRequiredDescription
idstringYes
template_idstringYes
user_idstring | nullYes
external_idstring | nullYes
barcode_valuestringYes
valuesmap<string, string>Yes
statusenumYesValues: "active", "voided"
urlstringYes
apple_urlstringYes
google_urlstringYes
apple_devicesintegerYes
versionintegerYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].template_idstringYes
data[].user_idstring | nullYes
data[].external_idstring | nullYes
data[].barcode_valuestringYes
data[].valuesmap<string, string>Yes
data[].statusenumYesValues: "active", "voided"
data[].urlstringYes
data[].apple_urlstringYes
data[].google_urlstringYes
data[].apple_devicesintegerYes
data[].versionintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes

Used by: GET /v1/apps/{appId}/wallet/passes

WalletTemplate

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "coupon", "loyalty", "event", "generic"
statusenumYesValues: "active", "archived"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringYesDefault: "#ffffff"
design.foreground_colorstringYesDefault: "#111111"
design.label_colorstringYesDefault: "#555555"
design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>YesDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringYesDefault: ""; Length: 0–60
design.fields[].valuestringYesDefault: ""; Length: 0–500
design.fields[].sectionenumYesValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesarray<string>Yes
passesintegerYes
created_atstringYes
updated_atstringYes

Used by: POST /v1/apps/{appId}/wallet/templates, GET /v1/apps/{appId}/wallet/templates/{id}, PATCH /v1/apps/{appId}/wallet/templates/{id}

WalletTemplateList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].kindenumYesValues: "coupon", "loyalty", "event", "generic"
data[].statusenumYesValues: "active", "archived"
data[].designobjectYes
data[].design.titlestringYesLength: 1–100
data[].design.descriptionstringYesLength: 1–300
data[].design.organizationstringYesLength: 1–100
data[].design.background_colorstringYesDefault: "#ffffff"
data[].design.foreground_colorstringYesDefault: "#111111"
data[].design.label_colorstringYesDefault: "#555555"
data[].design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
data[].design.fieldsarray<object>YesDefault: []; Items: 0–12
data[].design.expires_atstring (date-time) | nullNo
data[].design.relevant_atstring (date-time) | nullNo
data[].imagesarray<string>Yes
data[].passesintegerYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/wallet/templates

WarehouseConnectionResult

FieldTypeRequiredDescription
okbooleanYes
detailstring | nullYes
errorobject | nullYes

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
configmap<string, any>Yes
credentials_hintstringYes
tablesarray<enum>Yes
scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
enabledbooleanYes
statusenumYesValues: "active", "paused", "failing"
consecutive_failuresintegerYes
last_errorstring | nullYes
cursorsmap<string, object>Yes
schema_versionsmap<string, integer>Yes
last_run_atstring | nullYes
last_success_atstring | nullYes
next_run_atstring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
data[].configmap<string, any>Yes
data[].credentials_hintstringYes
data[].tablesarray<enum>Yes
data[].scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
data[].enabledbooleanYes
data[].statusenumYesValues: "active", "paused", "failing"
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].cursorsmap<string, object>Yes
data[].schema_versionsmap<string, integer>Yes
data[].last_run_atstring | nullYes
data[].last_success_atstring | nullYes
data[].next_run_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/warehouse-exports

WarehouseExportRun

FieldTypeRequiredDescription
idstringYes
export_idstringYes
triggerenumYesValues: "schedule", "manual"
statusenumYesValues: "queued", "running", "succeeded", "failed"
tablesmap<string, object>Yes
row_countintegerYes
attemptintegerYes
errorstring | nullYes
started_atstring | nullYes
finished_atstring | nullYes
duration_msinteger | nullYes
created_atstringYes

Used by: POST /v1/apps/{appId}/warehouse-exports/{exportId}/run

WarehouseExportRunPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].export_idstringYes
data[].triggerenumYesValues: "schedule", "manual"
data[].statusenumYesValues: "queued", "running", "succeeded", "failed"
data[].tablesmap<string, object>Yes
data[].row_countintegerYes
data[].attemptintegerYes
data[].errorstring | nullYes
data[].started_atstring | nullYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/warehouse-exports/{exportId}/runs

WarehouseSegmentConnection

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
typeenumYesValues: "bigquery", "snowflake", "databricks"
configmap<string, any>Yes
credentials_hintstringYes
segment_countintegerYes
last_tested_atstring | nullYes
last_test_errorstring | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].typeenumYesValues: "bigquery", "snowflake", "databricks"
data[].configmap<string, any>Yes
data[].credentials_hintstringYes
data[].segment_countintegerYes
data[].last_tested_atstring | nullYes
data[].last_test_errorstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/warehouse-segments/connections

WarehouseSegmentConnectionTest

FieldTypeRequiredDescription
okbooleanYes
errorobject | nullYes

Used by: POST /v1/apps/{appId}/warehouse-segments/connections/{connectionId}/test

WarehouseSegmentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].definitionmap<string, any>Yes
data[].is_dynamicbooleanYes
data[].estimated_countinteger | nullYes
data[].estimated_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].sqlobject | nullYes
data[].warehouseobject | nullYes

Used by: GET /v1/apps/{appId}/warehouse-segments/segments

WarehouseSegmentOptions

FieldTypeRequiredDescription
typesarray<enum>Yes
id_typesarray<enum>Yes
snowflake_warehouse_sizesarray<enum>Yes
refresh_intervalsarray<integer>Yes
limitsobjectYes
limits.query_maxintegerYes
limits.timeout_default_secondsintegerYes
limits.timeout_min_secondsintegerYes
limits.timeout_max_secondsintegerYes
limits.max_rows_defaultintegerYes
limits.max_rows_maxintegerYes
limits.max_bytes_billed_defaultintegerYes
limits.max_bytes_billed_minintegerYes
limits.max_bytes_billed_maxintegerYes
limits.preview_sampleintegerYes
limits.connections_per_appintegerYes

Used by: GET /v1/apps/{appId}/warehouse-segments/options

WarehouseSegmentPreview

FieldTypeRequiredDescription
run_idstringYes
modeenumYesValues: "dry_run", "sample"
estimated_bytesnumber | nullYes
max_bytes_billednumber | nullYes
within_limitbooleanYes
samplearray<string> | nullYes
sample_truncatedbooleanYes
sample_matchedinteger | nullYes
duration_msintegerYes

Used by: POST /v1/apps/{appId}/warehouse-segments/preview

WarehouseSegmentRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].segment_idstring | nullYes
data[].connection_idstring | nullYes
data[].warehouse_typeenumYesValues: "bigquery", "snowflake", "databricks"
data[].sourceenumYesValues: "panel", "api", "schedule"
data[].actor_idstring | nullYes
data[].querystringYes
data[].query_hashstringYes
data[].statusenumYesValues: "ok", "rejected", "timeout", "failed"
data[].reasonenum | nullYes
data[].errorstring | nullYes
data[].row_countintegerYes
data[].matched_countinteger | nullYes
data[].bytes_processednumber | nullYes
data[].truncatedbooleanYes
data[].duration_msintegerYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/warehouse-segments/runs

WarehouseTables

FieldTypeRequiredDescription
dataarray<object>Yes
data[].nameenumYesValues: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions"
data[].modeenumYesValues: "incremental", "snapshot"
data[].schema_versionintegerYes
data[].cursor_columnstring | nullYes
data[].columnsarray<object>Yes
data[].columns[].namestringYes
data[].columns[].typestringYes
data[].columns[].nullablebooleanYes

Used by: GET /v1/apps/{appId}/warehouse-exports/tables

WebCampaign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
data[].display.positionenumNoValues: "left", "right"
data[].display.background_colorstringNo
data[].display.text_colorstringNo
data[].display.dismissiblebooleanNo
data[].display.auto_dismiss_secondsintegerNoRange: 1–300
data[].display.max_widthintegerNoRange: 280–960
data[].display.blocksarray<object>YesItems: 0–12
data[].display.form_idstring | nullNo
data[].display.survey_idstring | nullNo
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].displayobjectYes
data[].ab_testobjectYes
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
data[].triggerobjectYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.included_segmentsarray<string>NoItems: 0–20
data[].targeting.excluded_segmentsarray<string>NoItems: 0–20
data[].targeting.visitorenumNoValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>NoItems: 0–3
data[].frequencyobjectYes
data[].frequency.max_per_sessionintegerNoRange: 1–100
data[].frequency.max_per_dayintegerNoRange: 1–100
data[].frequency.max_totalintegerNoRange: 1–1000
data[].frequency.hide_after_close_daysintegerNoRange: 0–365
data[].frequency.stop_after_conversionbooleanNo
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.impressionsintegerYes
data[].stats.clicksintegerYes
data[].stats.closesintegerYes
data[].stats.conversionsintegerYes
data[].stats.unique_visitorsintegerYes
data[].stats.ctrnumberYes
data[].stats.conversion_ratenumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].variant_idstringYes
data[].variant_stats[].impressionsintegerYes
data[].variant_stats[].clicksintegerYes
data[].variant_stats[].conversionsintegerYes
data[].variant_stats[].ctrnumberYes
data[].variant_stats[].conversion_ratenumberYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/web-campaigns

WebCampaignReport

FieldTypeRequiredDescription
campaign_idstringYes
daysintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].impressionsintegerYes
daily[].clicksintegerYes
daily[].closesintegerYes
daily[].conversionsintegerYes
totalsobjectYes
totals.impressionsintegerYes
totals.clicksintegerYes
totals.closesintegerYes
totals.conversionsintegerYes
totals.unique_visitorsintegerYes
totals.ctrnumberYes
totals.conversion_ratenumberYes

Used by: GET /v1/apps/{appId}/web-campaigns/{campaignId}/report

WebCampaignStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "paused", "archived"

Used by: POST /v1/apps/{appId}/web-campaigns/{campaignId}/status

WebCampaignWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Used by: POST /v1/apps/{appId}/web-campaigns/{campaignId}/winner

Webhook

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes

Used by: GET /v1/apps/{appId}/webhooks/{webhookId}, PATCH /v1/apps/{appId}/webhooks/{webhookId}

WebhookBulkReplayResult

FieldTypeRequiredDescription
replayedintegerYes

Used by: POST /v1/apps/{appId}/webhooks/{webhookId}/replay

WebhookDeliveryDetail

FieldTypeRequiredDescription
idstringYes
endpoint_idstringYes
event_typestringYes
event_idstringYes
subject_idstring | nullYes
attemptintegerYes
statusenumYesValues: "pending", "success", "failed", "dead"
response_statusinteger | nullYes
response_body_excerptstring | nullYes
errorstring | nullYes
duration_msinteger | nullYes
next_retry_atstring | nullYes
delivered_atstring | nullYes
replay_ofstring | nullYes
created_atstringYes
payloadmap<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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].endpoint_idstringYes
data[].event_typestringYes
data[].event_idstringYes
data[].subject_idstring | nullYes
data[].attemptintegerYes
data[].statusenumYesValues: "pending", "success", "failed", "dead"
data[].response_statusinteger | nullYes
data[].response_body_excerptstring | nullYes
data[].errorstring | nullYes
data[].duration_msinteger | nullYes
data[].next_retry_atstring | nullYes
data[].delivered_atstring | nullYes
data[].replay_ofstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/webhooks/{webhookId}/deliveries

WebhookEventTypes

FieldTypeRequiredDescription
dataarray<string>Yes

Used by: GET /v1/apps/{appId}/webhooks/event-types

WebhookList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].urlstringYes
data[].descriptionstring | nullYes
data[].eventsarray<string>Yes
data[].event_filtersobjectYes
data[].event_filters.event_namesarray<string>No
data[].batchbooleanYes
data[].statusenumYesValues: "active", "failing", "disabled"
data[].disabled_reasonstring | nullYes
data[].failure_countintegerYes
data[].failing_sincestring | nullYes
data[].last_success_atstring | nullYes
data[].last_failure_atstring | nullYes
data[].header_namesarray<string>Yes
data[].previous_secret_expires_atstring | nullYes
data[].body_templatestring | nullYes
data[].body_content_typeenumYesValues: "application/json", "text/plain"
data[].filtersobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Used by: GET /v1/apps/{appId}/webhooks

WebhookPreviewDto

FieldTypeRequiredDescription
event_typeenumYesValues: "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"
datamap<string, any>No
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo
batchbooleanNo

Used by: POST /v1/apps/{appId}/webhooks/preview

WebhookPreviewResult

FieldTypeRequiredDescription
payloadmap<string, any>Yes
matchedbooleanYesWhether the event passes the filter (if not, it is not sent).
failed_conditionsarray<object>Yes
failed_conditions[].fieldstringYes
failed_conditions[].opstringYes
failed_conditions[].valueanyNo
bodystring | nullYes
content_typestringYes
errorobject | nullYes

Used by: POST /v1/apps/{appId}/webhooks/preview

WebhookSecret

FieldTypeRequiredDescription
secretstringYes

WebhookWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes
secretstringYesReturned only once, in the create and rotation responses.

Used by: POST /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks/{webhookId}/rotate-secret

WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].changesarray<object>Yes
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].changesarray<object>YesItems: 0–20
data[].ab_testobjectYes
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.included_segmentsarray<string>NoItems: 0–20
data[].targeting.excluded_segmentsarray<string>NoItems: 0–20
data[].targeting.visitorenumNoValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>NoItems: 0–3
data[].goalobject | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.visitorsintegerYes
data[].stats.conversionsintegerYes
data[].stats.conversion_ratenumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].visitorsintegerYes
data[].variant_stats[].conversionsintegerYes
data[].variant_stats[].conversion_ratenumberYes
data[].variant_stats[].variant_idstringYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Used by: GET /v1/apps/{appId}/web-personalizations

WebPersonalizationReport

FieldTypeRequiredDescription
personalization_idstringYes
daysintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].visitorsintegerYes
daily[].conversionsintegerYes
totalsobjectYes
totals.visitorsintegerYes
totals.conversionsintegerYes
totals.conversion_ratenumberYes

Used by: GET /v1/apps/{appId}/web-personalizations/{personalizationId}/report

WebPersonalizationStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "paused", "archived"

Used by: POST /v1/apps/{appId}/web-personalizations/{personalizationId}/status

WebPersonalizationWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Used by: POST /v1/apps/{appId}/web-personalizations/{personalizationId}/winner

WhatsAppTemplateList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].external_idstring | nullYes
data[].namestringYes
data[].languagestringYes
data[].categorystringYes
data[].statusstringYes
data[].componentsarray<map<string, any>>Yes
data[].body_paramsintegerYes
data[].rejected_reasonstring | nullYes
data[].quality_scorestring | nullYes
data[].synced_atstringYes

Used by: GET /v1/apps/{appId}/whatsapp/templates

WhatsAppTemplateSync

FieldTypeRequiredDescription
totalintegerYes
removedintegerYes
dataarray<object>Yes
data[].idstringYes
data[].external_idstring | nullYes
data[].namestringYes
data[].languagestringYes
data[].categorystringYes
data[].statusstringYes
data[].componentsarray<map<string, any>>Yes
data[].body_paramsintegerYes
data[].rejected_reasonstring | nullYes
data[].quality_scorestring | nullYes
data[].synced_atstringYes

Used by: POST /v1/apps/{appId}/whatsapp/templates/sync

ZapierHook

FieldTypeRequiredDescription
idstringYes
eventstringYes
event_namestring | nullYes
target_urlstringYes
last_delivered_atstring | nullYes
failure_countintegerYes
created_atstringYes

Used by: POST /v1/apps/{appId}/integrations/zapier/hooks

ZapierHookList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].eventstringYes
data[].event_namestring | nullYes
data[].target_urlstringYes
data[].last_delivered_atstring | nullYes
data[].failure_countintegerYes
data[].created_atstringYes

Used by: GET /v1/apps/{appId}/integrations/zapier/hooks

ZapierMe

FieldTypeRequiredDescription
app_idstringYes
app_namestringYes
org_idstringYes
scopesarray<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

FieldTypeRequiredDescription
target_urlstringYesLength: 1–2000
eventenumYesValues: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed"
event_namestringNoLength: 1–100

Used by: POST /v1/apps/{appId}/integrations/zapier/hooks

On this page

IndexAcceptInviteResultAccountAccountExportAdAccountAdAccountListAdAttributionReportAdAudienceAdAudienceListAdAudienceSyncListAdAudienceSyncQueuedAdBudgetAlertListAdBudgetAlertRuleAdBudgetAlertRuleListAdCampaignCreatedAdCampaignPreviewAdCapiConfigAdCapiConfigListAdCapiDeliveryAdCapiDeliveryListAdCapiTestResultAdCreativeAddAliasDtoAddSubscriptionDtoAdEntityAdEntityListAdLtvReportAdOAuthPendingAdOAuthStartResultAdOkAdPageListAdPlatformListAdRefreshQueuedAdReportingSettingsAdReportingSettingsInputDtoAdSpendReportAffinityConfigAffinityOverviewAgentUpdateDtoAiAgentAiAgentListAiAgentMetricsAiAgentRunListAiAgentWithSecretAiConversationSummaryAiGlossaryEntryAiGlossaryListAiPanelApplyResultAiPanelResultAiReplySuggestionsAiSettingsAiStatusAiSubjectScoreResultAiSuggestionsAiTranslateResultAiTranslationAiTranslationListAiUsageReportAiVariantsResultAndroidDeliveryReportApiEventsDtoApiKeyApiKeyListAppAppFlagAppFlagEvaluationAppFlagListAppListAppTransferAppTransferListAssignmentRuleAssignmentRuleInputDtoAssignmentRuleListAssignmentRuleUpdateDtoAuditActionsAuditEntryAuditPageAuthConfigBatchMembersDtoBatchUpsertCompaniesDtoBillingStatusBrandingBrandKitExtractBrandResolutionBulkReplayDtoCampaignCampaignAgentConfigCampaignEmailRiskCampaignPageCampaignPreflightReportCampaignProposalCampaignProposalDraftCampaignProposalListCampaignStatsCampaignVariantStatsCannedInputDtoCannedResponseCannedResponseListCannedResponseRenderCannedUpdateDtoCatalogCatalogItemCatalogItemsPageCatalogListCatalogUpsertResultCellHandoffCellHandoffResultCellListCellOrgListChannelConfigChannelHookChannelListChannelScoreConfigChannelScoreOverviewChannelScoreUserChannelScoreUsersPageChannelStatusListChannelValidationCheckoutResultCheckVerifyDtoCleanupResultCompanyCompanyBatchResultCompanyListCompanyMemberCompanyMemberBatchResultCompanyMemberListContentCardContentCardListContentTableContentTableListContentTableRowsConversationConversationActivityConversationAssignDtoConversationContactConversationMessagePageConversationPageConversationReplyDtoConversationReplyResultConversationTagsDtoConversationTagsResultConversationUpdateDtoConversionsReportCopyTemplateDtoCreateAdAudienceDtoCreateAdCampaignDtoCreateAiAgentDtoCreateAppApiKeyDtoCreateAppDtoCreateAppFlagDtoCreateBudgetAlertRuleDtoCreateCatalogDtoCreateCategoryDtoCreateCustomAgentDtoCreatedApiKeyCreateDataFeedDtoCreateDataSourceDtoCreateDataTransformDtoCreateDecisionAgentDtoCreateExportDtoCreateFormDtoCreateGeofenceDtoCreateIdentityKeyDtoCreateInAppDtoCreateKeywordDtoCreateLandingPageDtoCreateLiveActivityTypeDtoCreateLookalikeDtoCreateMessengerLinkDtoCreateNotificationDtoCreateNotificationResultCreatePredictionDtoCreatePromoCodeListDtoCreateSavedReportDtoCreateSetupAppDtoCreateSiteSearchSourceDtoCreateSqlSegmentDtoCreateSuppressionDtoCreateSurveyDtoCreateTemplateDtoCreateWalletTemplateDtoCreateWarehouseConnectionDtoCreateWarehouseSegmentDtoCreateWarmupPlanDtoCreateWebCampaignDtoCreateWebhookDtoCreateWebPersonalizationDtoCustomAgentCustomAgentDraftCustomAgentDraftListCustomAgentListCustomAgentRunCustomAgentRunListCustomDomainCustomDomainListDataFeedDataFeedListDataFeedTestResultDataQuarantineDiscardResultDataQuarantineListDataQuarantineReprocessResultDataSourceDataSourceListDataSourceRunResultDataSourceWithSecretDataTransformDataTransformListDataTransformPreviewDecideDtoDecisionAgentDecisionAgentListDecisionReportDecisionResultDeliverabilitySettingsDtoDeliveryDeliveryListDiscardQuarantineDtoEmailAddressCheckEmailBounceStatsEmailDeliverabilitySettingsEmailDesignEmailDesignPageEmailDesignPreviewEmailHygieneRunEmailHygieneStartEmailHygieneStatusEmailHygieneSuppressEmailProviderInsightsEmailSavedBlockEmailSavedBlockListEmailWarmupPlanEmailWarmupPlanListEmailWarmupUsageEndLiveActivityDtoEngagementReportEstimateAudienceDtoEstimateAudienceResultEvaluateAppFlagsDtoEventDefinitionEventDefinitionDetailEventDefinitionListEventListEventsAcceptedEventsReportExportExportListFormFormPageFormSubmissionFormSubmissionPageFormSubmitResultFunnelBodyDtoFunnelReportGeofenceGeofenceListGlobalControlGlobalControlReportIdentityKeyIdentityKeyListImportImportListInAppMessageInAppMessagePageInAppStatusDtoInAppTemplateInAppTemplateListInAppWinnerDtoInboxAgentInboxAgentListInboxItemInboxMetricsInboxPageInboxReadAllResultInboxSettingsInboxSettingsUpdateDtoInboxTeamInboxTeamListIntegrationIntegrationListIntegrationOkIntegrationRunListIntegrationSyncResultIntegrationTestResultInviteInviteListInvitePreviewInvoiceListIssueWalletPassDtoJourneyJourneyDetailJourneyPageJourneyPublishResultJourneyRunJourneyRunDetailJourneyRunPageJourneyStatsJourneyTriggerResultJourneyVersionListLandingPageLandingPageListLandingPageVersionsLandingPreviewResultLiveActivitySendResultLiveActivityTokenResultLiveActivityTypeLiveActivityTypeListLoginResultMeMemberMemberListMessageMessageCategoryMessageCategoryListMessageListMessagesReportMessengerLinkMfaSetupOAuthApproveResultOAuthConsentContextOkOpenedDtoOrgOrgDataExportOrgListOrgNotificationListOverageChargeListOverviewStatsPatchEventDefinitionDtoPatchSubscriptionDtoPatchUserDtoPathBodyDtoPathReportPlanListPortalResultPostmasterStatsPredictionModelPredictionModelListPredictionUsersPagePreviewDataTransformDtoPreviewWarehouseQueryDtoPromoCodeListPromoCodeListListPromoCodesPagePromoCodeUploadResultProvidersReportPublicCleanupSubscriptionsDtoPublicFormSubmitDtoPublicSurveyResponseDtoPutSiteSearchDocumentDtoReceivedDtoRecentEventsRecommendationConfigRecommendationsRecoveryCodesRenderPreviewRenderTemplateDtoReportResultReportRunBodyDtoReprocessQuarantineDtoRequestLogRequestLogPageResellerChildOrgResellerChildOrgListResellerStatementRetentionReportReverseEtlConnectionTestReverseEtlCreateReverseEtlRunReverseEtlRunPageReverseEtlSyncReverseEtlSyncListRfmConfigRfmOverviewRfmTransitionsRfmUsersPageRunSqlQueryDtoSavedReportSavedReportListScheduleCampaignDtoScimTokenCreatedScimTokenListSdkAttributionAcceptedSdkAttributionDtoSdkChatAckDtoSdkChatConfigSdkChatConversationSdkChatIdentifyDtoSdkChatIdentifyResultSdkChatMessagePageSdkChatOfflineDtoSdkChatSendDtoSdkChatSendResultSdkChatTypingDtoSdkConfigSdkErrorPageSdkErrorsAcceptedSdkErrorsDtoSdkEventsDtoSdkFeatureFlagsSdkFlagsEvaluateDtoSdkFormSubmitDtoSdkGeofenceEventsDtoSdkGeofenceListSdkIdentityDtoSdkIdentityResultSdkInAppEventDtoSdkInAppListSdkInboxActionDtoSdkLiveActivityTokenDeleteDtoSdkLiveActivityTokenDtoSdkLoginDtoSdkLogoutDtoSdkPreferencesSdkRegisterDtoSdkRegisterResultSdkSecretSdkSessionDtoSdkSetPreferencesDtoSdkSnippetSdkSubscriptionPatchDtoSdkSurveyResponseDtoSdkUserPatchDtoSdkUserResultSdkWebCampaignEventDtoSdkWebCampaignListSdkWebPersonalizationEventDtoSdkWebPersonalizationListSegmentSegmentCampaignsSegmentEstimateSegmentPageSegmentPreviewSelectWinnerDtoSessionListSessionVolumeSetMemberDtoSetOwnerDtoSetPreferencesDtoSetupStatusShopifyWebhookStatusSiteSearchCrawlRequestSiteSearchDocumentSiteSearchDocumentPageSiteSearchDocumentResultSiteSearchEventDtoSiteSearchOverviewSiteSearchPreviewSiteSearchReportSiteSearchRequestDtoSiteSearchResponseSiteSearchSourceSiteSearchSourceListSmsKeywordSmsKeywordListSmsVerificationSmsVerificationCheckSqlQueryResultSqlRunListSqlSchemaSqlSegmentListSsoConnectionSsoConnectionListSsoDiscoverResultSsoDomainSsoDomainListSsoSettingsSsoTestResultSsoTestStartStartHygieneDtoStartLiveActivityDtoStartVerifyDtoStatusTokenResultSubscriptionSubscriptionListSubscriptionsReportSuppressionSuppressionPageSurveySurveyInAppDtoSurveyPageSurveyReportSurveyResponseSurveyResponsePageSurveyResponseResultSurveyStatusDtoSyncAdAudienceDtoTeamInputDtoTeamUpdateDtoTemplateTemplatePageTemplateStatsTemplateVersionListTestDataFeedDtoTestPushDtoTraceResultTriggerRunDtoUninstallReportUpdateAdAudienceDtoUpdateAdCampaignDtoUpdateAffinityConfigDtoUpdateAiAgentDtoUpdateApiKeyDtoUpdateAppDtoUpdateAppFlagDtoUpdateBudgetAlertRuleDtoUpdateCatalogDtoUpdateCategoryDtoUpdateChannelScoreConfigDtoUpdateCompanyDtoUpdateContentTableDtoUpdateCustomAgentDtoUpdateDataFeedDtoUpdateDataSourceDtoUpdateDataTransformDtoUpdateDecisionAgentDtoUpdateFormDtoUpdateGeofenceDtoUpdateGlobalControlDtoUpdateInAppDtoUpdateJourneyDtoUpdateKeywordDtoUpdateLandingPageDtoUpdateLiveActivityDtoUpdateLiveActivityTypeDtoUpdateNodeDtoUpdatePredictionDtoUpdatePromoCodeListDtoUpdateRecommendationConfigDtoUpdateReverseEtlDtoUpdateRfmConfigDtoUpdateSavedReportDtoUpdateSiteSearchSettingsDtoUpdateSiteSearchSourceDtoUpdateSqlSegmentDtoUpdateSurveyDtoUpdateTemplateDtoUpdateWalletConfigDtoUpdateWalletPassDtoUpdateWalletTemplateDtoUpdateWarehouseConnectionDtoUpdateWarehouseExportDtoUpdateWarehouseSegmentDtoUpdateWarmupPlanDtoUpdateWebCampaignDtoUpdateWebhookDtoUpdateWebPersonalizationDtoUpsertCatalogItemsDtoUpsertCompanyDtoUpsertUserDtoUsageReportUserUserAffinityUserCompanyListUserDetailUserExportUserIdentityUserJourneyRunsUserListUserMessageListUserPreferencesUserTimelineVerifyAddressDtoWalletConfigWalletPassWalletPassPageWalletTemplateWalletTemplateListWarehouseConnectionResultWarehouseConnectionTestWarehouseExportWarehouseExportCreateWarehouseExportListWarehouseExportRunWarehouseExportRunPageWarehouseSegmentConnectionWarehouseSegmentConnectionListWarehouseSegmentConnectionTestWarehouseSegmentListWarehouseSegmentOptionsWarehouseSegmentPreviewWarehouseSegmentRunListWarehouseTablesWebCampaignWebCampaignPageWebCampaignReportWebCampaignStatusDtoWebCampaignWinnerDtoWebhookWebhookBulkReplayResultWebhookDeliveryDetailWebhookDeliveryPageWebhookEventTypesWebhookListWebhookPreviewDtoWebhookPreviewResultWebhookSecretWebhookWithSecretWebPersonalizationWebPersonalizationPageWebPersonalizationReportWebPersonalizationStatusDtoWebPersonalizationWinnerDtoWhatsAppTemplateListWhatsAppTemplateSyncZapierHookZapierHookListZapierMeZapierSamplesZapierSubscribeDto