PushizoDocs
API referansı

Şemalar

Public API'nin 285 bileşen şeması (components.schemas): alanlar, türler, zorunluluk ve kısıtlar.

İstek ve yanıt gövdelerinde kullanılan tüm nesne şemaları. Alan adları snake_case, zamanlar ISO 8601 UTC, kimlikler ön ekli ULID. Şema adları işlem sayfalarındaki "Şema:" bağlantılarıyla eşleşir.

Dizin

AcceptInviteResult · Account · AccountExport · AddAliasDto · AddSubscriptionDto · AiGlossaryEntry · AiGlossaryList · AiSettings · AiStatus · AiSubjectScoreResult · AiSuggestions · AiTranslateResult · AiTranslation · AiTranslationList · AiUsageReport · AiVariantsResult · ApiEventsDto · ApiKey · ApiKeyList · App · AppList · AppTransfer · AppTransferList · AuditActions · AuditEntry · AuditPage · AuthConfig · BillingStatus · Branding · BrandResolution · Campaign · CampaignPage · CampaignStats · CampaignVariantStats · CellHandoff · CellHandoffResult · CellList · CellOrgList · ChannelConfig · ChannelHook · ChannelList · ChannelStatusList · ChannelValidation · CheckoutResult · CleanupResult · ContentTable · ContentTableList · ContentTableRows · Conversation · ConversationMessagePage · ConversationPage · ConversationReplyDto · ConversationReplyResult · ConversionsReport · CopyTemplateDto · CreateAppApiKeyDto · CreateAppDto · CreateCategoryDto · CreatedApiKey · CreateDataFeedDto · CreateExportDto · CreateIdentityKeyDto · CreateInAppDto · CreateKeywordDto · CreateLiveActivityTypeDto · CreateNotificationDto · CreateNotificationResult · CreateSuppressionDto · CreateTemplateDto · CreateWarmupPlanDto · CreateWebhookDto · CustomDomain · CustomDomainList · DataFeed · DataFeedList · DataFeedTestResult · DeliverabilitySettingsDto · Delivery · DeliveryList · EmailAddressCheck · EmailDeliverabilitySettings · EmailDesign · EmailDesignPage · EmailDesignPreview · EmailSavedBlock · EmailSavedBlockList · EmailWarmupPlan · EmailWarmupPlanList · EmailWarmupUsage · EndLiveActivityDto · EngagementReport · EstimateAudienceDto · EstimateAudienceResult · EventDefinition · EventDefinitionDetail · EventDefinitionList · EventList · EventsAccepted · EventsReport · Export · ExportList · FunnelBodyDto · FunnelReport · IdentityKey · IdentityKeyList · Import · ImportList · InAppMessage · InAppMessagePage · InAppStatusDto · InAppTemplate · InAppTemplateList · InAppWinnerDto · InboxItem · InboxPage · InboxReadAllResult · Integration · IntegrationList · IntegrationOk · IntegrationRunList · IntegrationSyncResult · IntegrationTestResult · Invite · InviteList · InvitePreview · InvoiceList · Journey · JourneyDetail · JourneyPage · JourneyPublishResult · JourneyRun · JourneyRunDetail · JourneyRunPage · JourneyStats · JourneyTriggerResult · JourneyVersionList · LiveActivitySendResult · LiveActivityTokenResult · LiveActivityType · LiveActivityTypeList · LoginResult · Me · Member · MemberList · Message · MessageCategory · MessageCategoryList · MessageList · MessagesReport · MfaSetup · OAuthApproveResult · OAuthConsentContext · Ok · OpenedDto · Org · OrgDataExport · OrgList · OrgNotificationList · OverviewStats · PatchEventDefinitionDto · PatchSubscriptionDto · PatchUserDto · PlanList · PortalResult · ProvidersReport · RecentEvents · RecoveryCodes · RenderPreview · RenderTemplateDto · RequestLog · RequestLogPage · ResellerChildOrg · ResellerChildOrgList · ResellerStatement · RetentionReport · ScheduleCampaignDto · ScimTokenCreated · ScimTokenList · SdkConfig · SdkErrorPage · SdkErrorsAccepted · SdkErrorsDto · SdkEventsDto · SdkIdentityDto · SdkIdentityResult · SdkInAppEventDto · SdkInAppList · SdkInboxActionDto · SdkLiveActivityTokenDeleteDto · SdkLiveActivityTokenDto · SdkLoginDto · SdkLogoutDto · SdkPreferences · SdkRegisterDto · SdkRegisterResult · SdkSecret · SdkSessionDto · SdkSetPreferencesDto · SdkSubscriptionPatchDto · SdkUserPatchDto · SdkUserResult · Segment · SegmentCampaigns · SegmentEstimate · SegmentPage · SegmentPreview · SelectWinnerDto · SessionList · SetOwnerDto · SetPreferencesDto · SmsKeyword · SmsKeywordList · SsoConnection · SsoConnectionList · SsoDiscoverResult · SsoDomain · SsoDomainList · SsoSettings · SsoTestResult · SsoTestStart · StartLiveActivityDto · StatusTokenResult · Subscription · SubscriptionList · SubscriptionsReport · Suppression · SuppressionPage · Template · TemplatePage · TemplateStats · TemplateVersionList · TestDataFeedDto · TraceResult · TriggerRunDto · UpdateApiKeyDto · UpdateAppDto · UpdateCategoryDto · UpdateContentTableDto · UpdateDataFeedDto · UpdateInAppDto · UpdateJourneyDto · UpdateKeywordDto · UpdateLiveActivityDto · UpdateLiveActivityTypeDto · UpdateNodeDto · UpdateTemplateDto · UpdateWarehouseExportDto · UpdateWarmupPlanDto · UpdateWebhookDto · UpsertUserDto · UsageReport · User · UserDetail · UserExport · UserIdentity · UserJourneyRuns · UserList · UserMessageList · UserPreferences · VerifyAddressDto · WarehouseConnectionResult · WarehouseConnectionTest · WarehouseExport · WarehouseExportCreate · WarehouseExportList · WarehouseExportRun · WarehouseExportRunPage · WarehouseTables · Webhook · WebhookBulkReplayResult · WebhookDeliveryDetail · WebhookDeliveryPage · WebhookEventTypes · WebhookList · WebhookPreviewDto · WebhookPreviewResult · WebhookSecret · WebhookWithSecret · WhatsAppTemplateList · WhatsAppTemplateSync · ZapierHook · ZapierHookList · ZapierMe · ZapierSamples · ZapierSubscribeDto

AcceptInviteResult

AlanTürZorunluAçıklama
org_idstringEvet
org_slugstringEvet
roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"

Account

AlanTürZorunluAçıklama
idstringEvet
emailstringEvet
namestringEvet
localestringEvet
timezonestringEvet
email_verifiedbooleanEvet
mfa_enabledbooleanEvet
is_platform_adminbooleanEvet
has_passwordbooleanEvet
marketing_opt_inbooleanEvet
created_atstringEvet

AccountExport

AlanTürZorunluAçıklama
format_versionintegerEvet
generated_atstringEvet
accountobjectEvet
account.idstringEvet
account.emailstringEvet
account.namestringEvet
account.localestringEvet
account.timezonestringEvet
account.statusstringEvet
account.email_verified_atstring | nullEvet
account.has_passwordbooleanEvet
account.mfa_enabledbooleanEvet
account.is_platform_adminbooleanEvet
account.last_login_atstring | nullEvet
account.created_atstringEvet
account.updated_atstringEvet
consentsobjectEvet
consents.terms_accepted_atstring | nullEvet
consents.terms_versionstring | nullEvet
consents.marketing_opt_inbooleanEvet
consents.marketing_opt_in_atstring | nullEvet
membershipsarray<object>Evet
memberships[].org_idstringEvet
memberships[].org_namestringEvet
memberships[].org_slugstringEvet
memberships[].rolestringEvet
memberships[].is_primary_ownerbooleanEvet
memberships[].app_scopesarray<string>Evet
memberships[].joined_atstringEvet
sessionsarray<object>Evet
sessions[].idstringEvet
sessions[].ipstring | nullEvet
sessions[].user_agentstring | nullEvet
sessions[].auth_methodstringEvet
sessions[].persistentbooleanEvet
sessions[].created_atstringEvet
sessions[].last_seen_atstringEvet
sessions[].expires_atstringEvet
sessions[].revoked_atstring | nullEvet
identitiesarray<object>Evet
identities[].providerstringEvet
identities[].provider_user_idstringEvet
identities[].emailstring | nullEvet
identities[].created_atstringEvet
mfa_factorsarray<object>Evet
mfa_factors[].typestringEvet
mfa_factors[].verified_atstring | nullEvet
mfa_factors[].last_used_atstring | nullEvet
mfa_factors[].created_atstringEvet
oauth_grantsarray<object>Evet
oauth_grants[].client_namestringEvet
oauth_grants[].org_idstringEvet
oauth_grants[].app_idstring | nullEvet
oauth_grants[].scopesarray<string>Evet
oauth_grants[].created_atstringEvet
oauth_grants[].revoked_atstring | nullEvet
audit_entriesarray<object>Evet
audit_entries[].org_idstringEvet
audit_entries[].app_idstring | nullEvet
audit_entries[].actionstringEvet
audit_entries[].target_typestring | nullEvet
audit_entries[].target_idstring | nullEvet
audit_entries[].metadatamap<string, any>Evet
audit_entries[].ipstring | nullEvet
audit_entries[].created_atstringEvet

AddAliasDto

AlanTürZorunluAçıklama
identitymap<string, string>Evet

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/users/by/{label}/{value}/identity

AddSubscriptionDto

AlanTürZorunluAçıklama
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
tokenstringEvetUzunluk: 1–4096
deviceobjectHayırVarsayılan: {}
device.modelstringHayırUzunluk: 0–100
device.osstringHayırUzunluk: 0–50
device.os_versionstringHayırUzunluk: 0–50
device.app_versionstring | nullHayır
device.sdk_versionstringHayırUzunluk: 0–50
device.sdk_platformstringHayırUzunluk: 0–50
device.carrierstringHayırUzunluk: 0–100
device.localestringHayırUzunluk: 0–20
device.timezonestringHayırUzunluk: 0–64
device.push_capablebooleanHayır
device.push_environmentenumHayırDeğerler: "sandbox", "production"
statusenumHayırDeğerler: "subscribed", "unsubscribed"
opt_inobjectHayır
opt_in.sourcestringEvetUzunluk: 1–100
opt_in.atstring (date-time)Hayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/users/by/{label}/{value}/subscriptions

AiGlossaryEntry

AlanTürZorunluAçıklama
idstringEvet
termstringEvet
translationsmap<string, string>Evet
notestring | nullEvet
created_atstringEvet
updated_atstringEvet

AiGlossaryList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].termstringEvet
data[].translationsmap<string, string>Evet
data[].notestring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet

AiSettings

AlanTürZorunluAçıklama
enabledbooleanEvet
monthly_token_quotaintegerEvet
banned_phrasesarray<string>Evet
providerenumEvetDeğerler: "anthropic", "mock"
availablebooleanEvet
modelsobjectEvet
models.defaultstringEvet
models.longstringEvet
usageobjectEvet
usage.used_tokensintegerEvet
usage.quota_tokensintegerEvet
usage.period_startstringEvet

AiStatus

AlanTürZorunluAçıklama
enabledbooleanEvet
availablebooleanEvet
providerenumEvetDeğerler: "anthropic", "mock"
usageobjectEvet
usage.used_tokensintegerEvet
usage.quota_tokensintegerEvet
usage.period_startstringEvet
languagesarray<string>Evet
default_languagestringEvet
field_limitsmap<string, integer>Evet
pending_translationsintegerEvet

AiSubjectScoreResult

AlanTürZorunluAçıklama
scoreintegerEvet
reasonsarray<string>Evet
improvedarray<string>Evet
metaobjectEvet
meta.modelstringEvet
meta.filteredintegerEvet
meta.warningsarray<string>Evet

AiSuggestions

AlanTürZorunluAçıklama
suggestionsarray<object>Evet
suggestions[].textstringEvet
suggestions[].lengthintegerEvet
metaobjectEvet
meta.modelstringEvet
meta.filteredintegerEvet
meta.warningsarray<string>Evet

AiTranslateResult

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].source_languagestringEvet
data[].target_languagestringEvet
data[].sourceobjectEvet
data[].source.headingsstringHayır
data[].source.contentsstringHayır
data[].source.subtitlestringHayır
data[].source.email_subjectstringHayır
data[].source.email_preheaderstringHayır
data[].resultobjectEvet
data[].result.headingsstringHayır
data[].result.contentsstringHayır
data[].result.subtitlestringHayır
data[].result.email_subjectstringHayır
data[].result.email_preheaderstringHayır
data[].statusenumEvetDeğerler: "pending", "approved", "rejected"
data[].ref_typestring | nullEvet
data[].ref_idstring | nullEvet
data[].warningsarray<string>Evet
data[].created_atstringEvet
data[].reviewed_atstring | nullEvet
data[].reviewed_bystring | nullEvet
metaobjectEvet
meta.modelstringEvet
meta.filteredintegerEvet
meta.warningsarray<string>Evet

AiTranslation

AlanTürZorunluAçıklama
idstringEvet
source_languagestringEvet
target_languagestringEvet
sourceobjectEvet
source.headingsstringHayır
source.contentsstringHayır
source.subtitlestringHayır
source.email_subjectstringHayır
source.email_preheaderstringHayır
resultobjectEvet
result.headingsstringHayır
result.contentsstringHayır
result.subtitlestringHayır
result.email_subjectstringHayır
result.email_preheaderstringHayır
statusenumEvetDeğerler: "pending", "approved", "rejected"
ref_typestring | nullEvet
ref_idstring | nullEvet
warningsarray<string>Evet
created_atstringEvet
reviewed_atstring | nullEvet
reviewed_bystring | nullEvet

AiTranslationList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].source_languagestringEvet
data[].target_languagestringEvet
data[].sourceobjectEvet
data[].source.headingsstringHayır
data[].source.contentsstringHayır
data[].source.subtitlestringHayır
data[].source.email_subjectstringHayır
data[].source.email_preheaderstringHayır
data[].resultobjectEvet
data[].result.headingsstringHayır
data[].result.contentsstringHayır
data[].result.subtitlestringHayır
data[].result.email_subjectstringHayır
data[].result.email_preheaderstringHayır
data[].statusenumEvetDeğerler: "pending", "approved", "rejected"
data[].ref_typestring | nullEvet
data[].ref_idstring | nullEvet
data[].warningsarray<string>Evet
data[].created_atstringEvet
data[].reviewed_atstring | nullEvet
data[].reviewed_bystring | nullEvet

AiUsageReport

AlanTürZorunluAçıklama
period_startstringEvet
used_tokensintegerEvet
quota_tokensintegerEvet
by_featurearray<object>Evet
by_feature[].featurestringEvet
by_feature[].modelstringEvet
by_feature[].requestsintegerEvet
by_feature[].input_tokensintegerEvet
by_feature[].output_tokensintegerEvet

AiVariantsResult

AlanTürZorunluAçıklama
variantsarray<object>Evet
variants[].namestringEvet
variants[].titlestringEvet
variants[].bodystringEvet
variants[].rationalestringEvet
metaobjectEvet
meta.modelstringEvet
meta.filteredintegerEvet
meta.warningsarray<string>Evet

ApiEventsDto

AlanTürZorunluAçıklama
eventsarray<object>EvetÖğe: 1–500
events[].namestringEvetUzunluk: 1–100
events[].propertiesmap<string, any>HayırVarsayılan: {}
events[].valuenumberHayır
events[].occurred_atstring (date-time)Hayır
events[].event_idstringHayırUzunluk: 8–64
events[].subscription_idstringHayırUzunluk: 1–∞
events[].external_idstringHayırUzunluk: 1–255

Kullanıldığı işlemler: POST /v1/apps/{appId}/events

ApiKey

AlanTürZorunluAçıklama
idstringEvet
org_idstringEvet
app_idstring | nullEvet
namestringEvet
prefixstringEvet
scopesarray<string>Evet
last_used_atstring | nullEvet
expires_atstring | nullEvet
revoked_atstring | nullEvet
ip_allowlistarray<string>Evet
rotated_atstring | nullEvet
created_bystring | nullEvet
created_atstringEvet

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/api-keys/{keyId}

ApiKeyList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].org_idstringEvet
data[].app_idstring | nullEvet
data[].namestringEvet
data[].prefixstringEvet
data[].scopesarray<string>Evet
data[].last_used_atstring | nullEvet
data[].expires_atstring | nullEvet
data[].revoked_atstring | nullEvet
data[].ip_allowlistarray<string>Evet
data[].rotated_atstring | nullEvet
data[].created_bystring | nullEvet
data[].created_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/api-keys

App

AlanTürZorunluAçıklama
idstringEvet
org_idstringEvet
namestringEvet
slugstringEvet
platform_flagsobjectEvet
platform_flags.iosbooleanHayır
platform_flags.androidbooleanHayır
platform_flags.webbooleanHayır
platform_flags.emailbooleanHayır
platform_flags.smsbooleanHayır
icon_urlstring | nullEvet
default_languagestringEvet
timezonestringEvet
settingsobjectEvet
settings.quietHoursobject | nullHayır
settings.frequencyCapobject | nullHayır
settings.frequencyCapsarray<object>HayırÖğe: 0–10
settings.frequencyCaps[].maxintegerEvetAralık: 1–1000
settings.frequencyCaps[].windowobjectEvet
settings.frequencyCaps[].channelsarray<enum>HayırÖğe: 1–8
settings.inAppobjectHayır
settings.inApp.minIntervalSecondsintegerHayırAralık: 0–604800
settings.androidChannelsarray<object>HayırÖğe: 0–50
settings.androidChannels[].idstringEvetUzunluk: 1–64
settings.androidChannels[].namestringEvetUzunluk: 1–60
settings.androidChannels[].descriptionstringHayırUzunluk: 0–200
settings.androidChannels[].importanceenumEvetDeğerler: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringHayırUzunluk: 0–64
settings.androidChannels[].vibrationbooleanHayır
settings.androidChannels[].groupstringHayırUzunluk: 0–64
settings.smsobjectHayır
settings.sms.helpReplystringHayırUzunluk: 0–320
settings.sms.stopReplystringHayırUzunluk: 0–320
settings.sms.autoReplybooleanHayır
settings.preferenceCenterobjectHayır
settings.preferenceCenter.enabledbooleanHayır
settings.preferenceCenter.brandNamestringHayırUzunluk: 0–80
settings.preferenceCenter.logoUrlstring (url)HayırUzunluk: 0–2000
settings.preferenceCenter.accentColorstringHayır
settings.preferenceCenter.customUnsubscribeUrlstring (url)HayırUzunluk: 0–2000
settings.preferenceCenter.textsmap<string, object>Hayır
settings.defaultTtlSecondsintegerHayırAralık: 60–2419200
settings.identityVerificationRequiredbooleanHayır
settings.allowedOriginsarray<string>HayırÖğe: 0–50
settings.campaignApprovalRequiredbooleanHayır
settings.webPushobjectHayır
settings.webPush.serviceWorkerPathstringHayırUzunluk: 0–200
settings.webPush.serviceWorkerScopestringHayırUzunluk: 0–200
settings.webPush.promptobjectHayır
settings.webPush.welcomeNotificationobjectHayır
settings.webPush.clickBehaviorobjectHayır
settings.webPush.customLinkobjectHayır
settings.webPush.promptBackoffDaysarray<integer>HayırÖğe: 0–10
settings.onboardingobjectHayır
settings.onboarding.stepintegerEvetAralık: 0–6
settings.onboarding.simulationbooleanHayır
settings.onboarding.completed_atstring | nullHayır
settings.onboarding.versionintegerHayırAralık: 1–100
settings.onboarding.platformsarray<enum>HayırÖğe: 0–4
settings.onboarding.frameworkenumHayırDeğerler: "native", "flutter", "react-native", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumHayırDeğerler: "code", "wordpress"
settings.sdkSetupobject | nullHayır
identity_verification_modeenumEvetDeğerler: "hmac", "jwt", "both"
statusenumEvetDeğerler: "active", "suspended", "deleted"
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps, GET /v1/apps/{appId}, PATCH /v1/apps/{appId}

AppList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].org_idstringEvet
data[].namestringEvet
data[].slugstringEvet
data[].platform_flagsobjectEvet
data[].platform_flags.iosbooleanHayır
data[].platform_flags.androidbooleanHayır
data[].platform_flags.webbooleanHayır
data[].platform_flags.emailbooleanHayır
data[].platform_flags.smsbooleanHayır
data[].icon_urlstring | nullEvet
data[].default_languagestringEvet
data[].timezonestringEvet
data[].settingsobjectEvet
data[].settings.quietHoursobject | nullHayır
data[].settings.frequencyCapobject | nullHayır
data[].settings.frequencyCapsarray<object>HayırÖğe: 0–10
data[].settings.inAppobjectHayır
data[].settings.androidChannelsarray<object>HayırÖğe: 0–50
data[].settings.smsobjectHayır
data[].settings.preferenceCenterobjectHayır
data[].settings.defaultTtlSecondsintegerHayırAralık: 60–2419200
data[].settings.identityVerificationRequiredbooleanHayır
data[].settings.allowedOriginsarray<string>HayırÖğe: 0–50
data[].settings.campaignApprovalRequiredbooleanHayır
data[].settings.webPushobjectHayır
data[].settings.onboardingobjectHayır
data[].settings.sdkSetupobject | nullHayır
data[].identity_verification_modeenumEvetDeğerler: "hmac", "jwt", "both"
data[].statusenumEvetDeğerler: "active", "suspended", "deleted"
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps

AppTransfer

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
app_namestring | nullEvet
from_orgobjectEvet
from_org.idstringEvet
from_org.namestring | nullEvet
from_org.slugstring | nullEvet
to_orgobjectEvet
to_org.idstringEvet
to_org.namestring | nullEvet
to_org.slugstring | nullEvet
statusenumEvetDeğerler: "pending", "completed", "cancelled", "rejected", "failed"
source_approved_atstring | nullEvet
target_approved_atstring | nullEvet
completed_atstring | nullEvet
failure_reasonstring | nullEvet
created_atstringEvet

AppTransferList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].app_namestring | nullEvet
data[].from_orgobjectEvet
data[].from_org.idstringEvet
data[].from_org.namestring | nullEvet
data[].from_org.slugstring | nullEvet
data[].to_orgobjectEvet
data[].to_org.idstringEvet
data[].to_org.namestring | nullEvet
data[].to_org.slugstring | nullEvet
data[].statusenumEvetDeğerler: "pending", "completed", "cancelled", "rejected", "failed"
data[].source_approved_atstring | nullEvet
data[].target_approved_atstring | nullEvet
data[].completed_atstring | nullEvet
data[].failure_reasonstring | nullEvet
data[].created_atstringEvet

AuditActions

AlanTürZorunluAçıklama
actionsarray<string>Evet

AuditEntry

AlanTürZorunluAçıklama
idstringEvet
org_idstringEvet
app_idstring | nullEvet
actor_typeenumEvetDeğerler: "account", "api_key", "system"
actor_idstring | nullEvet
actionstringEvet
target_typestring | nullEvet
target_idstring | nullEvet
metadatamap<string, any>Evet
ipstring | nullEvet
request_idstring | nullEvet
created_atstringEvet

AuditPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].org_idstringEvet
data[].app_idstring | nullEvet
data[].actor_typeenumEvetDeğerler: "account", "api_key", "system"
data[].actor_idstring | nullEvet
data[].actionstringEvet
data[].target_typestring | nullEvet
data[].target_idstring | nullEvet
data[].metadatamap<string, any>Evet
data[].ipstring | nullEvet
data[].request_idstring | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/organization/audit-logs

AuthConfig

AlanTürZorunluAçıklama
turnstile_site_keystring | nullEvet

BillingStatus

AlanTürZorunluAçıklama
org_idstringEvet
providerstringEvetstripe | iyzico | mock | none (ödeme sağlayıcısı yapılandırılmamış; checkout/portal 503 döner)
planobjectEvet
plan.codestringEvet
plan.namestringEvet
plan.monthly_priceintegerEvet
plan.currencystringEvet
plan.positionintegerEvet
plan.is_publicbooleanEvet
plan.limitsobjectEvet
plan.limits.subscriptionsinteger | nullEvet
plan.limits.messages_per_monthinteger | nullEvet
plan.limits.api_rpsinteger | nullEvet
plan.limits.membersinteger | nullEvet
plan.limits.appsinteger | nullEvet
plan.limits.retention_daysinteger | nullEvet
plan.limits.journeysinteger | nullEvet
plan.limits.segmentsinteger | nullEvet
plan.limits.ab_variantsinteger | nullEvet
plan.limits.tags_per_userinteger | nullEvet
plan.limits.aliases_per_userinteger | nullEvet
plan.limits.subscriptions_per_userinteger | nullEvet
plan.limits.report_history_daysinteger | nullEvet
plan.limits.webhooksinteger | nullEvet
plan.limits.api_keysinteger | nullEvet
plan.featuresobjectEvet
plan.features.journeysbooleanEvet
plan.features.ab_testingbooleanEvet
plan.features.emailbooleanEvet
plan.features.smsbooleanEvet
plan.features.in_appbooleanEvet
plan.features.approval_flowbooleanEvet
plan.features.ssobooleanEvet
plan.features.scimbooleanHayır
plan.features.audit_exportbooleanEvet
plan.features.rolesarray<string>Evet
plan.purchasablebooleanEvet
effective_plan_codestringEvet
trialingbooleanEvet
trial_ends_atstring | nullEvet
suspendedbooleanEvet
suspended_reasonstring | nullEvet
subscriptionobject | nullEvet
billing_infoobject | nullEvet

Branding

AlanTürZorunluAçıklama
product_namestring | nullEvet
logo_urlstring | nullEvet
primary_colorstring | nullEvet
secondary_colorstring | nullEvet
support_emailstring | nullEvet
hide_powered_bybooleanEvet
effectiveobjectEvet
effective.product_namestringEvet
effective.logo_urlstring | nullEvet
effective.primary_colorstring | nullEvet
effective.secondary_colorstring | nullEvet
effective.support_emailstring | nullEvet
effective.powered_bybooleanEvet
effective.inheritedbooleanEvet
featuresobjectEvet
features.white_labelbooleanEvet
features.hide_powered_bybooleanEvet

BrandResolution

AlanTürZorunluAçıklama
kindenumEvetDeğerler: "dashboard", "tracking", "preference_center", "status_page"
org_slugstringEvet
product_namestringEvet
logo_urlstring | nullEvet
primary_colorstring | nullEvet
secondary_colorstring | nullEvet
support_emailstring | nullEvet
powered_bybooleanEvet

Campaign

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
labelsarray<string>Evet
categorystring | nullEvet
ab_testobjectEvet
ab_test.enabledbooleanHayır
ab_test.test_percentageintegerHayırAralık: 1–100
ab_test.winnerobjectHayır
ab_test.winner.modeenumEvetDeğerler: "manual", "auto"
ab_test.winner.metricenumEvetDeğerler: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerHayırAralık: 5–10080
ab_test.phaseenumHayırDeğerler: "testing", "winner_sent"
ab_test.winner_variant_idstringHayır
ab_test.decided_atstringHayır
ab_test.decided_bystringHayır
ab_test.significanceobjectHayır
ab_test.significance.p_valuenumberEvet
ab_test.significance.significantbooleanEvet
ab_test.significance.metricstringEvet
variantsarray<object>Evet
variants[].idstringEvet
variants[].namestringEvet
variants[].weight_percentintegerEvet
variants[].contentmap<string, any> | nullEvet
variants[].is_controlbooleanEvet
variants[].positionintegerEvet
typeenumEvetDeğerler: "one_time", "scheduled", "recurring", "automated", "transactional"
statusenumEvetDeğerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
audiencemap<string, any>Evet
contentmap<string, any>Evet
template_idstring | nullEvet
template_versioninteger | nullEvet
deliveryobjectEvet
delivery.timezone_modeenumHayırDeğerler: "immediate", "per_user_timezone", "optimized"
delivery.delivery_time_of_daystringHayır
delivery.throttle_per_minuteintegerHayırAralık: 1–1000000
delivery.ttlintegerHayırAralık: 60–2419200
delivery.priority5 | 10Hayır
delivery.collapse_idstringHayırUzunluk: 0–64
delivery.frequency_cap_exemptbooleanHayır
delivery.quiet_hours_exemptbooleanHayır
delivery.one_per_userbooleanHayır
recurrenceobject | nullEvet
approvalobjectEvet
approval.requiredbooleanEvet
approval.pending_actionenumHayırDeğerler: "send", "schedule"
approval.requested_bystringHayır
approval.requested_atstringHayır
approval.approved_bystringHayır
approval.approved_atstringHayır
approval.rejected_bystringHayır
approval.rejected_atstringHayır
statsobjectEvet
stats.runsintegerHayır
stats.targetedintegerHayır
stats.suppressedintegerHayır
stats.sentintegerHayır
stats.deliveredintegerHayır
stats.failedintegerHayır
stats.openedintegerHayır
stats.clickedintegerHayır
stats.convertedintegerHayır
stats.bouncedintegerHayır
stats.complainedintegerHayır
stats.unsubscribedintegerHayır
stats.sms_segmentsintegerHayır
send_atstring | nullEvet
next_run_atstring | nullEvet
last_run_atstring | nullEvet
run_countintegerEvet
errorstring | nullEvet
created_bystring | nullEvet
started_atstring | nullEvet
completed_atstring | nullEvet
created_atstringEvet
updated_atstringEvet
estimated_recipientsinteger | nullEvet

Kullanıldığı işlemler: 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, …

CampaignPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].labelsarray<string>Evet
data[].categorystring | nullEvet
data[].ab_testobjectEvet
data[].ab_test.enabledbooleanHayır
data[].ab_test.test_percentageintegerHayırAralık: 1–100
data[].ab_test.winnerobjectHayır
data[].ab_test.phaseenumHayırDeğerler: "testing", "winner_sent"
data[].ab_test.winner_variant_idstringHayır
data[].ab_test.decided_atstringHayır
data[].ab_test.decided_bystringHayır
data[].ab_test.significanceobjectHayır
data[].variantsarray<object>Evet
data[].variants[].idstringEvet
data[].variants[].namestringEvet
data[].variants[].weight_percentintegerEvet
data[].variants[].contentmap<string, any> | nullEvet
data[].variants[].is_controlbooleanEvet
data[].variants[].positionintegerEvet
data[].typeenumEvetDeğerler: "one_time", "scheduled", "recurring", "automated", "transactional"
data[].statusenumEvetDeğerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
data[].audiencemap<string, any>Evet
data[].contentmap<string, any>Evet
data[].template_idstring | nullEvet
data[].template_versioninteger | nullEvet
data[].deliveryobjectEvet
data[].delivery.timezone_modeenumHayırDeğerler: "immediate", "per_user_timezone", "optimized"
data[].delivery.delivery_time_of_daystringHayır
data[].delivery.throttle_per_minuteintegerHayırAralık: 1–1000000
data[].delivery.ttlintegerHayırAralık: 60–2419200
data[].delivery.priority5 | 10Hayır
data[].delivery.collapse_idstringHayırUzunluk: 0–64
data[].delivery.frequency_cap_exemptbooleanHayır
data[].delivery.quiet_hours_exemptbooleanHayır
data[].delivery.one_per_userbooleanHayır
data[].recurrenceobject | nullEvet
data[].approvalobjectEvet
data[].approval.requiredbooleanEvet
data[].approval.pending_actionenumHayırDeğerler: "send", "schedule"
data[].approval.requested_bystringHayır
data[].approval.requested_atstringHayır
data[].approval.approved_bystringHayır
data[].approval.approved_atstringHayır
data[].approval.rejected_bystringHayır
data[].approval.rejected_atstringHayır
data[].statsobjectEvet
data[].stats.runsintegerHayır
data[].stats.targetedintegerHayır
data[].stats.suppressedintegerHayır
data[].stats.sentintegerHayır
data[].stats.deliveredintegerHayır
data[].stats.failedintegerHayır
data[].stats.openedintegerHayır
data[].stats.clickedintegerHayır
data[].stats.convertedintegerHayır
data[].stats.bouncedintegerHayır
data[].stats.complainedintegerHayır
data[].stats.unsubscribedintegerHayır
data[].stats.sms_segmentsintegerHayır
data[].send_atstring | nullEvet
data[].next_run_atstring | nullEvet
data[].last_run_atstring | nullEvet
data[].run_countintegerEvet
data[].errorstring | nullEvet
data[].created_bystring | nullEvet
data[].started_atstring | nullEvet
data[].completed_atstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
data[].estimated_recipientsinteger | nullEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns

CampaignStats

AlanTürZorunluAçıklama
campaignobjectEvet
campaign.idstringEvet
campaign.app_idstringEvet
campaign.namestringEvet
campaign.labelsarray<string>Evet
campaign.categorystring | nullEvet
campaign.ab_testobjectEvet
campaign.ab_test.enabledbooleanHayır
campaign.ab_test.test_percentageintegerHayırAralık: 1–100
campaign.ab_test.winnerobjectHayır
campaign.ab_test.phaseenumHayırDeğerler: "testing", "winner_sent"
campaign.ab_test.winner_variant_idstringHayır
campaign.ab_test.decided_atstringHayır
campaign.ab_test.decided_bystringHayır
campaign.ab_test.significanceobjectHayır
campaign.variantsarray<object>Evet
campaign.variants[].idstringEvet
campaign.variants[].namestringEvet
campaign.variants[].weight_percentintegerEvet
campaign.variants[].contentmap<string, any> | nullEvet
campaign.variants[].is_controlbooleanEvet
campaign.variants[].positionintegerEvet
campaign.typeenumEvetDeğerler: "one_time", "scheduled", "recurring", "automated", "transactional"
campaign.statusenumEvetDeğerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
campaign.audiencemap<string, any>Evet
campaign.contentmap<string, any>Evet
campaign.template_idstring | nullEvet
campaign.template_versioninteger | nullEvet
campaign.deliveryobjectEvet
campaign.delivery.timezone_modeenumHayırDeğerler: "immediate", "per_user_timezone", "optimized"
campaign.delivery.delivery_time_of_daystringHayır
campaign.delivery.throttle_per_minuteintegerHayırAralık: 1–1000000
campaign.delivery.ttlintegerHayırAralık: 60–2419200
campaign.delivery.priority5 | 10Hayır
campaign.delivery.collapse_idstringHayırUzunluk: 0–64
campaign.delivery.frequency_cap_exemptbooleanHayır
campaign.delivery.quiet_hours_exemptbooleanHayır
campaign.delivery.one_per_userbooleanHayır
campaign.recurrenceobject | nullEvet
campaign.approvalobjectEvet
campaign.approval.requiredbooleanEvet
campaign.approval.pending_actionenumHayırDeğerler: "send", "schedule"
campaign.approval.requested_bystringHayır
campaign.approval.requested_atstringHayır
campaign.approval.approved_bystringHayır
campaign.approval.approved_atstringHayır
campaign.approval.rejected_bystringHayır
campaign.approval.rejected_atstringHayır
campaign.statsobjectEvet
campaign.stats.runsintegerHayır
campaign.stats.targetedintegerHayır
campaign.stats.suppressedintegerHayır
campaign.stats.sentintegerHayır
campaign.stats.deliveredintegerHayır
campaign.stats.failedintegerHayır
campaign.stats.openedintegerHayır
campaign.stats.clickedintegerHayır
campaign.stats.convertedintegerHayır
campaign.stats.bouncedintegerHayır
campaign.stats.complainedintegerHayır
campaign.stats.unsubscribedintegerHayır
campaign.stats.sms_segmentsintegerHayır
campaign.send_atstring | nullEvet
campaign.next_run_atstring | nullEvet
campaign.last_run_atstring | nullEvet
campaign.run_countintegerEvet
campaign.errorstring | nullEvet
campaign.created_bystring | nullEvet
campaign.started_atstring | nullEvet
campaign.completed_atstring | nullEvet
campaign.created_atstringEvet
campaign.updated_atstringEvet
campaign.estimated_recipientsinteger | nullEvet
ratesobjectEvet
rates.delivery_ratenumber | nullEvet
rates.open_ratenumber | nullEvet
rates.click_ratenumber | nullEvet
rates.failure_ratenumber | nullEvet
rates.conversion_ratenumber | nullEvet
channelsarray<object>Evet
channels[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
channels[].targetedintegerEvet
channels[].sentintegerEvet
channels[].failedintegerEvet
channels[].openedintegerEvet
channels[].clickedintegerEvet
hourlyarray<object>Evet
hourly[].hourstringEvet
hourly[].sentintegerEvet
hourly[].failedintegerEvet
hourly[].openedintegerEvet
hourly[].clickedintegerEvet
errorsarray<object>Evet
errors[].codestringEvet
errors[].countintegerEvet
messagesarray<object>Evet
messages[].idstringEvet
messages[].app_idstringEvet
messages[].sourceenumEvetDeğerler: "campaign", "api", "journey", "test"
messages[].statusenumEvetDeğerler: "queued", "processing", "completed", "cancelled", "failed"
messages[].idempotency_keystring | nullEvet
messages[].namestring | nullEvet
messages[].contentmap<string, any>Evet
messages[].targetmap<string, any>Evet
messages[].optionsmap<string, any>Evet
messages[].labelsarray<string>Evet
messages[].categorystring | nullEvet
messages[].template_idstring | nullEvet
messages[].campaign_idstring | nullEvet
messages[].variantsarray<object> | nullEvet
messages[].countsobjectEvet
messages[].counts.targetedintegerHayır
messages[].counts.suppressedintegerHayır
messages[].counts.sentintegerHayır
messages[].counts.deliveredintegerHayır
messages[].counts.failedintegerHayır
messages[].counts.erroredintegerHayır
messages[].counts.expiredintegerHayır
messages[].counts.openedintegerHayır
messages[].counts.clickedintegerHayır
messages[].counts.convertedintegerHayır
messages[].counts.bouncedintegerHayır
messages[].counts.complainedintegerHayır
messages[].counts.unsubscribedintegerHayır
messages[].counts.sms_segmentsintegerHayır
messages[].requested_byobjectEvet
messages[].requested_by.typeenumEvetDeğerler: "api_key", "account", "system"
messages[].requested_by.idstringHayır
messages[].errorstring | nullEvet
messages[].scheduled_forstring | nullEvet
messages[].started_atstring | nullEvet
messages[].completed_atstring | nullEvet
messages[].created_atstringEvet
messages[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns/{campaignId}/stats

CampaignVariantStats

AlanTürZorunluAçıklama
ab_testobjectEvet
ab_test.enabledbooleanHayır
ab_test.test_percentageintegerHayırAralık: 1–100
ab_test.winnerobjectHayır
ab_test.winner.modeenumEvetDeğerler: "manual", "auto"
ab_test.winner.metricenumEvetDeğerler: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerHayırAralık: 5–10080
ab_test.phaseenumHayırDeğerler: "testing", "winner_sent"
ab_test.winner_variant_idstringHayır
ab_test.decided_atstringHayır
ab_test.decided_bystringHayır
ab_test.significanceobjectHayır
ab_test.significance.p_valuenumberEvet
ab_test.significance.significantbooleanEvet
ab_test.significance.metricstringEvet
variantsarray<object>Evet
variants[].variant_idstringEvet
variants[].namestringEvet
variants[].weight_percentintegerEvet
variants[].is_controlbooleanEvet
variants[].targetedintegerEvet
variants[].sentintegerEvet
variants[].deliveredintegerEvet
variants[].openedintegerEvet
variants[].clickedintegerEvet
variants[].convertedintegerEvet
variants[].holdoutintegerEvet
variants[].open_ratenumberEvet
variants[].click_ratenumberEvet
variants[].conversion_ratenumberEvet
leaderstring | nullEvet
significanceobjectEvet
significance.p_valuenumberEvet
significance.significantbooleanEvet
significance.metricstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns/{campaignId}/variants/stats

CellHandoff

AlanTürZorunluAçıklama
urlstringEvet
expires_atstringEvet

CellHandoffResult

AlanTürZorunluAçıklama
accountobjectEvet
account.idstringEvet
account.emailstringEvet
account.namestringEvet
account.localestringEvet
account.timezonestringEvet
account.email_verifiedbooleanEvet
account.mfa_enabledbooleanEvet
account.is_platform_adminbooleanEvet
account.has_passwordbooleanEvet
account.marketing_opt_inbooleanEvet
account.created_atstringEvet
nextstring | nullEvet

CellList

AlanTürZorunluAçıklama
enabledbooleanEvet
current_cell_idstring | nullEvet
control_planebooleanEvet
control_plane_dashboard_urlstring | nullEvet
cellsarray<object>Evet
cells[].idstringEvet
cells[].namestringEvet
cells[].api_urlstringEvet
cells[].dashboard_urlstringEvet

CellOrgList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].slugstringEvet
data[].roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
data[].regionstring | nullEvet
data[].dashboard_urlstring | nullEvet
data[].localbooleanEvet
unavailable_cellsarray<string>Evet

ChannelConfig

AlanTürZorunluAçıklama
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
providerenum | nullEvet
statusenumEvetDeğerler: "unconfigured", "active", "invalid", "suspended"
configobjectEvet
config.auth_typeenumHayırDeğerler: "token", "certificate"
config.certificate_environmentenumHayırDeğerler: "sandbox", "production", "universal"
config.certificate_subjectstringHayır
config.certificate_expires_atstringHayır
config.key_idstringHayır
config.team_idstringHayır
config.bundle_idstringHayır
config.environmentenumHayırDeğerler: "sandbox", "production"
config.project_idstringHayır
config.client_emailstringHayır
config.hms_app_idstringHayır
config.high_prioritybooleanHayır
config.subjectstringHayır
config.vapid_public_keystringHayır
config.site_urlstringHayır
config.from_addressstringHayır
config.from_namestringHayır
config.reply_tostringHayır
config.dkim_selectorstringHayır
config.postal_addressstringHayır
config.hoststringHayır
config.portintegerHayır
config.securebooleanHayır
config.usernamestringHayır
config.regionstringHayır
config.access_key_idstringHayır
config.configuration_setstringHayır
config.account_sidstringHayır
config.from_numberstringHayır
config.messaging_service_sidstringHayır
config.usercodestringHayır
config.msgheaderstringHayır
config.iys_filterenumHayırDeğerler: "0", "11", "12"
config.waba_idstringHayır
config.phone_number_idstringHayır
config.graph_api_versionstringHayır
config.display_phone_numberstringHayır
config.verified_namestringHayır
config.rbm_agent_idstringHayır
config.content_sidstringHayır
config.sms_fallbackbooleanHayır
has_secretbooleanEvet
has_hookbooleanEvet
last_validated_atstring | nullEvet
last_errorstring | nullEvet
updated_atstring | nullEvet
suspended_reasonstring | nullEvet
dns_checkobject | nullEvet

Kullanıldığı işlemler: PUT /v1/apps/{appId}/channels/{channel}

ChannelHook

AlanTürZorunluAçıklama
urlstring | nullEvet
providerstringEvet
pollingbooleanEvet
eventsarray<string>Evet
verify_tokenstring | nullHayır

ChannelList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
data[].providerenum | nullEvet
data[].statusenumEvetDeğerler: "unconfigured", "active", "invalid", "suspended"
data[].configobjectEvet
data[].config.auth_typeenumHayırDeğerler: "token", "certificate"
data[].config.certificate_environmentenumHayırDeğerler: "sandbox", "production", "universal"
data[].config.certificate_subjectstringHayır
data[].config.certificate_expires_atstringHayır
data[].config.key_idstringHayır
data[].config.team_idstringHayır
data[].config.bundle_idstringHayır
data[].config.environmentenumHayırDeğerler: "sandbox", "production"
data[].config.project_idstringHayır
data[].config.client_emailstringHayır
data[].config.hms_app_idstringHayır
data[].config.high_prioritybooleanHayır
data[].config.subjectstringHayır
data[].config.vapid_public_keystringHayır
data[].config.site_urlstringHayır
data[].config.from_addressstringHayır
data[].config.from_namestringHayır
data[].config.reply_tostringHayır
data[].config.dkim_selectorstringHayır
data[].config.postal_addressstringHayır
data[].config.hoststringHayır
data[].config.portintegerHayır
data[].config.securebooleanHayır
data[].config.usernamestringHayır
data[].config.regionstringHayır
data[].config.access_key_idstringHayır
data[].config.configuration_setstringHayır
data[].config.account_sidstringHayır
data[].config.from_numberstringHayır
data[].config.messaging_service_sidstringHayır
data[].config.usercodestringHayır
data[].config.msgheaderstringHayır
data[].config.iys_filterenumHayırDeğerler: "0", "11", "12"
data[].config.waba_idstringHayır
data[].config.phone_number_idstringHayır
data[].config.graph_api_versionstringHayır
data[].config.display_phone_numberstringHayır
data[].config.verified_namestringHayır
data[].config.rbm_agent_idstringHayır
data[].config.content_sidstringHayır
data[].config.sms_fallbackbooleanHayır
data[].has_secretbooleanEvet
data[].has_hookbooleanEvet
data[].last_validated_atstring | nullEvet
data[].last_errorstring | nullEvet
data[].updated_atstring | nullEvet
data[].suspended_reasonstring | nullEvet
data[].dns_checkobject | nullEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/channels

ChannelStatusList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].channelstringEvet
data[].providerstring | nullEvet
data[].statusstringEvet

ChannelValidation

AlanTürZorunluAçıklama
okbooleanEvet
kindenum | nullEvet
codestring | nullEvet
messagestring | nullEvet
detailsmap<string, any> | nullEvet
channelobjectEvet
channel.channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
channel.providerenum | nullEvet
channel.statusenumEvetDeğerler: "unconfigured", "active", "invalid", "suspended"
channel.configobjectEvet
channel.config.auth_typeenumHayırDeğerler: "token", "certificate"
channel.config.certificate_environmentenumHayırDeğerler: "sandbox", "production", "universal"
channel.config.certificate_subjectstringHayır
channel.config.certificate_expires_atstringHayır
channel.config.key_idstringHayır
channel.config.team_idstringHayır
channel.config.bundle_idstringHayır
channel.config.environmentenumHayırDeğerler: "sandbox", "production"
channel.config.project_idstringHayır
channel.config.client_emailstringHayır
channel.config.hms_app_idstringHayır
channel.config.high_prioritybooleanHayır
channel.config.subjectstringHayır
channel.config.vapid_public_keystringHayır
channel.config.site_urlstringHayır
channel.config.from_addressstringHayır
channel.config.from_namestringHayır
channel.config.reply_tostringHayır
channel.config.dkim_selectorstringHayır
channel.config.postal_addressstringHayır
channel.config.hoststringHayır
channel.config.portintegerHayır
channel.config.securebooleanHayır
channel.config.usernamestringHayır
channel.config.regionstringHayır
channel.config.access_key_idstringHayır
channel.config.configuration_setstringHayır
channel.config.account_sidstringHayır
channel.config.from_numberstringHayır
channel.config.messaging_service_sidstringHayır
channel.config.usercodestringHayır
channel.config.msgheaderstringHayır
channel.config.iys_filterenumHayırDeğerler: "0", "11", "12"
channel.config.waba_idstringHayır
channel.config.phone_number_idstringHayır
channel.config.graph_api_versionstringHayır
channel.config.display_phone_numberstringHayır
channel.config.verified_namestringHayır
channel.config.rbm_agent_idstringHayır
channel.config.content_sidstringHayır
channel.config.sms_fallbackbooleanHayır
channel.has_secretbooleanEvet
channel.has_hookbooleanEvet
channel.last_validated_atstring | nullEvet
channel.last_errorstring | nullEvet
channel.updated_atstring | nullEvet
channel.suspended_reasonstring | nullEvet
channel.dns_checkobject | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/channels/{channel}/validate

CheckoutResult

AlanTürZorunluAçıklama
urlstringEvet
session_idstringEvet

CleanupResult

AlanTürZorunluAçıklama
deletedintegerEvet

ContentTable

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
descriptionstring | nullEvet
key_columnstringEvet
columnsarray<string>Evet
row_countintegerEvet
versionintegerEvet
source_file_namestring | nullEvet
liquidstringEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].key_columnstringEvet
data[].columnsarray<string>Evet
data[].row_countintegerEvet
data[].versionintegerEvet
data[].source_file_namestring | nullEvet
data[].liquidstringEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/content-tables

ContentTableRows

AlanTürZorunluAçıklama
columnsarray<string>Evet
key_columnstringEvet
totalintegerEvet
dataarray<map<string, string>>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/content-tables/{tableId}/rows

Conversation

AlanTürZorunluAçıklama
idstringEvet
channelenumEvetDeğerler: "sms", "whatsapp", "rcs"
statusenumEvetDeğerler: "open", "closed"
subscription_idstringEvet
subscription_statusstringEvet
user_idstring | nullEvet
external_idstring | nullEvet
contactstringEvet
opted_inbooleanEvet
last_message_atstringEvet
last_inbound_atstring | nullEvet
last_directionenum | nullEvet
last_message_previewstring | nullEvet
unread_countintegerEvet
windowobject | nullEvet
created_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations/{conversationId}, POST /v1/apps/{appId}/conversations/{conversationId}/read

ConversationMessagePage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].directionenumEvetDeğerler: "inbound", "outbound"
data[].statusstringEvet
data[].bodystring | nullEvet
data[].contentmap<string, any>Evet
data[].message_idstring | nullEvet
data[].delivery_idstring | nullEvet
data[].sent_bystring | nullEvet
data[].error_codestring | nullEvet
data[].read_atstring | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations/{conversationId}/messages

ConversationPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].channelenumEvetDeğerler: "sms", "whatsapp", "rcs"
data[].statusenumEvetDeğerler: "open", "closed"
data[].subscription_idstringEvet
data[].subscription_statusstringEvet
data[].user_idstring | nullEvet
data[].external_idstring | nullEvet
data[].contactstringEvet
data[].opted_inbooleanEvet
data[].last_message_atstringEvet
data[].last_inbound_atstring | nullEvet
data[].last_directionenum | nullEvet
data[].last_message_previewstring | nullEvet
data[].unread_countintegerEvet
data[].windowobject | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations

ConversationReplyDto

AlanTürZorunluAçıklama
textstringHayırUzunluk: 1–4096
templateobjectHayır
template.namestringEvet
template.languagestringEvet
template.headerobjectHayır
template.body_paramsarray<string>HayırÖğe: 0–20
template.button_paramsarray<object>HayırÖğe: 0–10
template.button_params[].indexintegerEvetAralık: 0–9
template.button_params[].sub_typeenumEvetDeğerler: "url", "quick_reply", "copy_code"
template.button_params[].valuestringEvetUzunluk: 1–256
mediaobjectHayır
media.typeenumEvetDeğerler: "image", "video", "document", "audio"
media.urlstring (url)EvetUzunluk: 0–2000
media.filenamestringHayırUzunluk: 1–240
interactiveobjectHayır
interactive.typeenumEvetDeğerler: "button", "list"
interactive.headerstringHayırUzunluk: 1–60
interactive.footerstringHayırUzunluk: 1–60
interactive.buttonsarray<object>HayırÖğe: 1–3
interactive.buttons[].idstringEvetUzunluk: 1–256
interactive.buttons[].titlestringEvetUzunluk: 1–20
interactive.listobjectHayır
interactive.list.buttonstringEvetUzunluk: 1–20
interactive.list.sectionsarray<object>EvetÖğe: 1–10

Kullanıldığı işlemler: POST /v1/apps/{appId}/conversations/{conversationId}/messages

ConversationReplyResult

AlanTürZorunluAçıklama
message_idstringEvet
conversation_messageobjectEvet
conversation_message.idstringEvet
conversation_message.directionenumEvetDeğerler: "inbound", "outbound"
conversation_message.statusstringEvet
conversation_message.bodystring | nullEvet
conversation_message.contentmap<string, any>Evet
conversation_message.message_idstring | nullEvet
conversation_message.delivery_idstring | nullEvet
conversation_message.sent_bystring | nullEvet
conversation_message.error_codestring | nullEvet
conversation_message.read_atstring | nullEvet
conversation_message.created_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/conversations/{conversationId}/messages

ConversionsReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
totalsobjectEvet
totals.conversionsintegerEvet
totals.directintegerEvet
totals.influencedintegerEvet
totals.unattributedintegerEvet
totals.revenuenumberEvet
previousobject | nullEvet
by_campaignarray<object>Evet
by_campaign[].campaign_idstring | nullEvet
by_campaign[].namestringEvet
by_campaign[].conversionsintegerEvet
by_campaign[].directintegerEvet
by_campaign[].influencedintegerEvet
by_campaign[].unattributedintegerEvet
by_campaign[].revenuenumberEvet
by_campaign[].sentintegerEvet
by_campaign[].conversion_ratenumber | nullEvet
rowsarray<object>Evet
rows[].datestringEvet
rows[].conversionsintegerEvet
rows[].revenuenumberEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/conversions

CopyTemplateDto

AlanTürZorunluAçıklama
target_app_idstringEvetUzunluk: 1–64
namestringHayırUzunluk: 2–100

Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/copy_to_app

CreateAppApiKeyDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 2–100
scopesarray<enum>EvetÖğe: 1–8
environmentenumHayırDeğerler: "live", "test"; Varsayılan: "live"
expires_atstring (date-time) | nullHayır
ip_allowlistarray<string>HayırÖğe: 0–50

Kullanıldığı işlemler: POST /v1/apps/{appId}/api-keys

CreateAppDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 2–100
slugstringHayır
platform_flagsobjectHayırVarsayılan: {}
platform_flags.iosbooleanHayır
platform_flags.androidbooleanHayır
platform_flags.webbooleanHayır
platform_flags.emailbooleanHayır
platform_flags.smsbooleanHayır
default_languagestringHayırVarsayılan: "en"; Uzunluk: 2–10
timezonestringHayırVarsayılan: "UTC"; Uzunluk: 1–64

Kullanıldığı işlemler: POST /v1/apps

CreateCategoryDto

AlanTürZorunluAçıklama
keystringEvetUzunluk: 1–64
namemap<string, string>Evet
descriptionmap<string, string>Hayır
channelsarray<enum> | nullHayır
default_opted_inbooleanHayır
positionintegerHayırAralık: 0–1000

Kullanıldığı işlemler: POST /v1/apps/{appId}/categories

CreatedApiKey

AlanTürZorunluAçıklama
idstringEvet
org_idstringEvet
app_idstring | nullEvet
namestringEvet
prefixstringEvet
scopesarray<string>Evet
last_used_atstring | nullEvet
expires_atstring | nullEvet
revoked_atstring | nullEvet
ip_allowlistarray<string>Evet
rotated_atstring | nullEvet
created_bystring | nullEvet
created_atstringEvet
keystringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/api-keys, POST /v1/apps/{appId}/api-keys/{keyId}/rotate

CreateDataFeedDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–64
descriptionstring | nullHayır
url_templatestringEvetUzunluk: 1–2048
methodenumHayırDeğerler: "GET", "POST"
body_templatestring | nullHayır
headersmap<string, string>Hayır
secret_headersmap<string, string>Hayır
cache_ttl_secondsintegerHayırAralık: 0–86400
timeout_msintegerHayırAralık: 100–2000
enabledbooleanHayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds

CreateExportDto

AlanTürZorunluAçıklama
typeenumEvetDeğerler: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectHayırVarsayılan: {}
filters.fromstring (date-time)Hayır
filters.tostring (date-time)Hayır
filters.namestringHayırUzunluk: 0–100
filters.message_idstringHayırUzunluk: 0–64
filters.campaign_idstringHayırUzunluk: 0–64
filters.statusstringHayırUzunluk: 0–32
filters.channelenumHayırDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
filters.segment_idstringHayırUzunluk: 0–64

Kullanıldığı işlemler: POST /v1/apps/{appId}/exports

CreateIdentityKeyDto

AlanTürZorunluAçıklama
kidstringHayırUzunluk: 1–64
labelstringHayırUzunluk: 0–80
public_jwkmap<string, any>Hayır
public_key_pemstringHayırUzunluk: 0–4000

Kullanıldığı işlemler: POST /v1/apps/{appId}/identity-keys

CreateInAppDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 2–100
triggersarray<object>EvetÖğe: 1–5
trigger_groupsarray<array<object>>HayırÖğe: 1–10
variantsarray<object>HayırÖğe: 0–10
variants[].idstringEvetUzunluk: 1–64
variants[].namestringEvetUzunluk: 1–60
variants[].weight_percentintegerEvetAralık: 1–99
variants[].displayobjectEvet
variants[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringHayır
variants[].display.text_colorstringHayır
variants[].display.dismissiblebooleanHayır
variants[].display.auto_dismiss_secondsintegerHayırAralık: 1–120
variants[].display.content_typeenumHayırDeğerler: "blocks", "html"
variants[].display.htmlmap<string, string>Hayır
variants[].display.html_heightintegerHayırAralık: 40–2000
variants[].display.blocksarray<object>EvetÖğe: 0–12
ab_testobjectHayır
ab_test.winnerobjectHayır
ab_test.winner.modeenumEvetDeğerler: "manual", "auto"
ab_test.winner.min_impressionsintegerHayırAralık: 10–1000000
ab_test.winner.confidencenumberHayırAralık: 0.8–0.99
displayobjectEvet
display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringHayır
display.text_colorstringHayır
display.dismissiblebooleanHayır
display.auto_dismiss_secondsintegerHayırAralık: 1–120
display.content_typeenumHayırDeğerler: "blocks", "html"
display.htmlmap<string, string>Hayır
display.html_heightintegerHayırAralık: 40–2000
display.blocksarray<object>EvetÖğe: 0–12
audienceobjectHayır
audience.included_segmentsarray<string>HayırÖğe: 0–20
audience.excluded_segmentsarray<string>HayırÖğe: 0–20
frequencyobjectHayır
frequency.max_impressionsintegerHayırAralık: 1–1000
frequency.min_interval_secondsintegerHayırAralık: 0–31536000
frequency.stop_after_interactionbooleanHayır
journey_onlybooleanHayır
priorityintegerHayırAralık: 0–100
start_atstring (date-time) | nullHayır
end_atstring (date-time) | nullHayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages

CreateKeywordDto

AlanTürZorunluAçıklama
keywordstringEvetUzunluk: 1–30
scopeenumHayırDeğerler: "org", "app"
channelsarray<enum>HayırÖğe: 1–3
actionsobjectEvet
actions.add_tagsmap<string, string>Hayır
actions.remove_tagsarray<string>HayırÖğe: 0–50
actions.eventobjectHayır
actions.event.namestringEvet
actions.event.propertiesmap<string, string>Hayır
actions.replyobjectHayır
actions.reply.textstringEvetUzunluk: 1–1600
actions.opt_inbooleanHayır
enabledbooleanHayır
descriptionstringHayırUzunluk: 0–300

Kullanıldığı işlemler: POST /v1/apps/{appId}/sms-keywords

CreateLiveActivityTypeDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–100
descriptionstringHayırUzunluk: 0–300
content_state_schemaobjectEvet
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectHayır
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50

Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/types

CreateNotificationDto

AlanTürZorunluAçıklama
app_idstringHayırUzunluk: 1–∞
idempotency_keystringHayırUzunluk: 1–255
targetobjectEvet
target.allbooleanHayır
target.include_subscription_idsarray<string>HayırÖğe: 0–2000
target.include_external_idsarray<string>HayırÖğe: 0–2000
target.include_aliasesmap<string, array<string>>Hayır
target.included_segmentsarray<string>HayırÖğe: 0–50
target.excluded_segmentsarray<string>HayırÖğe: 0–50
target.filtersanyHayır
target.channelsarray<enum>HayırÖğe: 1–∞
target.test_devices_onlybooleanHayır
target.email_toarray<string>HayırÖğe: 1–2000
target.include_phone_numbersarray<string>HayırÖğe: 1–2000
headingsmap<string, string>Hayır
contentsmap<string, string>Hayır
subtitlemap<string, string>Hayır
urlstring (url)HayırUzunluk: 0–2000
app_urlstring (url)HayırUzunluk: 0–2000
datamap<string, string>Hayır
buttonsarray<object>HayırÖğe: 0–3
buttons[].idstringEvetUzunluk: 1–64
buttons[].textstringEvetUzunluk: 1–100
buttons[].iconstring (url)HayırUzunluk: 0–2000
buttons[].urlstring (url)HayırUzunluk: 0–2000
big_picturestring (url)HayırUzunluk: 0–2000
ios_attachmentsmap<string, string (url)>Hayır
ios_soundstringHayırUzunluk: 0–100
ios_badge_typeenumHayırDeğerler: "None", "SetTo", "Increase"
ios_badge_countintegerHayırAralık: 0–99999
ios_interruption_levelenumHayırDeğerler: "passive", "active", "time-sensitive", "critical"
ios_categorystringHayırUzunluk: 0–100
thread_idstringHayırUzunluk: 0–100
ios_relevance_scorenumberHayırAralık: 0–1
target_content_identifierstringHayırUzunluk: 0–200
android_channel_idstringHayırUzunluk: 0–100
android_groupstringHayırUzunluk: 0–100
android_soundstringHayırUzunluk: 0–100
small_iconstringHayırUzunluk: 0–100
large_iconstring (url) | stringHayır
android_accent_colorstringHayır
android_visibility1 | 0 | -1Hayır
chrome_web_iconstring (url)HayırUzunluk: 0–2000
chrome_web_imagestring (url)HayırUzunluk: 0–2000
chrome_web_badgestring (url)HayırUzunluk: 0–2000
web_push_topicstringHayırUzunluk: 0–32
web_buttonsarray<object>HayırÖğe: 0–2
web_buttons[].idstringEvetUzunluk: 1–64
web_buttons[].textstringEvetUzunluk: 1–100
web_buttons[].iconstring (url)HayırUzunluk: 0–2000
web_buttons[].urlstring (url)HayırUzunluk: 0–2000
require_interactionbooleanHayır
content_availablebooleanHayır
mutable_contentbooleanHayır
collapse_idstringHayırUzunluk: 0–64
priority5 | 10Hayır
ttlintegerHayırAralık: 60–2419200
send_afterstring (date-time)Hayır
delayed_optionenumHayırDeğerler: "timezone", "optimized"
delivery_time_of_daystringHayır
template_idstringHayır
custom_datamap<string, any>Hayır
email_subjectstringHayırUzunluk: 0–998
email_bodystringHayırUzunluk: 0–500000
email_mjmlstringHayırUzunluk: 0–500000
email_preheaderstringHayırUzunluk: 0–500
email_from_namestringHayırUzunluk: 0–200
email_from_addressstring (email)HayırUzunluk: 0–320
email_reply_to_addressstring (email)HayırUzunluk: 0–320
disable_email_click_trackingbooleanHayır
sms_fromstringHayırUzunluk: 1–20
sms_media_urlsarray<string (url)>HayırÖğe: 1–10
disable_sms_link_shorteningbooleanHayır
whatsapp_templateobjectHayır
whatsapp_template.namestringEvet
whatsapp_template.languagestringEvet
whatsapp_template.headerobjectHayır
whatsapp_template.body_paramsarray<string>HayırÖğe: 0–20
whatsapp_template.button_paramsarray<object>HayırÖğe: 0–10
whatsapp_template.button_params[].indexintegerEvetAralık: 0–9
whatsapp_template.button_params[].sub_typeenumEvetDeğerler: "url", "quick_reply", "copy_code"
whatsapp_template.button_params[].valuestringEvetUzunluk: 1–256
whatsapp_mediaobjectHayır
whatsapp_media.typeenumEvetDeğerler: "image", "video", "document", "audio"
whatsapp_media.urlstring (url)EvetUzunluk: 0–2000
whatsapp_media.filenamestringHayırUzunluk: 1–240
whatsapp_interactiveobjectHayır
whatsapp_interactive.typeenumEvetDeğerler: "button", "list"
whatsapp_interactive.headerstringHayırUzunluk: 1–60
whatsapp_interactive.footerstringHayırUzunluk: 1–60
whatsapp_interactive.buttonsarray<object>HayırÖğe: 1–3
whatsapp_interactive.buttons[].idstringEvetUzunluk: 1–256
whatsapp_interactive.buttons[].titlestringEvetUzunluk: 1–20
whatsapp_interactive.listobjectHayır
whatsapp_interactive.list.buttonstringEvetUzunluk: 1–20
whatsapp_interactive.list.sectionsarray<object>EvetÖğe: 1–10
rcs_cardobjectHayır
rcs_card.titlemap<string, string>Hayır
rcs_card.descriptionmap<string, string>Hayır
rcs_card.media_urlstring (url)HayırUzunluk: 0–2000
rcs_card.media_heightenumHayırDeğerler: "SHORT", "MEDIUM", "TALL"
rcs_card.orientationenumHayırDeğerler: "VERTICAL", "HORIZONTAL"
rcs_suggestionsarray<object>HayırÖğe: 0–11
rcs_content_sidstringHayır
rcs_content_variablesmap<string, string>Hayır
rcs_fallback_textmap<string, string>Hayır
add_to_inboxbooleanHayır
inbox_ttlintegerHayırAralık: 60–31536000
frequency_cap_exemptbooleanHayır
quiet_hours_exemptbooleanHayır
one_per_userbooleanHayır
throttle_rate_per_minuteintegerHayırAralık: 0–1000000
include_unsubscribedbooleanHayır
namestringHayırUzunluk: 1–200
labelsarray<string>HayırÖğe: 0–10
categorystringHayırUzunluk: 1–64

Kullanıldığı işlemler: POST /v1/notifications

CreateNotificationResult

AlanTürZorunluAçıklama
idstringEvet
statusenumEvetDeğerler: "queued", "processing", "completed", "cancelled", "failed"
recipients_estimateintegerEvet
external_id_missingarray<string>Evet

Kullanıldığı işlemler: POST /v1/notifications

CreateSuppressionDto

AlanTürZorunluAçıklama
channelenumEvetDeğerler: "email", "sms", "whatsapp", "rcs"
valuestringEvetUzunluk: 3–320
reasonenumHayırDeğerler: "manual", "bounce", "complaint", "unsubscribe_link", "stop"
expires_atstring (date-time)Hayır
notestringHayırUzunluk: 0–500

Kullanıldığı işlemler: POST /v1/apps/{appId}/suppressions

CreateTemplateDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 2–100
channelenum | nullHayır
tagsarray<string>HayırÖğe: 0–20
contentobjectEvet
content.headingsmap<string, string>Hayır
content.contentsmap<string, string>Hayır
content.subtitlemap<string, string>Hayır
content.urlstring (url)HayırUzunluk: 0–2000
content.app_urlstring (url)HayırUzunluk: 0–2000
content.datamap<string, string>Hayır
content.buttonsarray<object>HayırÖğe: 0–3
content.buttons[].idstringEvetUzunluk: 1–64
content.buttons[].textstringEvetUzunluk: 1–100
content.buttons[].iconstring (url)HayırUzunluk: 0–2000
content.buttons[].urlstring (url)HayırUzunluk: 0–2000
content.big_picturestring (url)HayırUzunluk: 0–2000
content.ios_attachmentsmap<string, string (url)>Hayır
content.ios_soundstringHayırUzunluk: 0–100
content.ios_badge_typeenumHayırDeğerler: "None", "SetTo", "Increase"
content.ios_badge_countintegerHayırAralık: 0–99999
content.ios_interruption_levelenumHayırDeğerler: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringHayırUzunluk: 0–100
content.android_channel_idstringHayırUzunluk: 0–100
content.android_groupstringHayırUzunluk: 0–100
content.android_soundstringHayırUzunluk: 0–100
content.chrome_web_iconstring (url)HayırUzunluk: 0–2000
content.chrome_web_imagestring (url)HayırUzunluk: 0–2000
content.chrome_web_badgestring (url)HayırUzunluk: 0–2000
content.web_push_topicstringHayırUzunluk: 0–32
content.content_availablebooleanHayır
content.mutable_contentbooleanHayır
content.custom_datamap<string, any>Hayır
content.email_subjectstringHayırUzunluk: 0–998
content.email_bodystringHayırUzunluk: 0–500000
content.email_mjmlstringHayırUzunluk: 0–500000
content.email_preheaderstringHayırUzunluk: 0–500
content.email_from_namestringHayırUzunluk: 0–200
content.email_from_addressstring (email)HayırUzunluk: 0–320
content.email_reply_to_addressstring (email)HayırUzunluk: 0–320
content.disable_email_click_trackingbooleanHayır
content.sms_fromstringHayırUzunluk: 1–20
content.disable_sms_link_shorteningbooleanHayır
content.add_to_inboxbooleanHayır
content.inbox_ttlintegerHayırAralık: 60–31536000
content.thread_idstringHayırUzunluk: 0–100
content.ios_relevance_scorenumberHayırAralık: 0–1
content.target_content_identifierstringHayırUzunluk: 0–200
content.small_iconstringHayırUzunluk: 0–100
content.large_iconstring (url) | stringHayır
content.android_accent_colorstringHayır
content.android_visibility1 | 0 | -1Hayır
content.web_buttonsarray<object>HayırÖğe: 0–2
content.web_buttons[].idstringEvetUzunluk: 1–64
content.web_buttons[].textstringEvetUzunluk: 1–100
content.web_buttons[].iconstring (url)HayırUzunluk: 0–2000
content.web_buttons[].urlstring (url)HayırUzunluk: 0–2000
content.require_interactionbooleanHayır
content.sms_media_urlsarray<string (url)>HayırÖğe: 1–10
content.whatsapp_templateobjectHayır
content.whatsapp_template.namestringEvet
content.whatsapp_template.languagestringEvet
content.whatsapp_template.headerobjectHayır
content.whatsapp_template.body_paramsarray<string>HayırÖğe: 0–20
content.whatsapp_template.button_paramsarray<object>HayırÖğe: 0–10
content.whatsapp_mediaobjectHayır
content.whatsapp_media.typeenumEvetDeğerler: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)EvetUzunluk: 0–2000
content.whatsapp_media.filenamestringHayırUzunluk: 1–240
content.whatsapp_interactiveobjectHayır
content.whatsapp_interactive.typeenumEvetDeğerler: "button", "list"
content.whatsapp_interactive.headerstringHayırUzunluk: 1–60
content.whatsapp_interactive.footerstringHayırUzunluk: 1–60
content.whatsapp_interactive.buttonsarray<object>HayırÖğe: 1–3
content.whatsapp_interactive.listobjectHayır
content.rcs_cardobjectHayır
content.rcs_card.titlemap<string, string>Hayır
content.rcs_card.descriptionmap<string, string>Hayır
content.rcs_card.media_urlstring (url)HayırUzunluk: 0–2000
content.rcs_card.media_heightenumHayırDeğerler: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumHayırDeğerler: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>HayırÖğe: 0–11
content.rcs_content_sidstringHayır
content.rcs_content_variablesmap<string, string>Hayır
content.rcs_fallback_textmap<string, string>Hayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/templates

CreateWarmupPlanDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–100
kindenumEvetDeğerler: "domain", "ip"
targetstringEvetUzunluk: 2–253
start_datestringHayır
daily_limitsarray<integer>HayırÖğe: 1–120
curveobjectHayır
curve.startintegerEvetAralık: 1–1000000
curve.growthnumberEvetAralık: 1.05–3
curve.targetintegerEvetAralık: 1–10000000
provider_sharesobjectHayır
provider_shares.gmailnumberEvetAralık: 0–1
provider_shares.outlooknumberEvetAralık: 0–1
provider_shares.yahoonumberEvetAralık: 0–1
provider_shares.othernumberEvetAralık: 0–1
timezonestringHayırUzunluk: 1–64

Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/warmup-plans

CreateWebhookDto

AlanTürZorunluAçıklama
urlstringEvetUzunluk: 1–2048
descriptionstring | nullHayır
eventsarray<enum>EvetÖğe: 1–31
event_filtersobjectHayır
event_filters.event_namesarray<string>HayırÖğe: 0–50
batchbooleanHayır
headersmap<string, string>Hayır
body_templatestring | nullHayır
body_content_typeenumHayırŞablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain"
filtersobject | nullHayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks

CustomDomain

AlanTürZorunluAçıklama
idstringEvet
kindenumEvetDeğerler: "dashboard", "tracking", "preference_center", "status_page"
hostnamestringEvet
statusenumEvetDeğerler: "pending", "verified", "active", "failed"
verificationobjectEvet
verification.txt_namestringEvet
verification.txt_valuestringEvet
verification.cname_targetstring | nullEvet
last_errorstring | nullEvet
last_checked_atstring | nullEvet
verified_atstring | nullEvet
activated_atstring | nullEvet
created_atstringEvet

CustomDomainList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].kindenumEvetDeğerler: "dashboard", "tracking", "preference_center", "status_page"
data[].hostnamestringEvet
data[].statusenumEvetDeğerler: "pending", "verified", "active", "failed"
data[].verificationobjectEvet
data[].verification.txt_namestringEvet
data[].verification.txt_valuestringEvet
data[].verification.cname_targetstring | nullEvet
data[].last_errorstring | nullEvet
data[].last_checked_atstring | nullEvet
data[].verified_atstring | nullEvet
data[].activated_atstring | nullEvet
data[].created_atstringEvet

DataFeed

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
descriptionstring | nullEvet
url_templatestringEvet
methodenumEvetDeğerler: "GET", "POST"
body_templatestring | nullEvet
headersmap<string, string>Evet
secret_header_namesarray<string>Evet
cache_ttl_secondsintegerEvet
timeout_msintegerEvet
enabledbooleanEvet
liquidstringEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, PATCH /v1/apps/{appId}/data-feeds/{feedId}

DataFeedList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].url_templatestringEvet
data[].methodenumEvetDeğerler: "GET", "POST"
data[].body_templatestring | nullEvet
data[].headersmap<string, string>Evet
data[].secret_header_namesarray<string>Evet
data[].cache_ttl_secondsintegerEvet
data[].timeout_msintegerEvet
data[].enabledbooleanEvet
data[].liquidstringEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/data-feeds

DataFeedTestResult

AlanTürZorunluAçıklama
statusenumEvetDeğerler: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error"
http_statusinteger | nullEvet
duration_msintegerEvet
errorstring | nullEvet
urlstring | nullEvet
previewanyEvet
truncatedbooleanEvet
userobject | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds/{feedId}/test

DeliverabilitySettingsDto

AlanTürZorunluAçıklama
bcc_addressstring (email) | nullHayır
validationobjectHayır
validation.enabledbooleanEvet
validation.check_mxbooleanHayır
validation.block_disposablebooleanHayır
validation.block_rolebooleanHayır
verifierobjectHayır
verifier.providerenum | nullEvet
verifier.api_keystringHayırUzunluk: 8–200

Kullanıldığı işlemler: PUT /v1/apps/{appId}/email-deliverability

Delivery

AlanTürZorunluAçıklama
idstringEvet
message_idstringEvet
subscription_idstringEvet
user_idstring | nullEvet
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
providerstring | nullEvet
statusenumEvetDeğerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
attempt_countintegerEvet
provider_message_idstring | nullEvet
error_codestring | nullEvet
error_messagestring | nullEvet
suppression_reasonstring | nullEvet
send_afterstring | nullEvet
sent_atstring | nullEvet
delivered_atstring | nullEvet
opened_atstring | nullEvet
clicked_atstring | nullEvet
failed_atstring | nullEvet
created_atstringEvet

DeliveryList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].message_idstringEvet
data[].subscription_idstringEvet
data[].user_idstring | nullEvet
data[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
data[].providerstring | nullEvet
data[].statusenumEvetDeğerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
data[].attempt_countintegerEvet
data[].provider_message_idstring | nullEvet
data[].error_codestring | nullEvet
data[].error_messagestring | nullEvet
data[].suppression_reasonstring | nullEvet
data[].send_afterstring | nullEvet
data[].sent_atstring | nullEvet
data[].delivered_atstring | nullEvet
data[].opened_atstring | nullEvet
data[].clicked_atstring | nullEvet
data[].failed_atstring | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/notifications/{messageId}/deliveries, GET /v1/apps/{appId}/campaigns/{campaignId}/deliveries

EmailAddressCheck

AlanTürZorunluAçıklama
okbooleanEvet
reasonenum | nullEvet
detailstring | nullEvet
checksarray<string>Evet
unknownarray<string>Evet

Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/verify-address

EmailDeliverabilitySettings

AlanTürZorunluAçıklama
bcc_addressstring | nullEvet
validationobjectEvet
validation.enabledbooleanEvet
validation.check_mxbooleanEvet
validation.block_disposablebooleanEvet
validation.block_rolebooleanEvet
verifierobjectEvet
verifier.providerenum | nullEvet
verifier.has_keybooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability

EmailDesign

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
subjectstringEvet
preheaderstring | nullEvet
versionintegerEvet
template_idstring | nullEvet
template_versioninteger | nullEvet
created_bystring | nullEvet
updated_bystring | nullEvet
created_atstringEvet
updated_atstringEvet
documentobjectEvet
document.version1Evet
document.settingsobjectEvet
document.settings.widthintegerHayırAralık: 480–800
document.settings.background_colorstringHayır
document.settings.content_background_colorstringHayır
document.settings.text_colorstringHayır
document.settings.link_colorstringHayır
document.settings.font_familyenumHayırDeğerler: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectHayır
document.sectionsarray<object>EvetÖğe: 0–50
document.sections[].idstringEvet
document.sections[].type"section"Evet
document.sections[].background_colorstringHayır
document.sections[].background_imagestringHayırUzunluk: 1–2000
document.sections[].paddingobjectHayır
document.sections[].stack_on_mobilebooleanHayır
document.sections[].columnsarray<object>EvetÖğe: 1–4
issuesarray<object>Evet
issues[].codeenumEvetDeğerler: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing"
issues[].severityenumEvetDeğerler: "error", "warning"
issues[].block_idstringEvet
issues[].modeenumHayırDeğerler: "light", "dark"
issues[].rationumberHayır
issues[].requirednumberHayır
issues[].foregroundstringHayır
issues[].backgroundstringHayır
warningsarray<string>Evet

EmailDesignPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].subjectstringEvet
data[].preheaderstring | nullEvet
data[].versionintegerEvet
data[].template_idstring | nullEvet
data[].template_versioninteger | nullEvet
data[].created_bystring | nullEvet
data[].updated_bystring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

EmailDesignPreview

AlanTürZorunluAçıklama
htmlstringEvet
mjmlstringEvet
warningsarray<string>Evet
issuesarray<object>Evet
issues[].codeenumEvetDeğerler: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing"
issues[].severityenumEvetDeğerler: "error", "warning"
issues[].block_idstringEvet
issues[].modeenumHayırDeğerler: "light", "dark"
issues[].rationumberHayır
issues[].requirednumberHayır
issues[].foregroundstringHayır
issues[].backgroundstringHayır

EmailSavedBlock

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
kindenumEvetDeğerler: "section", "block"
contentobjectEvet
created_bystring | nullEvet
created_atstringEvet

EmailSavedBlockList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].kindenumEvetDeğerler: "section", "block"
data[].contentobjectEvet
data[].created_bystring | nullEvet
data[].created_atstringEvet

EmailWarmupPlan

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "domain", "ip"
targetstringEvet
start_datestringEvet
daily_limitsarray<integer>Evet
provider_sharesmap<string, number>Evet
timezonestringEvet
statusenumEvetDeğerler: "active", "paused", "completed"
todayobjectEvet
today.daystringEvet
today.indexintegerEvet
today.limitinteger | nullEvet
today.usedintegerEvet
today.bucketsmap<string, object>Evet
scheduled_aheadintegerEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].kindenumEvetDeğerler: "domain", "ip"
data[].targetstringEvet
data[].start_datestringEvet
data[].daily_limitsarray<integer>Evet
data[].provider_sharesmap<string, number>Evet
data[].timezonestringEvet
data[].statusenumEvetDeğerler: "active", "paused", "completed"
data[].todayobjectEvet
data[].today.daystringEvet
data[].today.indexintegerEvet
data[].today.limitinteger | nullEvet
data[].today.usedintegerEvet
data[].today.bucketsmap<string, object>Evet
data[].scheduled_aheadintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability/warmup-plans

EmailWarmupUsage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].daystringEvet
data[].bucketstringEvet
data[].usedintegerEvet
data[].limitinteger | nullEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usage

EndLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringEvetUzunluk: 1–100
content_statemap<string, string | number | boolean>Hayır
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/end

EngagementReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
timezonestringEvet
totalsobjectEvet
totals.openedintegerEvet
totals.clickedintegerEvet
previousobject | nullEvet
cellsarray<object>Evet
cells[].weekdayintegerEvet
cells[].hourintegerEvet
cells[].openedintegerEvet
cells[].clickedintegerEvet
rowsarray<object>Evet
rows[].datestringEvet
rows[].openedintegerEvet
rows[].clickedintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/engagement

EstimateAudienceDto

AlanTürZorunluAçıklama
app_idstringHayırUzunluk: 1–∞
targetobjectEvet
target.allbooleanHayır
target.include_subscription_idsarray<string>HayırÖğe: 0–2000
target.include_external_idsarray<string>HayırÖğe: 0–2000
target.include_aliasesmap<string, array<string>>Hayır
target.included_segmentsarray<string>HayırÖğe: 0–50
target.excluded_segmentsarray<string>HayırÖğe: 0–50
target.filtersanyHayır
target.channelsarray<enum>HayırÖğe: 1–∞
target.test_devices_onlybooleanHayır
target.email_toarray<string>HayırÖğe: 1–2000
target.include_phone_numbersarray<string>HayırÖğe: 1–2000
include_unsubscribedbooleanHayır

Kullanıldığı işlemler: POST /v1/notifications/estimate

EstimateAudienceResult

AlanTürZorunluAçıklama
recipientsintegerEvet
by_channelmap<string, integer>Evet
new_contactsintegerEvet
external_id_missingarray<string>Evet

Kullanıldığı işlemler: POST /v1/notifications/estimate

EventDefinition

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
display_namestring | nullEvet
properties_schemamap<string, string>Evet
is_conversionbooleanEvet
outcome_uniquebooleanEvet
outcome_unattributedbooleanEvet
retention_daysinteger | nullEvet
first_seen_atstringEvet
last_seen_atstringEvet
count_30dintegerEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/events/definitions/{name}

EventDefinitionDetail

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
display_namestring | nullEvet
properties_schemamap<string, string>Evet
is_conversionbooleanEvet
outcome_uniquebooleanEvet
outcome_unattributedbooleanEvet
retention_daysinteger | nullEvet
first_seen_atstringEvet
last_seen_atstringEvet
count_30dintegerEvet
created_atstringEvet
updated_atstringEvet
dailyarray<object>Evet
daily[].datestringEvet
daily[].countintegerEvet
daily[].usersintegerEvet
propertiesarray<object>Evet
properties[].keystringEvet
properties[].typestringEvet
properties[].valuesarray<object>Evet
properties[].values[].valuestringEvet
properties[].values[].countintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/events/definitions/{name}

EventDefinitionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].display_namestring | nullEvet
data[].properties_schemamap<string, string>Evet
data[].is_conversionbooleanEvet
data[].outcome_uniquebooleanEvet
data[].outcome_unattributedbooleanEvet
data[].retention_daysinteger | nullEvet
data[].first_seen_atstringEvet
data[].last_seen_atstringEvet
data[].count_30dintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/events/definitions

EventList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].user_idstring | nullEvet
data[].subscription_idstring | nullEvet
data[].namestringEvet
data[].propertiesmap<string, any>Evet
data[].valuenumber | nullEvet
data[].sourceenumEvetDeğerler: "sdk", "api", "system", "import"
data[].occurred_atstringEvet

EventsAccepted

AlanTürZorunluAçıklama
acceptedintegerEvet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/events, POST /v1/apps/{appId}/events

EventsReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
group_byenumEvetDeğerler: "day", "name"
namestring | nullEvet
totalsobjectEvet
totals.countintegerEvet
totals.usersintegerEvet
previousobject | nullEvet
rowsarray<object>Evet
rows[].keystringEvet
rows[].countintegerEvet
rows[].usersintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/events

Export

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
typeenumEvetDeğerler: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectEvet
filters.fromstring (date-time)Hayır
filters.tostring (date-time)Hayır
filters.namestringHayırUzunluk: 0–100
filters.message_idstringHayırUzunluk: 0–64
filters.campaign_idstringHayırUzunluk: 0–64
filters.statusstringHayırUzunluk: 0–32
filters.channelenumHayırDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
filters.segment_idstringHayırUzunluk: 0–64
statusenumEvetDeğerler: "pending", "running", "completed", "failed"
row_countinteger | nullEvet
errorstring | nullEvet
download_urlstring | nullEvet
expires_atstring | nullEvet
requested_bystring | nullEvet
created_atstringEvet
completed_atstring | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/exports, GET /v1/apps/{appId}/exports/{exportId}, GET /v1/notifications/{messageId}/history, POST /v1/notifications/{messageId}/export_events

ExportList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].typeenumEvetDeğerler: "users", "subscriptions", "events", "deliveries", "message_events"
data[].filtersobjectEvet
data[].filters.fromstring (date-time)Hayır
data[].filters.tostring (date-time)Hayır
data[].filters.namestringHayırUzunluk: 0–100
data[].filters.message_idstringHayırUzunluk: 0–64
data[].filters.campaign_idstringHayırUzunluk: 0–64
data[].filters.statusstringHayırUzunluk: 0–32
data[].filters.channelenumHayırDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
data[].filters.segment_idstringHayırUzunluk: 0–64
data[].statusenumEvetDeğerler: "pending", "running", "completed", "failed"
data[].row_countinteger | nullEvet
data[].errorstring | nullEvet
data[].download_urlstring | nullEvet
data[].expires_atstring | nullEvet
data[].requested_bystring | nullEvet
data[].created_atstringEvet
data[].completed_atstring | nullEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/exports

FunnelBodyDto

AlanTürZorunluAçıklama
stepsarray<object>EvetÖğe: 2–8
steps[].namestringEvetUzunluk: 1–100
steps[].whereobjectHayır
steps[].where.keystringEvetUzunluk: 1–64
steps[].where.valuestringEvetUzunluk: 0–500
fromstring (date-time)Hayır
tostring (date-time)Hayır
window_hoursintegerHayırVarsayılan: 72; Aralık: 1–720
comparebooleanHayırVarsayılan: false
formatenumHayırDeğerler: "json", "csv"; Varsayılan: "json"

Kullanıldığı işlemler: POST /v1/apps/{appId}/analytics/funnels

FunnelReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
window_hoursintegerEvet
stepsarray<object>Evet
steps[].namestringEvet
steps[].usersintegerEvet
steps[].conversion_ratenumber | nullEvet
steps[].drop_offintegerEvet
overall_ratenumber | nullEvet
previousobject | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/analytics/funnels

IdentityKey

AlanTürZorunluAçıklama
idstringEvet
kidstringEvet
alg"ES256"Evet
public_jwkmap<string, string>Evet
labelstring | nullEvet
created_atstringEvet
revoked_atstring | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}

IdentityKeyList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].kidstringEvet
data[].alg"ES256"Evet
data[].public_jwkmap<string, string>Evet
data[].labelstring | nullEvet
data[].created_atstringEvet
data[].revoked_atstring | nullEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/identity-keys

Import

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
typeenumEvetDeğerler: "onesignal_players", "csv_users"
file_namestring | nullEvet
statusenumEvetDeğerler: "pending", "running", "completed", "failed"
statsobjectEvet
stats.processedintegerHayır
stats.created_usersintegerHayır
stats.updated_usersintegerHayır
stats.created_subscriptionsintegerHayır
stats.skippedintegerHayır
stats.errorsintegerHayır
errorstring | nullEvet
error_report_urlstring | nullEvet
requested_bystring | nullEvet
created_atstringEvet
completed_atstring | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/imports, GET /v1/apps/{appId}/imports/{importId}

ImportList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].typeenumEvetDeğerler: "onesignal_players", "csv_users"
data[].file_namestring | nullEvet
data[].statusenumEvetDeğerler: "pending", "running", "completed", "failed"
data[].statsobjectEvet
data[].stats.processedintegerHayır
data[].stats.created_usersintegerHayır
data[].stats.updated_usersintegerHayır
data[].stats.created_subscriptionsintegerHayır
data[].stats.skippedintegerHayır
data[].stats.errorsintegerHayır
data[].errorstring | nullEvet
data[].error_report_urlstring | nullEvet
data[].requested_bystring | nullEvet
data[].created_atstringEvet
data[].completed_atstring | nullEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/imports

InAppMessage

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
statusenumEvetDeğerler: "draft", "active", "paused", "archived"
priorityintegerEvet
triggersarray<object>Evet
trigger_groupsarray<array<object>> | nullEvet
variantsarray<object>Evet
variants[].idstringEvetUzunluk: 1–64
variants[].namestringEvetUzunluk: 1–60
variants[].weight_percentintegerEvetAralık: 1–99
variants[].displayobjectEvet
variants[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringHayır
variants[].display.text_colorstringHayır
variants[].display.dismissiblebooleanHayır
variants[].display.auto_dismiss_secondsintegerHayırAralık: 1–120
variants[].display.content_typeenumHayırDeğerler: "blocks", "html"
variants[].display.htmlmap<string, string>Hayır
variants[].display.html_heightintegerHayırAralık: 40–2000
variants[].display.blocksarray<object>EvetÖğe: 0–12
displayobjectEvet
display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringHayır
display.text_colorstringHayır
display.dismissiblebooleanHayır
display.auto_dismiss_secondsintegerHayırAralık: 1–120
display.content_typeenumHayırDeğerler: "blocks", "html"
display.htmlmap<string, string>Hayır
display.html_heightintegerHayırAralık: 40–2000
display.blocksarray<object>EvetÖğe: 0–12
audienceobjectEvet
audience.included_segmentsarray<string>HayırÖğe: 0–20
audience.excluded_segmentsarray<string>HayırÖğe: 0–20
frequencyobjectEvet
frequency.max_impressionsintegerHayırAralık: 1–1000
frequency.min_interval_secondsintegerHayırAralık: 0–31536000
frequency.stop_after_interactionbooleanHayır
journey_onlybooleanEvet
start_atstring | nullEvet
end_atstring | nullEvet
statsobjectEvet
stats.impressionsintegerEvet
stats.clicksintegerEvet
stats.dismissalsintegerEvet
stats.unique_usersintegerEvet
stats.ctrnumberEvet
variant_statsarray<object>Evet
variant_stats[].variant_idstringEvet
variant_stats[].impressionsintegerEvet
variant_stats[].clicksintegerEvet
variant_stats[].ctrnumberEvet
ab_testobjectEvet
ab_test.winnerobjectHayır
ab_test.winner.modeenumEvetDeğerler: "manual", "auto"
ab_test.winner.min_impressionsintegerHayırAralık: 10–1000000
ab_test.winner.confidencenumberHayırAralık: 0.8–0.99
ab_test.winner_variant_idstring | nullEvet
ab_test.decided_atstring | nullEvet
ab_test.decided_bystring | nullEvet
variant_significanceobject | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: 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

InAppMessagePage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].statusenumEvetDeğerler: "draft", "active", "paused", "archived"
data[].priorityintegerEvet
data[].triggersarray<object>Evet
data[].trigger_groupsarray<array<object>> | nullEvet
data[].variantsarray<object>Evet
data[].variants[].idstringEvetUzunluk: 1–64
data[].variants[].namestringEvetUzunluk: 1–60
data[].variants[].weight_percentintegerEvetAralık: 1–99
data[].variants[].displayobjectEvet
data[].displayobjectEvet
data[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstringHayır
data[].display.text_colorstringHayır
data[].display.dismissiblebooleanHayır
data[].display.auto_dismiss_secondsintegerHayırAralık: 1–120
data[].display.content_typeenumHayırDeğerler: "blocks", "html"
data[].display.htmlmap<string, string>Hayır
data[].display.html_heightintegerHayırAralık: 40–2000
data[].display.blocksarray<object>EvetÖğe: 0–12
data[].audienceobjectEvet
data[].audience.included_segmentsarray<string>HayırÖğe: 0–20
data[].audience.excluded_segmentsarray<string>HayırÖğe: 0–20
data[].frequencyobjectEvet
data[].frequency.max_impressionsintegerHayırAralık: 1–1000
data[].frequency.min_interval_secondsintegerHayırAralık: 0–31536000
data[].frequency.stop_after_interactionbooleanHayır
data[].journey_onlybooleanEvet
data[].start_atstring | nullEvet
data[].end_atstring | nullEvet
data[].statsobjectEvet
data[].stats.impressionsintegerEvet
data[].stats.clicksintegerEvet
data[].stats.dismissalsintegerEvet
data[].stats.unique_usersintegerEvet
data[].stats.ctrnumberEvet
data[].variant_statsarray<object>Evet
data[].variant_stats[].variant_idstringEvet
data[].variant_stats[].impressionsintegerEvet
data[].variant_stats[].clicksintegerEvet
data[].variant_stats[].ctrnumberEvet
data[].ab_testobjectEvet
data[].ab_test.winnerobjectHayır
data[].ab_test.winner_variant_idstring | nullEvet
data[].ab_test.decided_atstring | nullEvet
data[].ab_test.decided_bystring | nullEvet
data[].variant_significanceobject | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/in-app-messages

InAppStatusDto

AlanTürZorunluAçıklama
statusenumEvetDeğerler: "draft", "active", "paused", "archived"

Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages/{messageId}/status

InAppTemplate

AlanTürZorunluAçıklama
idstringEvet
sourceenumEvetDeğerler: "system", "org"
categoryenumEvetDeğerler: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom"
namestringEvet
descriptionstring | nullEvet
displayobjectEvet
display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringHayır
display.text_colorstringHayır
display.dismissiblebooleanHayır
display.auto_dismiss_secondsintegerHayırAralık: 1–120
display.content_typeenumHayırDeğerler: "blocks", "html"
display.htmlmap<string, string>Hayır
display.html_heightintegerHayırAralık: 40–2000
display.blocksarray<object>EvetÖğe: 0–12
created_atstring | nullEvet
updated_atstring | nullEvet

InAppTemplateList

AlanTürZorunluAçıklama
gallery_versionstringEvet
dataarray<object>Evet
data[].idstringEvet
data[].sourceenumEvetDeğerler: "system", "org"
data[].categoryenumEvetDeğerler: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom"
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].displayobjectEvet
data[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstringHayır
data[].display.text_colorstringHayır
data[].display.dismissiblebooleanHayır
data[].display.auto_dismiss_secondsintegerHayırAralık: 1–120
data[].display.content_typeenumHayırDeğerler: "blocks", "html"
data[].display.htmlmap<string, string>Hayır
data[].display.html_heightintegerHayırAralık: 40–2000
data[].display.blocksarray<object>EvetÖğe: 0–12
data[].created_atstring | nullEvet
data[].updated_atstring | nullEvet

InAppWinnerDto

AlanTürZorunluAçıklama
variant_idstringEvetUzunluk: 1–64

Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages/{messageId}/winner

InboxItem

AlanTürZorunluAçıklama
idstringEvet
message_idstring | nullEvet
titlestring | nullEvet
bodystring | nullEvet
urlstring | nullEvet
image_urlstring | nullEvet
datamap<string, string>Evet
readbooleanEvet
read_atstring | nullEvet
archived_atstring | nullEvet
expires_atstring | nullEvet
created_atstringEvet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read

InboxPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].message_idstring | nullEvet
data[].titlestring | nullEvet
data[].bodystring | nullEvet
data[].urlstring | nullEvet
data[].image_urlstring | nullEvet
data[].datamap<string, string>Evet
data[].readbooleanEvet
data[].read_atstring | nullEvet
data[].archived_atstring | nullEvet
data[].expires_atstring | nullEvet
data[].created_atstringEvet
unread_countintegerEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/users/{userId}/inbox, GET /v1/apps/{appId}/users/by/{label}/{value}/inbox

InboxReadAllResult

AlanTürZorunluAçıklama
updatedintegerEvet
unread_countintegerEvet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all

Integration

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
typeenumEvetDeğerler: "segment", "amplitude", "mixpanel", "zapier", "slack"
namestringEvet
statusenumEvetDeğerler: "active", "paused", "error"
settingsmap<string, any>Evet
eventsarray<string>Evet
credentialsmap<string, string>Evet
statemap<string, any>Evet
inbound_urlstring | nullEvet
interactions_urlstring | nullEvet
pending_eventsintegerEvet
dead_eventsintegerEvet
hooksintegerEvet
consecutive_failuresintegerEvet
last_errorstring | nullEvet
last_error_atstring | nullEvet
last_success_atstring | nullEvet
last_run_atstring | nullEvet
next_sync_atstring | nullEvet
created_atstringEvet
updated_atstringEvet

IntegrationList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].typeenumEvetDeğerler: "segment", "amplitude", "mixpanel", "zapier", "slack"
data[].namestringEvet
data[].statusenumEvetDeğerler: "active", "paused", "error"
data[].settingsmap<string, any>Evet
data[].eventsarray<string>Evet
data[].credentialsmap<string, string>Evet
data[].statemap<string, any>Evet
data[].inbound_urlstring | nullEvet
data[].interactions_urlstring | nullEvet
data[].pending_eventsintegerEvet
data[].dead_eventsintegerEvet
data[].hooksintegerEvet
data[].consecutive_failuresintegerEvet
data[].last_errorstring | nullEvet
data[].last_error_atstring | nullEvet
data[].last_success_atstring | nullEvet
data[].last_run_atstring | nullEvet
data[].next_sync_atstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
catalogarray<object>Evet
catalog[].typeenumEvetDeğerler: "segment", "amplitude", "mixpanel", "zapier", "slack"
catalog[].eventsarray<string>Evet
catalog[].cohortsbooleanEvet
catalog[].inboundbooleanEvet

IntegrationOk

AlanTürZorunluAçıklama
oktrueEvet

Kullanıldığı işlemler: DELETE /v1/apps/{appId}/integrations/zapier/hooks/{hookId}

IntegrationRunList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].kindenumEvetDeğerler: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test"
data[].triggerenumEvetDeğerler: "schedule", "manual", "event", "inbound"
data[].statusenumEvetDeğerler: "running", "succeeded", "partial", "failed"
data[].statsmap<string, number>Evet
data[].errorstring | nullEvet
data[].started_atstringEvet
data[].finished_atstring | nullEvet
data[].duration_msinteger | nullEvet

IntegrationSyncResult

AlanTürZorunluAçıklama
queuedtrueEvet
next_sync_atstringEvet

IntegrationTestResult

AlanTürZorunluAçıklama
okbooleanEvet
errorstring | nullEvet
run_idstringEvet

Invite

AlanTürZorunluAçıklama
idstringEvet
emailstringEvet
roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
expires_atstringEvet
invited_bystring | nullEvet
created_atstringEvet

InviteList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].emailstringEvet
data[].roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
data[].expires_atstringEvet
data[].invited_bystring | nullEvet
data[].created_atstringEvet

InvitePreview

AlanTürZorunluAçıklama
org_namestringEvet
emailstringEvet
roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
expires_atstringEvet
inviter_namestring | nullEvet

InvoiceList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].provider_invoice_idstringEvet
data[].amountintegerEvet
data[].currencystringEvet
data[].statusstringEvet
data[].pdf_urlstring | nullEvet
data[].hosted_urlstring | nullEvet
data[].period_startstring | nullEvet
data[].period_endstring | nullEvet
data[].issued_atstring | nullEvet

Journey

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
descriptionstring | nullEvet
statusenumEvetDeğerler: "draft", "active", "paused", "archived"
current_versioninteger | nullEvet
draft_versioninteger | nullEvet
trigger_kindstring | nullEvet
published_atstring | nullEvet
created_bystring | nullEvet
created_atstringEvet
updated_atstringEvet
summaryobjectEvet
summary.runs_totalintegerEvet
summary.activeintegerEvet
summary.completedintegerEvet
summary.exitedintegerEvet
summary.failedintegerEvet
summary.goal_reachedintegerEvet

JourneyDetail

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
descriptionstring | nullEvet
statusenumEvetDeğerler: "draft", "active", "paused", "archived"
current_versioninteger | nullEvet
draft_versioninteger | nullEvet
trigger_kindstring | nullEvet
published_atstring | nullEvet
created_bystring | nullEvet
created_atstringEvet
updated_atstringEvet
summaryobjectEvet
summary.runs_totalintegerEvet
summary.activeintegerEvet
summary.completedintegerEvet
summary.exitedintegerEvet
summary.failedintegerEvet
summary.goal_reachedintegerEvet
editingobjectEvet
editing.versionintegerEvet
editing.graphmap<string, any>Evet
editing.settingsmap<string, any>Evet
editing.published_atstring | nullEvet
editing.published_bystring | nullEvet
editing.created_atstringEvet
editing.updated_atstringEvet
issuesarray<object>Evet
issues[].codestringEvet
issues[].node_idstringHayır
issues[].edge_idstringHayır
issues[].messagestringEvet

Kullanıldığı işlemler: 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}/pause, POST /v1/apps/{appId}/journeys/{journeyId}/resume, POST /v1/apps/{appId}/journeys/{journeyId}/archive, POST /v1/apps/{appId}/journeys/{journeyId}/duplicate

JourneyPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].statusenumEvetDeğerler: "draft", "active", "paused", "archived"
data[].current_versioninteger | nullEvet
data[].draft_versioninteger | nullEvet
data[].trigger_kindstring | nullEvet
data[].published_atstring | nullEvet
data[].created_bystring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
data[].summaryobjectEvet
data[].summary.runs_totalintegerEvet
data[].summary.activeintegerEvet
data[].summary.completedintegerEvet
data[].summary.exitedintegerEvet
data[].summary.failedintegerEvet
data[].summary.goal_reachedintegerEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys

JourneyPublishResult

AlanTürZorunluAçıklama
journeyobjectEvet
journey.idstringEvet
journey.app_idstringEvet
journey.namestringEvet
journey.descriptionstring | nullEvet
journey.statusenumEvetDeğerler: "draft", "active", "paused", "archived"
journey.current_versioninteger | nullEvet
journey.draft_versioninteger | nullEvet
journey.trigger_kindstring | nullEvet
journey.published_atstring | nullEvet
journey.created_bystring | nullEvet
journey.created_atstringEvet
journey.updated_atstringEvet
journey.summaryobjectEvet
journey.summary.runs_totalintegerEvet
journey.summary.activeintegerEvet
journey.summary.completedintegerEvet
journey.summary.exitedintegerEvet
journey.summary.failedintegerEvet
journey.summary.goal_reachedintegerEvet
versionintegerEvet
issuesarray<object>Evet
issues[].codestringEvet
issues[].node_idstringHayır
issues[].edge_idstringHayır
issues[].messagestringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/publish

JourneyRun

AlanTürZorunluAçıklama
idstringEvet
journey_idstringEvet
versionintegerEvet
user_idstringEvet
external_idstring | nullEvet
statusenumEvetDeğerler: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullEvet
next_action_atstring | nullEvet
entered_atstringEvet
completed_atstring | nullEvet
exit_reasonstring | nullEvet
goal_idstring | nullEvet
goal_reached_atstring | nullEvet
contextmap<string, any>Evet

JourneyRunDetail

AlanTürZorunluAçıklama
idstringEvet
journey_idstringEvet
versionintegerEvet
user_idstringEvet
external_idstring | nullEvet
statusenumEvetDeğerler: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullEvet
next_action_atstring | nullEvet
entered_atstringEvet
completed_atstring | nullEvet
exit_reasonstring | nullEvet
goal_idstring | nullEvet
goal_reached_atstring | nullEvet
contextmap<string, any>Evet
journey_namestringEvet
stepsarray<object>Evet
steps[].idstringEvet
steps[].node_idstringEvet
steps[].node_typestringEvet
steps[].statusenumEvetDeğerler: "completed", "waiting", "failed", "skipped"
steps[].branchstring | nullEvet
steps[].resultmap<string, any>Evet
steps[].started_atstringEvet
steps[].finished_atstring | nullEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}, DELETE /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}

JourneyRunPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].journey_idstringEvet
data[].versionintegerEvet
data[].user_idstringEvet
data[].external_idstring | nullEvet
data[].statusenumEvetDeğerler: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullEvet
data[].next_action_atstring | nullEvet
data[].entered_atstringEvet
data[].completed_atstring | nullEvet
data[].exit_reasonstring | nullEvet
data[].goal_idstring | nullEvet
data[].goal_reached_atstring | nullEvet
data[].contextmap<string, any>Evet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/runs

JourneyStats

AlanTürZorunluAçıklama
versioninteger | nullEvet
summaryobjectEvet
summary.runs_totalintegerEvet
summary.activeintegerEvet
summary.completedintegerEvet
summary.exitedintegerEvet
summary.failedintegerEvet
summary.goal_reachedintegerEvet
summary.waitingintegerEvet
summary.goal_conversion_ratenumberEvet
nodesarray<object>Evet
nodes[].node_idstringEvet
nodes[].node_typestringEvet
nodes[].enteredintegerEvet
nodes[].completedintegerEvet
nodes[].waiting_nowintegerEvet
nodes[].skippedintegerEvet
nodes[].failedintegerEvet
nodes[].branchesmap<string, integer>Evet
nodes[].messagesmap<string, integer>Hayır
nodes[].variantsarray<object>Hayır
nodes[].variants[].variant_idstringEvet
nodes[].variants[].sentintegerEvet
nodes[].variants[].openedintegerEvet
nodes[].variants[].clickedintegerEvet
nodes[].variants[].convertedintegerEvet
nodes[].variants[].winnerbooleanEvet
goalsarray<object>Evet
goals[].goal_idstringEvet
goals[].reachedintegerEvet
exit_reasonsmap<string, integer>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/stats

JourneyTriggerResult

AlanTürZorunluAçıklama
enteredbooleanEvet
runobject | nullEvet
reasonenum | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/runs

JourneyVersionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].versionintegerEvet
data[].graphmap<string, any>Evet
data[].settingsmap<string, any>Evet
data[].published_atstring | nullEvet
data[].published_bystring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/versions

LiveActivitySendResult

AlanTürZorunluAçıklama
message_idstringEvet
activity_idstringEvet
eventenumEvetDeğerler: "start", "update", "end"
recipients_estimateintegerEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
oktrueEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
descriptionstring | nullEvet
content_state_schemaobjectEvet
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectEvet
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50
push_to_start_tokensintegerEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}

LiveActivityTypeList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].content_state_schemaobjectEvet
data[].content_state_schema.type"object"Evet
data[].content_state_schema.propertiesmap<string, object>Evet
data[].content_state_schema.requiredarray<string>HayırÖğe: 0–50
data[].attributes_schemaobjectEvet
data[].attributes_schema.type"object"Evet
data[].attributes_schema.propertiesmap<string, object>Evet
data[].attributes_schema.requiredarray<string>HayırÖğe: 0–50
data[].push_to_start_tokensintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/live-activities/types

LoginResult

AlanTürZorunluAçıklama
mfa_requiredbooleanEvet
mfa_tokenstringHayır
accountobjectHayır
account.idstringEvet
account.emailstringEvet
account.namestringEvet
account.localestringEvet
account.timezonestringEvet
account.email_verifiedbooleanEvet
account.mfa_enabledbooleanEvet
account.is_platform_adminbooleanEvet
account.has_passwordbooleanEvet
account.marketing_opt_inbooleanEvet
account.created_atstringEvet

Me

AlanTürZorunluAçıklama
accountobjectEvet
account.idstringEvet
account.emailstringEvet
account.namestringEvet
account.localestringEvet
account.timezonestringEvet
account.email_verifiedbooleanEvet
account.mfa_enabledbooleanEvet
account.is_platform_adminbooleanEvet
account.has_passwordbooleanEvet
account.marketing_opt_inbooleanEvet
account.created_atstringEvet
membershipsarray<object>Evet
memberships[].org_idstringEvet
memberships[].org_namestringEvet
memberships[].org_slugstringEvet
memberships[].roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
memberships[].app_scopesarray<string>Evet
memberships[].mfa_requiredbooleanEvet
admin_mfa_requiredbooleanEvet
mock_providers_availablebooleanEvet

Member

AlanTürZorunluAçıklama
idstringEvet
account_idstringEvet
emailstringEvet
namestringEvet
roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
app_scopesarray<string>Evet
accepted_atstring | nullEvet
created_atstringEvet
last_login_atstring | nullEvet

MemberList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].account_idstringEvet
data[].emailstringEvet
data[].namestringEvet
data[].roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
data[].app_scopesarray<string>Evet
data[].accepted_atstring | nullEvet
data[].created_atstringEvet
data[].last_login_atstring | nullEvet

Kullanıldığı işlemler: GET /v1/organization/members

Message

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
sourceenumEvetDeğerler: "campaign", "api", "journey", "test"
statusenumEvetDeğerler: "queued", "processing", "completed", "cancelled", "failed"
idempotency_keystring | nullEvet
namestring | nullEvet
contentmap<string, any>Evet
targetmap<string, any>Evet
optionsmap<string, any>Evet
labelsarray<string>Evet
categorystring | nullEvet
template_idstring | nullEvet
campaign_idstring | nullEvet
variantsarray<object> | nullEvet
countsobjectEvet
counts.targetedintegerHayır
counts.suppressedintegerHayır
counts.sentintegerHayır
counts.deliveredintegerHayır
counts.failedintegerHayır
counts.erroredintegerHayır
counts.expiredintegerHayır
counts.openedintegerHayır
counts.clickedintegerHayır
counts.convertedintegerHayır
counts.bouncedintegerHayır
counts.complainedintegerHayır
counts.unsubscribedintegerHayır
counts.sms_segmentsintegerHayır
requested_byobjectEvet
requested_by.typeenumEvetDeğerler: "api_key", "account", "system"
requested_by.idstringHayır
errorstring | nullEvet
scheduled_forstring | nullEvet
started_atstring | nullEvet
completed_atstring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: GET /v1/notifications/{messageId}, DELETE /v1/notifications/{messageId}

MessageCategory

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
keystringEvet
namemap<string, string>Evet
descriptionmap<string, string>Evet
channelsarray<string> | nullEvet
default_opted_inbooleanEvet
positionintegerEvet
opted_out_usersintegerEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}

MessageCategoryList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].keystringEvet
data[].namemap<string, string>Evet
data[].descriptionmap<string, string>Evet
data[].channelsarray<string> | nullEvet
data[].default_opted_inbooleanEvet
data[].positionintegerEvet
data[].opted_out_usersintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/categories

MessageList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].sourceenumEvetDeğerler: "campaign", "api", "journey", "test"
data[].statusenumEvetDeğerler: "queued", "processing", "completed", "cancelled", "failed"
data[].idempotency_keystring | nullEvet
data[].namestring | nullEvet
data[].contentmap<string, any>Evet
data[].targetmap<string, any>Evet
data[].optionsmap<string, any>Evet
data[].labelsarray<string>Evet
data[].categorystring | nullEvet
data[].template_idstring | nullEvet
data[].campaign_idstring | nullEvet
data[].variantsarray<object> | nullEvet
data[].countsobjectEvet
data[].counts.targetedintegerHayır
data[].counts.suppressedintegerHayır
data[].counts.sentintegerHayır
data[].counts.deliveredintegerHayır
data[].counts.failedintegerHayır
data[].counts.erroredintegerHayır
data[].counts.expiredintegerHayır
data[].counts.openedintegerHayır
data[].counts.clickedintegerHayır
data[].counts.convertedintegerHayır
data[].counts.bouncedintegerHayır
data[].counts.complainedintegerHayır
data[].counts.unsubscribedintegerHayır
data[].counts.sms_segmentsintegerHayır
data[].requested_byobjectEvet
data[].requested_by.typeenumEvetDeğerler: "api_key", "account", "system"
data[].requested_by.idstringHayır
data[].errorstring | nullEvet
data[].scheduled_forstring | nullEvet
data[].started_atstring | nullEvet
data[].completed_atstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/notifications, GET /v1/apps/{appId}/campaigns/{campaignId}/messages

MessagesReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
group_byenumEvetDeğerler: "day", "channel", "campaign"
totalsobjectEvet
totals.sentintegerEvet
totals.deliveredintegerEvet
totals.failedintegerEvet
totals.openedintegerEvet
totals.clickedintegerEvet
totals.convertedintegerEvet
totals.delivery_ratenumber | nullEvet
totals.open_ratenumber | nullEvet
totals.click_ratenumber | nullEvet
previousobject | nullEvet
rowsarray<object>Evet
rows[].keystringEvet
rows[].labelstringEvet
rows[].sentintegerEvet
rows[].deliveredintegerEvet
rows[].failedintegerEvet
rows[].openedintegerEvet
rows[].clickedintegerEvet
rows[].convertedintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/messages

MfaSetup

AlanTürZorunluAçıklama
secretstringEvet
otpauth_uristringEvet

OAuthApproveResult

AlanTürZorunluAçıklama
redirect_tostringEvet

OAuthConsentContext

AlanTürZorunluAçıklama
clientobjectEvet
client.client_idstringEvet
client.client_namestringEvet
client.client_uristring | nullEvet
client.redirect_hoststringEvet
requested_scopesarray<string>Evet
available_scopesarray<string>Evet
deny_urlstringEvet
organizationsarray<object>Evet
organizations[].idstringEvet
organizations[].namestringEvet
organizations[].slugstringEvet
organizations[].rolestringEvet
organizations[].org_wide_allowedbooleanEvet
organizations[].grantable_scopesarray<string>Evet
organizations[].appsarray<object>Evet
organizations[].apps[].idstringEvet
organizations[].apps[].namestringEvet

Ok

AlanTürZorunluAçıklama
oktrueEvet

Kullanıldığı işlemler: 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}/webhooks/{webhookId}, DELETE /v1/apps/{appId}/warehouse-exports/{exportId}, DELETE /v1/apps/{appId}/users/by/{label}/{value}, DELETE /v1/apps/{appId}/subscriptions/{subscriptionId}, …

OpenedDto

AlanTürZorunluAçıklama
button_idstringHayırUzunluk: 0–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened

Org

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
slugstringEvet
plan_codestringEvet
statusenumEvetDeğerler: "active", "suspended", "deleted"
settingsobjectEvet
settings.mfaRequiredbooleanHayır
settings.ipAllowlistarray<string>HayırÖğe: 0–50
settings.retentionDaysintegerHayırAralık: 7–3650
settings.sessionMaxHoursintegerHayırAralık: 1–2160
settings.auditStreamobjectHayır
settings.auditStream.s3booleanHayır
settings.auditStream.webhookAppIdstring | nullHayır
created_atstringEvet
regionstring | nullEvet
managed_by_resellerbooleanEvet

Kullanıldığı işlemler: GET /v1/organization

OrgDataExport

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].app_idstringEvet
data[].app_namestringEvet
data[].export_idsarray<string>Evet

OrgList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].slugstringEvet
data[].plan_codestringEvet
data[].statusenumEvetDeğerler: "active", "suspended", "deleted"
data[].settingsobjectEvet
data[].settings.mfaRequiredbooleanHayır
data[].settings.ipAllowlistarray<string>HayırÖğe: 0–50
data[].settings.retentionDaysintegerHayırAralık: 7–3650
data[].settings.sessionMaxHoursintegerHayırAralık: 1–2160
data[].settings.auditStreamobjectHayır
data[].created_atstringEvet
data[].regionstring | nullEvet
data[].managed_by_resellerbooleanEvet
data[].roleenumEvetDeğerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer"
data[].app_scopesarray<string>Evet

OrgNotificationList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].kindenumEvetDeğerler: "channel_invalid", "channel_expiring", "campaign_approval", "message_failed", "export_ready", "import_finished", "webhook_unhealthy"
data[].severityenumEvetDeğerler: "error", "warning", "info", "success"
data[].app_idstringEvet
data[].app_namestringEvet
data[].titlestringEvet
data[].detailstring | nullEvet
data[].target_idstring | nullEvet
data[].atstringEvet

OverviewStats

AlanTürZorunluAçıklama
rangeenumEvetDeğerler: "7d", "30d", "custom"
fromstringEvet
tostringEvet
kpisobjectEvet
kpis.sentintegerEvet
kpis.deliveredintegerEvet
kpis.failedintegerEvet
kpis.openedintegerEvet
kpis.clickedintegerEvet
kpis.delivery_ratenumber | nullEvet
kpis.open_ratenumber | nullEvet
kpis.click_ratenumber | nullEvet
kpis.active_subscriptionsintegerEvet
kpis.new_subscriptionsintegerEvet
kpis.opt_outsintegerEvet
seriesarray<object>Evet
series[].datestringEvet
series[].sentintegerEvet
series[].deliveredintegerEvet
series[].failedintegerEvet
series[].openedintegerEvet
recent_messagesarray<object>Evet
recent_messages[].idstringEvet
recent_messages[].app_idstringEvet
recent_messages[].sourceenumEvetDeğerler: "campaign", "api", "journey", "test"
recent_messages[].statusenumEvetDeğerler: "queued", "processing", "completed", "cancelled", "failed"
recent_messages[].idempotency_keystring | nullEvet
recent_messages[].namestring | nullEvet
recent_messages[].contentmap<string, any>Evet
recent_messages[].targetmap<string, any>Evet
recent_messages[].optionsmap<string, any>Evet
recent_messages[].labelsarray<string>Evet
recent_messages[].categorystring | nullEvet
recent_messages[].template_idstring | nullEvet
recent_messages[].campaign_idstring | nullEvet
recent_messages[].variantsarray<object> | nullEvet
recent_messages[].countsobjectEvet
recent_messages[].counts.targetedintegerHayır
recent_messages[].counts.suppressedintegerHayır
recent_messages[].counts.sentintegerHayır
recent_messages[].counts.deliveredintegerHayır
recent_messages[].counts.failedintegerHayır
recent_messages[].counts.erroredintegerHayır
recent_messages[].counts.expiredintegerHayır
recent_messages[].counts.openedintegerHayır
recent_messages[].counts.clickedintegerHayır
recent_messages[].counts.convertedintegerHayır
recent_messages[].counts.bouncedintegerHayır
recent_messages[].counts.complainedintegerHayır
recent_messages[].counts.unsubscribedintegerHayır
recent_messages[].counts.sms_segmentsintegerHayır
recent_messages[].requested_byobjectEvet
recent_messages[].requested_by.typeenumEvetDeğerler: "api_key", "account", "system"
recent_messages[].requested_by.idstringHayır
recent_messages[].errorstring | nullEvet
recent_messages[].scheduled_forstring | nullEvet
recent_messages[].started_atstring | nullEvet
recent_messages[].completed_atstring | nullEvet
recent_messages[].created_atstringEvet
recent_messages[].updated_atstringEvet
recent_campaignsarray<object>Evet
recent_campaigns[].idstringEvet
recent_campaigns[].namestringEvet
recent_campaigns[].typestringEvet
recent_campaigns[].statusstringEvet
recent_campaigns[].sentintegerEvet
recent_campaigns[].openedintegerEvet
recent_campaigns[].clickedintegerEvet
recent_campaigns[].updated_atstringEvet
top_errorsarray<object>Evet
top_errors[].codestringEvet
top_errors[].countintegerEvet
channelsarray<object>Evet
channels[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
channels[].providerenum | nullEvet
channels[].statusenumEvetDeğerler: "unconfigured", "active", "invalid", "suspended"
channels[].last_errorstring | nullEvet
channels[].active_subscriptionsintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/overview

PatchEventDefinitionDto

AlanTürZorunluAçıklama
display_namestring | nullHayır
is_conversionbooleanHayır
outcome_uniquebooleanHayır
outcome_unattributedbooleanHayır
retention_daysinteger | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/events/definitions/{name}

PatchSubscriptionDto

AlanTürZorunluAçıklama
tokenstringHayırUzunluk: 1–4096
deviceobjectHayır
device.modelstringHayırUzunluk: 0–100
device.osstringHayırUzunluk: 0–50
device.os_versionstringHayırUzunluk: 0–50
device.app_versionstring | nullHayır
device.sdk_versionstringHayırUzunluk: 0–50
device.sdk_platformstringHayırUzunluk: 0–50
device.carrierstringHayırUzunluk: 0–100
device.localestringHayırUzunluk: 0–20
device.timezonestringHayırUzunluk: 0–64
device.push_capablebooleanHayır
device.push_environmentenumHayırDeğerler: "sandbox", "production"
statusenumHayırDeğerler: "subscribed", "unsubscribed"
test_devicebooleanHayır
test_device_namestringHayırUzunluk: 0–100

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}

PatchUserDto

AlanTürZorunluAçıklama
propertiesmap<string, any>Hayır
tagsmap<string, string | null>Hayır
deltasobjectHayır
deltas.session_countintegerHayırAralık: -1000000–1000000
deltas.session_timeintegerHayırAralık: 0–31536000
deltas.purchasesarray<object>HayırÖğe: 0–100
deltas.purchases[].skustringEvetUzunluk: 1–100
deltas.purchases[].amountnumberEvetAralık: 0–∞
deltas.purchases[].isostringHayırUzunluk: 3–3
deltas.purchases[].countintegerHayırVarsayılan: 1; Aralık: 1–1000

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/users/by/{label}/{value}

PlanList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].codestringEvet
data[].namestringEvet
data[].monthly_priceintegerEvet
data[].currencystringEvet
data[].positionintegerEvet
data[].is_publicbooleanEvet
data[].limitsobjectEvet
data[].limits.subscriptionsinteger | nullEvet
data[].limits.messages_per_monthinteger | nullEvet
data[].limits.api_rpsinteger | nullEvet
data[].limits.membersinteger | nullEvet
data[].limits.appsinteger | nullEvet
data[].limits.retention_daysinteger | nullEvet
data[].limits.journeysinteger | nullEvet
data[].limits.segmentsinteger | nullEvet
data[].limits.ab_variantsinteger | nullEvet
data[].limits.tags_per_userinteger | nullEvet
data[].limits.aliases_per_userinteger | nullEvet
data[].limits.subscriptions_per_userinteger | nullEvet
data[].limits.report_history_daysinteger | nullEvet
data[].limits.webhooksinteger | nullEvet
data[].limits.api_keysinteger | nullEvet
data[].featuresobjectEvet
data[].features.journeysbooleanEvet
data[].features.ab_testingbooleanEvet
data[].features.emailbooleanEvet
data[].features.smsbooleanEvet
data[].features.in_appbooleanEvet
data[].features.approval_flowbooleanEvet
data[].features.ssobooleanEvet
data[].features.scimbooleanHayır
data[].features.audit_exportbooleanEvet
data[].features.rolesarray<string>Evet
data[].purchasablebooleanEvet

PortalResult

AlanTürZorunluAçıklama
urlstringEvet

ProvidersReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
totalsobjectEvet
totals.sentintegerEvet
totals.failedintegerEvet
totals.failure_ratenumber | nullEvet
previousobject | nullEvet
rowsarray<object>Evet
rows[].channelstringEvet
rows[].providerstring | nullEvet
rows[].sentintegerEvet
rows[].failedintegerEvet
rows[].failure_ratenumber | nullEvet
rows[].latency_p50_msnumber | nullEvet
rows[].latency_p95_msnumber | nullEvet
rows[].errorsarray<object>Evet
rows[].errors[].codestringEvet
rows[].errors[].countintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/providers

RecentEvents

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].user_idstring | nullEvet
data[].subscription_idstring | nullEvet
data[].namestringEvet
data[].propertiesmap<string, any>Evet
data[].valuenumber | nullEvet
data[].sourceenumEvetDeğerler: "sdk", "api", "system", "import"
data[].occurred_atstringEvet

RecoveryCodes

AlanTürZorunluAçıklama
recovery_codesarray<string>Evet

RenderPreview

AlanTürZorunluAçıklama
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
languagestringEvet
titlestring | nullEvet
subtitlestring | nullEvet
bodystring | nullEvet
urlstring | nullEvet
image_urlstring | nullEvet
icon_urlstring | nullEvet
buttonsarray<object>Evet
buttons[].idstringEvet
buttons[].textstringEvet
buttons[].urlstring | nullEvet
datamap<string, string>Evet
warningsarray<string>Evet
emailobject | nullHayır
smsobject | nullHayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/render

RenderTemplateDto

AlanTürZorunluAçıklama
channelenumHayırDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"; Varsayılan: "ios_push"
languagestringHayırUzunluk: 2–10
userobjectHayır
user.external_idstringHayırUzunluk: 0–255
user.tagsmap<string, string>Hayır
user.propertiesmap<string, any>Hayır
custom_datamap<string, any>Hayır
contentobjectHayır
content.headingsmap<string, string>Hayır
content.contentsmap<string, string>Hayır
content.subtitlemap<string, string>Hayır
content.urlstring (url)HayırUzunluk: 0–2000
content.app_urlstring (url)HayırUzunluk: 0–2000
content.datamap<string, string>Hayır
content.buttonsarray<object>HayırÖğe: 0–3
content.buttons[].idstringEvetUzunluk: 1–64
content.buttons[].textstringEvetUzunluk: 1–100
content.buttons[].iconstring (url)HayırUzunluk: 0–2000
content.buttons[].urlstring (url)HayırUzunluk: 0–2000
content.big_picturestring (url)HayırUzunluk: 0–2000
content.ios_attachmentsmap<string, string (url)>Hayır
content.ios_soundstringHayırUzunluk: 0–100
content.ios_badge_typeenumHayırDeğerler: "None", "SetTo", "Increase"
content.ios_badge_countintegerHayırAralık: 0–99999
content.ios_interruption_levelenumHayırDeğerler: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringHayırUzunluk: 0–100
content.android_channel_idstringHayırUzunluk: 0–100
content.android_groupstringHayırUzunluk: 0–100
content.android_soundstringHayırUzunluk: 0–100
content.chrome_web_iconstring (url)HayırUzunluk: 0–2000
content.chrome_web_imagestring (url)HayırUzunluk: 0–2000
content.chrome_web_badgestring (url)HayırUzunluk: 0–2000
content.web_push_topicstringHayırUzunluk: 0–32
content.content_availablebooleanHayır
content.mutable_contentbooleanHayır
content.custom_datamap<string, any>Hayır
content.email_subjectstringHayırUzunluk: 0–998
content.email_bodystringHayırUzunluk: 0–500000
content.email_mjmlstringHayırUzunluk: 0–500000
content.email_preheaderstringHayırUzunluk: 0–500
content.email_from_namestringHayırUzunluk: 0–200
content.email_from_addressstring (email)HayırUzunluk: 0–320
content.email_reply_to_addressstring (email)HayırUzunluk: 0–320
content.disable_email_click_trackingbooleanHayır
content.sms_fromstringHayırUzunluk: 1–20
content.disable_sms_link_shorteningbooleanHayır
content.add_to_inboxbooleanHayır
content.inbox_ttlintegerHayırAralık: 60–31536000
content.thread_idstringHayırUzunluk: 0–100
content.ios_relevance_scorenumberHayırAralık: 0–1
content.target_content_identifierstringHayırUzunluk: 0–200
content.small_iconstringHayırUzunluk: 0–100
content.large_iconstring (url) | stringHayır
content.android_accent_colorstringHayır
content.android_visibility1 | 0 | -1Hayır
content.web_buttonsarray<object>HayırÖğe: 0–2
content.web_buttons[].idstringEvetUzunluk: 1–64
content.web_buttons[].textstringEvetUzunluk: 1–100
content.web_buttons[].iconstring (url)HayırUzunluk: 0–2000
content.web_buttons[].urlstring (url)HayırUzunluk: 0–2000
content.require_interactionbooleanHayır
content.sms_media_urlsarray<string (url)>HayırÖğe: 1–10
content.whatsapp_templateobjectHayır
content.whatsapp_template.namestringEvet
content.whatsapp_template.languagestringEvet
content.whatsapp_template.headerobjectHayır
content.whatsapp_template.body_paramsarray<string>HayırÖğe: 0–20
content.whatsapp_template.button_paramsarray<object>HayırÖğe: 0–10
content.whatsapp_mediaobjectHayır
content.whatsapp_media.typeenumEvetDeğerler: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)EvetUzunluk: 0–2000
content.whatsapp_media.filenamestringHayırUzunluk: 1–240
content.whatsapp_interactiveobjectHayır
content.whatsapp_interactive.typeenumEvetDeğerler: "button", "list"
content.whatsapp_interactive.headerstringHayırUzunluk: 1–60
content.whatsapp_interactive.footerstringHayırUzunluk: 1–60
content.whatsapp_interactive.buttonsarray<object>HayırÖğe: 1–3
content.whatsapp_interactive.listobjectHayır
content.rcs_cardobjectHayır
content.rcs_card.titlemap<string, string>Hayır
content.rcs_card.descriptionmap<string, string>Hayır
content.rcs_card.media_urlstring (url)HayırUzunluk: 0–2000
content.rcs_card.media_heightenumHayırDeğerler: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumHayırDeğerler: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>HayırÖğe: 0–11
content.rcs_content_sidstringHayır
content.rcs_content_variablesmap<string, string>Hayır
content.rcs_fallback_textmap<string, string>Hayır
versionintegerHayırAralık: 1–∞

Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/render

RequestLog

AlanTürZorunluAçıklama
idstringEvet
org_idstringEvet
app_idstring | nullEvet
api_key_idstring | nullEvet
methodstringEvet
pathstringEvet
routestring | nullEvet
statusintegerEvet
duration_msintegerEvet
request_idstring | nullEvet
ipstring | nullEvet
error_codestring | nullEvet
created_atstringEvet

RequestLogPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].org_idstringEvet
data[].app_idstring | nullEvet
data[].api_key_idstring | nullEvet
data[].methodstringEvet
data[].pathstringEvet
data[].routestring | nullEvet
data[].statusintegerEvet
data[].duration_msintegerEvet
data[].request_idstring | nullEvet
data[].ipstring | nullEvet
data[].error_codestring | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

ResellerChildOrg

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
slugstringEvet
plan_codestringEvet
statusenumEvetDeğerler: "active", "suspended", "deleted"
suspended_reasonstring | nullEvet
membersnumberEvet
accessenumEvetDeğerler: "owner", "member", "support", "none"
regionstring | nullEvet
created_atstringEvet

ResellerChildOrgList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].slugstringEvet
data[].plan_codestringEvet
data[].statusenumEvetDeğerler: "active", "suspended", "deleted"
data[].suspended_reasonstring | nullEvet
data[].membersnumberEvet
data[].accessenumEvetDeğerler: "owner", "member", "support", "none"
data[].regionstring | nullEvet
data[].created_atstringEvet

ResellerStatement

AlanTürZorunluAçıklama
monthstringEvet
currencystringEvet
itemsarray<object>Evet
items[].org_idstringEvet
items[].namestringEvet
items[].slugstringEvet
items[].plan_codestringEvet
items[].statusstringEvet
items[].amountnumberEvet
items[].messages_sentnumberEvet
items[].events_ingestednumberEvet
items[].api_requestsnumberEvet
items[].active_subscriptionsnumberEvet
items[].maunumberEvet
totalsobjectEvet
totals.amountnumberEvet
totals.messages_sentnumberEvet
totals.events_ingestednumberEvet
totals.child_orgsnumberEvet

RetentionReport

AlanTürZorunluAçıklama
weeksintegerEvet
cohortsarray<object>Evet
cohorts[].weekstringEvet
cohorts[].usersintegerEvet
cohorts[].retentionarray<number | null>Evet
averagearray<number | null>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/retention

ScheduleCampaignDto

AlanTürZorunluAçıklama
send_atstring (date-time)Hayır
recurrenceobjectHayır
recurrence.cronstringEvetUzunluk: 9–100
recurrence.untilstring (date-time) | nullHayır
recurrence.timezonestringHayırUzunluk: 1–64

Kullanıldığı işlemler: POST /v1/apps/{appId}/campaigns/{campaignId}/schedule

ScimTokenCreated

AlanTürZorunluAçıklama
tokenstringEvet
scim_base_urlstringEvet
dataobjectEvet
data.idstringEvet
data.namestringEvet
data.prefixstringEvet
data.last_used_atstring | nullEvet
data.revoked_atstring | nullEvet
data.created_atstringEvet

ScimTokenList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].prefixstringEvet
data[].last_used_atstring | nullEvet
data[].revoked_atstring | nullEvet
data[].created_atstringEvet

SdkConfig

AlanTürZorunluAçıklama
app_idstringEvet
namestringEvet
api_urlstringEvet
cell_idstring | nullEvet
identity_verification_requiredbooleanEvet
identity_verification_modeenumEvetDeğerler: "hmac", "jwt", "both"
platformsobjectEvet
platforms.iosbooleanEvet
platforms.androidbooleanEvet
platforms.webbooleanEvet
platforms.emailbooleanEvet
platforms.smsbooleanEvet
webobjectEvet
web.vapid_public_keystring | nullEvet
web.allowed_originsarray<string>Evet
web.service_worker_pathstring | nullEvet
web.service_worker_scopestring | nullEvet
web.promptobject | nullEvet
web.welcome_notificationobject | nullEvet
web.click_behaviorobject | nullEvet
web.custom_linkobject | nullEvet
web.prompt_backoff_daysarray<integer> | nullEvet
sessionobjectEvet
session.timeout_secondsintegerEvet
in_appobjectEvet
in_app.min_interval_secondsintegerEvet
android_channelsarray<object>Evet
android_channels[].idstringEvet
android_channels[].namestringEvet
android_channels[].descriptionstring | nullEvet
android_channels[].importanceenumEvetDeğerler: "low", "default", "high", "urgent"
android_channels[].soundstring | nullEvet
android_channels[].vibrationbooleanEvet
android_channels[].groupstring | nullEvet
categoriesarray<object>Evet
categories[].keystringEvet
categories[].namemap<string, string>Evet
categories[].descriptionmap<string, string>Evet
categories[].channelsarray<string> | nullEvet
categories[].default_opted_inbooleanEvet

Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/config

SdkErrorPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].subscription_idstring | nullEvet
data[].platformstringEvet
data[].sdk_versionstring | nullEvet
data[].levelstringEvet
data[].codestring | nullEvet
data[].messagestringEvet
data[].contextmap<string, any>Evet
data[].occurred_atstringEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

SdkErrorsAccepted

AlanTürZorunluAçıklama
acceptedintegerEvet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/errors

SdkErrorsDto

AlanTürZorunluAçıklama
errorsarray<object>EvetÖğe: 1–20
errors[].levelenumHayırDeğerler: "error", "warning"; Varsayılan: "error"
errors[].platformenumEvetDeğerler: "web", "android", "ios", "flutter", "react_native", "node"
errors[].sdk_versionstringHayırUzunluk: 0–50
errors[].codestringHayırUzunluk: 0–100
errors[].messagestringEvetUzunluk: 1–2000
errors[].subscription_idstringHayırUzunluk: 0–64
errors[].contextmap<string, any>Hayır
errors[].occurred_atstring (date-time)Hayır

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/errors

SdkEventsDto

AlanTürZorunluAçıklama
eventsarray<object>EvetÖğe: 1–100
events[].namestringEvetUzunluk: 1–100
events[].propertiesmap<string, any>HayırVarsayılan: {}
events[].valuenumberHayır
events[].occurred_atstring (date-time)Hayır
events[].event_idstringHayırUzunluk: 8–64
events[].subscription_idstringHayırUzunluk: 1–∞
events[].external_idstringHayırUzunluk: 1–255
events[].token_hashstringHayır
events[].identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/events

SdkIdentityDto

AlanTürZorunluAçıklama
identitymap<string, string>Evet
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity

SdkIdentityResult

AlanTürZorunluAçıklama
identitymap<string, string>Evet

Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity, DELETE /sdk/v1/apps/{appId}/users/{userId}/identity/{label}

SdkInAppEventDto

AlanTürZorunluAçıklama
subscription_idstringEvetUzunluk: 1–64
token_hashstringHayır
typeenumEvetDeğerler: "impression", "click", "dismiss"
button_idstringHayırUzunluk: 0–64
variant_idstringHayırUzunluk: 0–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/in-app/{messageId}/events

SdkInAppList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].priorityintegerEvet
data[].triggersarray<object>Evet
data[].trigger_groupsarray<array<object>>Evet
data[].variant_idstring | nullEvet
data[].displayobjectEvet
data[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstring | nullEvet
data[].display.text_colorstring | nullEvet
data[].display.dismissiblebooleanEvet
data[].display.auto_dismiss_secondsinteger | nullEvet
data[].display.content_typeenumEvetDeğerler: "blocks", "html"
data[].display.htmlstring | nullEvet
data[].display.html_heightinteger | nullEvet
data[].display.blocksarray<object>Evet
data[].remaining_impressionsintegerEvet
data[].min_interval_secondsintegerEvet
data[].stop_after_interactionbooleanEvet
data[].last_impression_atstring | nullEvet
data[].end_atstring | nullEvet
languagestringEvet

Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/in-app

SdkInboxActionDto

AlanTürZorunluAçıklama
subscription_idstringEvetUzunluk: 1–64
identity_hashstringHayırUzunluk: 0–128
token_hashstringHayır

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/users/{userId}/inbox/read-all, POST /sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/read

SdkLiveActivityTokenDeleteDto

AlanTürZorunluAçıklama
subscription_idstringEvetUzunluk: 1–64
activity_typestringEvetUzunluk: 1–100
kindenumEvetDeğerler: "push_to_start", "update"
activity_idstringHayırUzunluk: 1–100
token_hashstringHayırUzunluk: 64–64
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/live-activities/tokens/delete

SdkLiveActivityTokenDto

AlanTürZorunluAçıklama
subscription_idstringEvetUzunluk: 1–64
activity_typestringEvetUzunluk: 1–100
kindenumEvetDeğerler: "push_to_start", "update"
activity_idstringHayırUzunluk: 1–100
tokenstringEvet
token_hashstringHayırUzunluk: 64–64
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/live-activities/tokens

SdkLoginDto

AlanTürZorunluAçıklama
external_idstringEvetUzunluk: 1–255
identity_hashstringHayırUzunluk: 64–64
token_hashstringHayır

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login

SdkLogoutDto

AlanTürZorunluAçıklama
token_hashstringHayır
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout

SdkPreferences

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].categorystringEvet
data[].channelstring | nullEvet
data[].opted_inbooleanEvet
data[].explicitbooleanEvet
data[].sourcestring | nullEvet
data[].updated_atstring | nullEvet
categoriesarray<object>Evet
categories[].keystringEvet
categories[].namemap<string, string>Evet
categories[].descriptionmap<string, string>Evet
categories[].channelsarray<string> | nullEvet
categories[].default_opted_inbooleanEvet

Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/preferences, PUT /sdk/v1/apps/{appId}/preferences

SdkRegisterDto

AlanTürZorunluAçıklama
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
tokenstringEvetUzunluk: 1–4096
deviceobjectHayırVarsayılan: {}
device.modelstringHayırUzunluk: 0–100
device.osstringHayırUzunluk: 0–50
device.os_versionstringHayırUzunluk: 0–50
device.app_versionstring | nullHayır
device.sdk_versionstringHayırUzunluk: 0–50
device.sdk_platformstringHayırUzunluk: 0–50
device.carrierstringHayırUzunluk: 0–100
device.localestringHayırUzunluk: 0–20
device.timezonestringHayırUzunluk: 0–64
device.push_capablebooleanHayır
device.push_environmentenumHayırDeğerler: "sandbox", "production"
test_devicebooleanHayır
userobjectHayır
user.external_idstringHayırUzunluk: 1–255
user.identity_hashstringHayırUzunluk: 64–64
user.tagsmap<string, string>Hayır
user.propertiesmap<string, any>Hayır
user.subscription_idstringHayırUzunluk: 1–64
user.token_hashstringHayır
ownership_proofbooleanHayır

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions

SdkRegisterResult

AlanTürZorunluAçıklama
subscription_idstringEvet
user_idstringEvet
external_idstring | nullEvet
statusenumEvetDeğerler: "subscribed", "unsubscribed", "invalid", "pending"
createdbooleanEvet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions

SdkSecret

AlanTürZorunluAçıklama
sdk_secretstringEvet
identity_verification_requiredbooleanEvet

SdkSessionDto

AlanTürZorunluAçıklama
token_hashstringHayır
identity_hashstringHayırUzunluk: 64–64
subscription_idstringEvetUzunluk: 1–∞
duration_secondsintegerHayırAralık: 0–604800
app_versionstring | nullHayır
sdk_versionstringHayırUzunluk: 0–50

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/sessions

SdkSetPreferencesDto

AlanTürZorunluAçıklama
preferencesarray<object>EvetÖğe: 1–100
preferences[].categorystringEvetUzunluk: 1–64
preferences[].channelenum | nullHayır
preferences[].opted_inbooleanEvet
subscription_idstringEvetUzunluk: 1–64
token_hashstringHayır
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: PUT /sdk/v1/apps/{appId}/preferences

SdkSubscriptionPatchDto

AlanTürZorunluAçıklama
token_hashstringHayır
identity_hashstringHayırUzunluk: 64–64
tokenstringHayırUzunluk: 1–4096
deviceobjectHayır
device.modelstringHayırUzunluk: 0–100
device.osstringHayırUzunluk: 0–50
device.os_versionstringHayırUzunluk: 0–50
device.app_versionstring | nullHayır
device.sdk_versionstringHayırUzunluk: 0–50
device.sdk_platformstringHayırUzunluk: 0–50
device.carrierstringHayırUzunluk: 0–100
device.localestringHayırUzunluk: 0–20
device.timezonestringHayırUzunluk: 0–64
device.push_capablebooleanHayır
device.push_environmentenumHayırDeğerler: "sandbox", "production"
opted_inbooleanHayır
locationobject | nullHayır

Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}

SdkUserPatchDto

AlanTürZorunluAçıklama
tagsmap<string, string | null>Hayır
propertiesmap<string, any>Hayır
deltasobjectHayır
deltas.session_countintegerHayırAralık: -1000000–1000000
deltas.session_timeintegerHayırAralık: 0–31536000
deltas.purchasesarray<object>HayırÖğe: 0–100
deltas.purchases[].skustringEvetUzunluk: 1–100
deltas.purchases[].amountnumberEvetAralık: 0–∞
deltas.purchases[].isostringHayırUzunluk: 3–3
deltas.purchases[].countintegerHayırVarsayılan: 1; Aralık: 1–1000
identity_hashstringHayırUzunluk: 64–64

Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/users/{userId}

SdkUserResult

AlanTürZorunluAçıklama
user_idstringEvet
external_idstring | nullEvet
tagsmap<string, string>Evet

Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login, POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout, PATCH /sdk/v1/apps/{appId}/users/{userId}

Segment

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
descriptionstring | nullEvet
definitionmap<string, any>Evet
is_dynamicbooleanEvet
estimated_countinteger | nullEvet
estimated_atstring | nullEvet
created_bystring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/segments, GET /v1/apps/{appId}/segments/{segmentId}, PATCH /v1/apps/{appId}/segments/{segmentId}, POST /v1/apps/{appId}/mcp/segment-drafts

SegmentCampaigns

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].statusstringEvet
data[].typestringEvet
data[].usageenumEvetDeğerler: "include", "exclude"
data[].created_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/segments/{segmentId}/campaigns

SegmentEstimate

AlanTürZorunluAçıklama
segment_idstring | nullEvet
subscriptionsintegerEvet
usersintegerEvet
estimated_atstringEvet
cachedbooleanEvet
sampledbooleanEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/segments/{segmentId}/estimate

SegmentPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].definitionmap<string, any>Evet
data[].is_dynamicbooleanEvet
data[].estimated_countinteger | nullEvet
data[].estimated_atstring | nullEvet
data[].created_bystring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/segments

SegmentPreview

AlanTürZorunluAçıklama
subscriptionsintegerEvet
usersintegerEvet
sampledbooleanEvet
samplearray<object>Evet
sample[].idstringEvet
sample[].external_idstring | nullEvet
sample[].tagsmap<string, string>Evet
sample[].last_active_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/segments/preview

SelectWinnerDto

AlanTürZorunluAçıklama
variant_idstringEvetUzunluk: 1–∞

Kullanıldığı işlemler: POST /v1/apps/{appId}/campaigns/{campaignId}/winner

SessionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].ipstring | nullEvet
data[].user_agentstring | nullEvet
data[].created_atstringEvet
data[].last_seen_atstringEvet
data[].expires_atstringEvet
data[].currentbooleanEvet

SetOwnerDto

AlanTürZorunluAçıklama
external_idstringEvetUzunluk: 1–255

Kullanıldığı işlemler: POST /v1/apps/{appId}/subscriptions/{subscriptionId}/owner

SetPreferencesDto

AlanTürZorunluAçıklama
preferencesarray<object>EvetÖğe: 1–100
preferences[].categorystringEvetUzunluk: 1–64
preferences[].channelenum | nullHayır
preferences[].opted_inbooleanEvet

Kullanıldığı işlemler: PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences

SmsKeyword

AlanTürZorunluAçıklama
idstringEvet
keywordstringEvet
scopeenumEvetDeğerler: "org", "app"
app_idstring | nullEvet
channelsarray<enum>Evet
actionsmap<string, any>Evet
enabledbooleanEvet
descriptionstring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/sms-keywords, PATCH /v1/apps/{appId}/sms-keywords/{keywordId}

SmsKeywordList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].keywordstringEvet
data[].scopeenumEvetDeğerler: "org", "app"
data[].app_idstring | nullEvet
data[].channelsarray<enum>Evet
data[].actionsmap<string, any>Evet
data[].enabledbooleanEvet
data[].descriptionstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
reservedarray<string>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/sms-keywords

SsoConnection

AlanTürZorunluAçıklama
idstringEvet
typeenumEvetDeğerler: "saml", "oidc"
namestringEvet
statusenumEvetDeğerler: "draft", "active", "disabled"
configobjectEvet
config.idp_entity_idstringHayırUzunluk: 1–500
config.idp_sso_urlstring (uri)HayırUzunluk: 0–2000
config.idp_certificatesarray<string>HayırÖğe: 0–3
config.allow_idp_initiatedbooleanHayır
config.groups_attributestringHayırUzunluk: 0–200
config.email_attributestringHayırUzunluk: 0–200
config.name_attributestringHayırUzunluk: 0–200
config.issuerstring (uri)HayırUzunluk: 0–2000
config.client_idstringHayırUzunluk: 1–500
config.authorization_endpointstring (uri)HayırUzunluk: 0–2000
config.token_endpointstring (uri)HayırUzunluk: 0–2000
config.jwks_uristring (uri)HayırUzunluk: 0–2000
config.scopesarray<string>HayırÖğe: 0–20
config.groups_claimstringHayırUzunluk: 0–200
has_client_secretbooleanEvet
default_rolestringEvet
group_role_mapmap<string, string>Evet
jit_enabledbooleanEvet
last_login_atstring | nullEvet
spobjectEvet
sp.entity_idstringEvet
sp.acs_urlstringEvet
sp.metadata_urlstringEvet
sp.redirect_uristringEvet
created_atstringEvet
updated_atstringEvet

SsoConnectionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].typeenumEvetDeğerler: "saml", "oidc"
data[].namestringEvet
data[].statusenumEvetDeğerler: "draft", "active", "disabled"
data[].configobjectEvet
data[].config.idp_entity_idstringHayırUzunluk: 1–500
data[].config.idp_sso_urlstring (uri)HayırUzunluk: 0–2000
data[].config.idp_certificatesarray<string>HayırÖğe: 0–3
data[].config.allow_idp_initiatedbooleanHayır
data[].config.groups_attributestringHayırUzunluk: 0–200
data[].config.email_attributestringHayırUzunluk: 0–200
data[].config.name_attributestringHayırUzunluk: 0–200
data[].config.issuerstring (uri)HayırUzunluk: 0–2000
data[].config.client_idstringHayırUzunluk: 1–500
data[].config.authorization_endpointstring (uri)HayırUzunluk: 0–2000
data[].config.token_endpointstring (uri)HayırUzunluk: 0–2000
data[].config.jwks_uristring (uri)HayırUzunluk: 0–2000
data[].config.scopesarray<string>HayırÖğe: 0–20
data[].config.groups_claimstringHayırUzunluk: 0–200
data[].has_client_secretbooleanEvet
data[].default_rolestringEvet
data[].group_role_mapmap<string, string>Evet
data[].jit_enabledbooleanEvet
data[].last_login_atstring | nullEvet
data[].spobjectEvet
data[].sp.entity_idstringEvet
data[].sp.acs_urlstringEvet
data[].sp.metadata_urlstringEvet
data[].sp.redirect_uristringEvet
data[].created_atstringEvet
data[].updated_atstringEvet

SsoDiscoverResult

AlanTürZorunluAçıklama
ssobooleanEvet
typeenum | nullEvet
start_urlstring | nullEvet

SsoDomain

AlanTürZorunluAçıklama
idstringEvet
domainstringEvet
verifiedbooleanEvet
verified_atstring | nullEvet
last_checked_atstring | nullEvet
txt_recordobjectEvet
txt_record.namestringEvet
txt_record.valuestringEvet
created_atstringEvet

SsoDomainList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].domainstringEvet
data[].verifiedbooleanEvet
data[].verified_atstring | nullEvet
data[].last_checked_atstring | nullEvet
data[].txt_recordobjectEvet
data[].txt_record.namestringEvet
data[].txt_record.valuestringEvet
data[].created_atstringEvet

SsoSettings

AlanTürZorunluAçıklama
enforcedbooleanEvet
availablebooleanEvet
scim_availablebooleanEvet
recovery_codesarray<string>Hayır
recovery_codes_remaininginteger | nullEvet

SsoTestResult

AlanTürZorunluAçıklama
connection_idstringEvet
okbooleanEvet
errorstring | nullEvet
emailstring | nullEvet
namestring | nullEvet
groupsarray<string>Evet
mapped_rolestring | nullEvet
domain_verifiedbooleanEvet
account_existsbooleanEvet
memberbooleanEvet
claimsmap<string, any>Evet
tested_atstringEvet

SsoTestStart

AlanTürZorunluAçıklama
urlstringEvet

StartLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringHayırUzunluk: 1–100
attributesmap<string, string | number | boolean>Hayır
targetobjectEvet
target.include_external_idsarray<string>HayırÖğe: 0–2000
target.include_subscription_idsarray<string>HayırÖğe: 0–2000
target.included_segmentsarray<string>HayırÖğe: 0–20
target.allbooleanHayır
content_statemap<string, string | number | boolean>Evet
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/start

StatusTokenResult

AlanTürZorunluAçıklama
okbooleanEvet

Subscription

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
user_idstring | nullEvet
channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
tokenstringEvet
statusenumEvetDeğerler: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullEvet
deviceobjectEvet
device.modelstringHayırUzunluk: 0–100
device.osstringHayırUzunluk: 0–50
device.os_versionstringHayırUzunluk: 0–50
device.app_versionstring | nullHayır
device.sdk_versionstringHayırUzunluk: 0–50
device.sdk_platformstringHayırUzunluk: 0–50
device.carrierstringHayırUzunluk: 0–100
device.localestringHayırUzunluk: 0–20
device.timezonestringHayırUzunluk: 0–64
device.push_capablebooleanHayır
device.push_environmentenumHayırDeğerler: "sandbox", "production"
test_devicebooleanEvet
test_device_namestring | nullEvet
last_active_atstringEvet
last_sent_atstring | nullEvet
last_delivered_atstring | nullEvet
opted_in_atstring | nullEvet
opt_in_sourcestring | nullEvet
unsubscribed_atstring | nullEvet
locationobject | nullEvet
created_atstringEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].user_idstring | nullEvet
data[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
data[].tokenstringEvet
data[].statusenumEvetDeğerler: "subscribed", "unsubscribed", "invalid", "pending"
data[].unsubscribe_reasonenum | nullEvet
data[].deviceobjectEvet
data[].device.modelstringHayırUzunluk: 0–100
data[].device.osstringHayırUzunluk: 0–50
data[].device.os_versionstringHayırUzunluk: 0–50
data[].device.app_versionstring | nullHayır
data[].device.sdk_versionstringHayırUzunluk: 0–50
data[].device.sdk_platformstringHayırUzunluk: 0–50
data[].device.carrierstringHayırUzunluk: 0–100
data[].device.localestringHayırUzunluk: 0–20
data[].device.timezonestringHayırUzunluk: 0–64
data[].device.push_capablebooleanHayır
data[].device.push_environmentenumHayırDeğerler: "sandbox", "production"
data[].test_devicebooleanEvet
data[].test_device_namestring | nullEvet
data[].last_active_atstringEvet
data[].last_sent_atstring | nullEvet
data[].last_delivered_atstring | nullEvet
data[].opted_in_atstring | nullEvet
data[].opt_in_sourcestring | nullEvet
data[].unsubscribed_atstring | nullEvet
data[].locationobject | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

SubscriptionsReport

AlanTürZorunluAçıklama
fromstringEvet
tostringEvet
totalsobjectEvet
totals.activeintegerEvet
totals.newintegerEvet
totals.unsubscribedintegerEvet
totals.opt_outsintegerEvet
totals.netintegerEvet
previousobject | nullEvet
rowsarray<object>Evet
rows[].datestringEvet
rows[].newintegerEvet
rows[].unsubscribedintegerEvet
rows[].opt_outsintegerEvet
rows[].netintegerEvet
by_channelarray<object>Evet
by_channel[].channelstringEvet
by_channel[].activeintegerEvet
by_channel[].newintegerEvet
by_channel[].unsubscribedintegerEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/subscriptions

Suppression

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
channelenumEvetDeğerler: "email", "sms", "whatsapp", "rcs"
value_maskedstringEvet
reasonenumEvetDeğerler: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
sourcestringEvet
detailmap<string, any>Evet
expires_atstring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/suppressions

SuppressionPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].channelenumEvetDeğerler: "email", "sms", "whatsapp", "rcs"
data[].value_maskedstringEvet
data[].reasonenumEvetDeğerler: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
data[].sourcestringEvet
data[].detailmap<string, any>Evet
data[].expires_atstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/suppressions

Template

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
channelenum | nullEvet
current_versionintegerEvet
tagsarray<string>Evet
contentmap<string, any>Evet
created_bystring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: 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

TemplatePage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].channelenum | nullEvet
data[].current_versionintegerEvet
data[].tagsarray<string>Evet
data[].contentmap<string, any>Evet
data[].created_bystring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/templates

TemplateStats

AlanTürZorunluAçıklama
template_idstringEvet
messagesintegerEvet
campaignsintegerEvet
targetedintegerEvet
sentintegerEvet
deliveredintegerEvet
openedintegerEvet
clickedintegerEvet
convertedintegerEvet
open_ratenumberEvet
click_ratenumberEvet
conversion_ratenumberEvet
last_used_atstring | nullEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/templates/{templateId}/stats

TemplateVersionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].versionintegerEvet
data[].contentmap<string, any>Evet
data[].created_bystring | nullEvet
data[].created_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/templates/{templateId}/versions

TestDataFeedDto

AlanTürZorunluAçıklama
external_idstringHayırUzunluk: 1–256
user_idstringHayırUzunluk: 1–64

Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds/{feedId}/test

TraceResult

AlanTürZorunluAçıklama
querystringEvet
kindstringEvet
itemsarray<object>Evet
items[].deliveryobjectEvet
items[].delivery.idstringEvet
items[].delivery.message_idstringEvet
items[].delivery.subscription_idstringEvet
items[].delivery.user_idstring | nullEvet
items[].delivery.channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
items[].delivery.providerstring | nullEvet
items[].delivery.statusenumEvetDeğerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
items[].delivery.attempt_countintegerEvet
items[].delivery.provider_message_idstring | nullEvet
items[].delivery.error_codestring | nullEvet
items[].delivery.error_messagestring | nullEvet
items[].delivery.suppression_reasonstring | nullEvet
items[].delivery.send_afterstring | nullEvet
items[].delivery.sent_atstring | nullEvet
items[].delivery.delivered_atstring | nullEvet
items[].delivery.opened_atstring | nullEvet
items[].delivery.clicked_atstring | nullEvet
items[].delivery.failed_atstring | nullEvet
items[].delivery.created_atstringEvet
items[].eventsarray<object>Evet
items[].events[].idstringEvet
items[].events[].typestringEvet
items[].events[].detailmap<string, any>Evet
items[].events[].occurred_atstringEvet
items[].subscriptionobject | nullEvet
items[].userobject | nullEvet
items[].renderobject | nullEvet
items[].webhooksarray<object>Evet
items[].webhooks[].idstringEvet
items[].webhooks[].endpoint_idstringEvet
items[].webhooks[].event_typestringEvet
items[].webhooks[].statusstringEvet
items[].webhooks[].attemptintegerEvet
items[].webhooks[].response_statusinteger | nullEvet
items[].webhooks[].created_atstringEvet
items[].messageobject | nullEvet

TriggerRunDto

AlanTürZorunluAçıklama
external_idstringHayırUzunluk: 1–255
user_idstringHayırUzunluk: 1–64
aliasobjectHayır
alias.labelstringEvetUzunluk: 1–50
alias.valuestringEvetUzunluk: 1–255
contextmap<string, any>Hayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/runs

UpdateApiKeyDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 2–100
scopesarray<enum>HayırÖğe: 1–8
ip_allowlistarray<string>HayırÖğe: 0–50
expires_atstring (date-time) | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/api-keys/{keyId}

UpdateAppDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 2–100
platform_flagsobjectHayır
platform_flags.iosbooleanHayır
platform_flags.androidbooleanHayır
platform_flags.webbooleanHayır
platform_flags.emailbooleanHayır
platform_flags.smsbooleanHayır
icon_urlstring (uri) | nullHayır
default_languagestringHayırUzunluk: 2–10
timezonestringHayırUzunluk: 1–64
settingsobjectHayır
settings.quietHoursobject | nullHayır
settings.frequencyCapobject | nullHayır
settings.frequencyCapsarray<object>HayırÖğe: 0–10
settings.frequencyCaps[].maxintegerEvetAralık: 1–1000
settings.frequencyCaps[].windowobjectEvet
settings.frequencyCaps[].channelsarray<enum>HayırÖğe: 1–8
settings.inAppobjectHayır
settings.inApp.minIntervalSecondsintegerHayırAralık: 0–604800
settings.androidChannelsarray<object>HayırÖğe: 0–50
settings.androidChannels[].idstringEvetUzunluk: 1–64
settings.androidChannels[].namestringEvetUzunluk: 1–60
settings.androidChannels[].descriptionstringHayırUzunluk: 0–200
settings.androidChannels[].importanceenumEvetDeğerler: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringHayırUzunluk: 0–64
settings.androidChannels[].vibrationbooleanHayır
settings.androidChannels[].groupstringHayırUzunluk: 0–64
settings.smsobjectHayır
settings.sms.helpReplystringHayırUzunluk: 0–320
settings.sms.stopReplystringHayırUzunluk: 0–320
settings.sms.autoReplybooleanHayır
settings.preferenceCenterobjectHayır
settings.preferenceCenter.enabledbooleanHayır
settings.preferenceCenter.brandNamestringHayırUzunluk: 0–80
settings.preferenceCenter.logoUrlstring (url)HayırUzunluk: 0–2000
settings.preferenceCenter.accentColorstringHayır
settings.preferenceCenter.customUnsubscribeUrlstring (url)HayırUzunluk: 0–2000
settings.preferenceCenter.textsmap<string, object>Hayır
settings.defaultTtlSecondsintegerHayırAralık: 60–2419200
settings.identityVerificationRequiredbooleanHayır
settings.allowedOriginsarray<string>HayırÖğe: 0–50
settings.campaignApprovalRequiredbooleanHayır
settings.webPushobjectHayır
settings.webPush.serviceWorkerPathstringHayırUzunluk: 0–200
settings.webPush.serviceWorkerScopestringHayırUzunluk: 0–200
settings.webPush.promptobjectHayır
settings.webPush.welcomeNotificationobjectHayır
settings.webPush.clickBehaviorobjectHayır
settings.webPush.customLinkobjectHayır
settings.webPush.promptBackoffDaysarray<integer>HayırÖğe: 0–10
settings.onboardingobjectHayır
settings.onboarding.stepintegerEvetAralık: 0–6
settings.onboarding.simulationbooleanHayır
settings.onboarding.completed_atstring | nullHayır
settings.onboarding.versionintegerHayırAralık: 1–100
settings.onboarding.platformsarray<enum>HayırÖğe: 0–4
settings.onboarding.frameworkenumHayırDeğerler: "native", "flutter", "react-native", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumHayırDeğerler: "code", "wordpress"
settings.sdkSetupobject | nullHayır
identity_verification_modeenumHayırDeğerler: "hmac", "jwt", "both"

Kullanıldığı işlemler: PATCH /v1/apps/{appId}

UpdateCategoryDto

AlanTürZorunluAçıklama
namemap<string, string>Hayır
descriptionmap<string, string>Hayır
channelsarray<enum> | nullHayır
default_opted_inbooleanHayır
positionintegerHayırAralık: 0–1000

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/categories/{categoryId}

UpdateContentTableDto

AlanTürZorunluAçıklama
descriptionstring | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/content-tables/{tableId}

UpdateDataFeedDto

AlanTürZorunluAçıklama
descriptionstring | nullHayır
url_templatestringHayırUzunluk: 1–2048
methodenumHayırDeğerler: "GET", "POST"
body_templatestring | nullHayır
headersmap<string, string>Hayır
secret_headersmap<string, string> | nullHayır
cache_ttl_secondsintegerHayırAralık: 0–86400
timeout_msintegerHayırAralık: 100–2000
enabledbooleanHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/data-feeds/{feedId}

UpdateInAppDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 2–100
triggersarray<object>HayırÖğe: 1–5
trigger_groupsarray<array<object>>HayırÖğe: 1–10
variantsarray<object>HayırÖğe: 0–10
variants[].idstringEvetUzunluk: 1–64
variants[].namestringEvetUzunluk: 1–60
variants[].weight_percentintegerEvetAralık: 1–99
variants[].displayobjectEvet
variants[].display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringHayır
variants[].display.text_colorstringHayır
variants[].display.dismissiblebooleanHayır
variants[].display.auto_dismiss_secondsintegerHayırAralık: 1–120
variants[].display.content_typeenumHayırDeğerler: "blocks", "html"
variants[].display.htmlmap<string, string>Hayır
variants[].display.html_heightintegerHayırAralık: 40–2000
variants[].display.blocksarray<object>EvetÖğe: 0–12
ab_testobjectHayır
ab_test.winnerobjectHayır
ab_test.winner.modeenumEvetDeğerler: "manual", "auto"
ab_test.winner.min_impressionsintegerHayırAralık: 10–1000000
ab_test.winner.confidencenumberHayırAralık: 0.8–0.99
displayobjectHayır
display.layoutenumEvetDeğerler: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringHayır
display.text_colorstringHayır
display.dismissiblebooleanHayır
display.auto_dismiss_secondsintegerHayırAralık: 1–120
display.content_typeenumHayırDeğerler: "blocks", "html"
display.htmlmap<string, string>Hayır
display.html_heightintegerHayırAralık: 40–2000
display.blocksarray<object>EvetÖğe: 0–12
audienceobjectHayır
audience.included_segmentsarray<string>HayırÖğe: 0–20
audience.excluded_segmentsarray<string>HayırÖğe: 0–20
frequencyobjectHayır
frequency.max_impressionsintegerHayırAralık: 1–1000
frequency.min_interval_secondsintegerHayırAralık: 0–31536000
frequency.stop_after_interactionbooleanHayır
journey_onlybooleanHayır
priorityintegerHayırAralık: 0–100
start_atstring (date-time) | nullHayır
end_atstring (date-time) | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/in-app-messages/{messageId}

UpdateJourneyDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 2–120
descriptionstring | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/journeys/{journeyId}

UpdateKeywordDto

AlanTürZorunluAçıklama
keywordstringHayırUzunluk: 1–30
channelsarray<enum>HayırÖğe: 1–3
actionsobjectHayır
actions.add_tagsmap<string, string>Hayır
actions.remove_tagsarray<string>HayırÖğe: 0–50
actions.eventobjectHayır
actions.event.namestringEvet
actions.event.propertiesmap<string, string>Hayır
actions.replyobjectHayır
actions.reply.textstringEvetUzunluk: 1–1600
actions.opt_inbooleanHayır
enabledbooleanHayır
descriptionstring | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/sms-keywords/{keywordId}

UpdateLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringEvetUzunluk: 1–100
content_statemap<string, string | number | boolean>Evet
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/update

UpdateLiveActivityTypeDto

AlanTürZorunluAçıklama
descriptionstring | nullHayır
content_state_schemaobjectHayır
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectHayır
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/live-activities/types/{activityType}

UpdateNodeDto

AlanTürZorunluAçıklama
datamap<string, any>Hayır
positionobjectHayır
position.xnumberEvet
position.ynumberEvet

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}

UpdateTemplateDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 2–100
channelenum | nullHayır
tagsarray<string>HayırÖğe: 0–20
contentobjectHayır
content.headingsmap<string, string>Hayır
content.contentsmap<string, string>Hayır
content.subtitlemap<string, string>Hayır
content.urlstring (url)HayırUzunluk: 0–2000
content.app_urlstring (url)HayırUzunluk: 0–2000
content.datamap<string, string>Hayır
content.buttonsarray<object>HayırÖğe: 0–3
content.buttons[].idstringEvetUzunluk: 1–64
content.buttons[].textstringEvetUzunluk: 1–100
content.buttons[].iconstring (url)HayırUzunluk: 0–2000
content.buttons[].urlstring (url)HayırUzunluk: 0–2000
content.big_picturestring (url)HayırUzunluk: 0–2000
content.ios_attachmentsmap<string, string (url)>Hayır
content.ios_soundstringHayırUzunluk: 0–100
content.ios_badge_typeenumHayırDeğerler: "None", "SetTo", "Increase"
content.ios_badge_countintegerHayırAralık: 0–99999
content.ios_interruption_levelenumHayırDeğerler: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringHayırUzunluk: 0–100
content.android_channel_idstringHayırUzunluk: 0–100
content.android_groupstringHayırUzunluk: 0–100
content.android_soundstringHayırUzunluk: 0–100
content.chrome_web_iconstring (url)HayırUzunluk: 0–2000
content.chrome_web_imagestring (url)HayırUzunluk: 0–2000
content.chrome_web_badgestring (url)HayırUzunluk: 0–2000
content.web_push_topicstringHayırUzunluk: 0–32
content.content_availablebooleanHayır
content.mutable_contentbooleanHayır
content.custom_datamap<string, any>Hayır
content.email_subjectstringHayırUzunluk: 0–998
content.email_bodystringHayırUzunluk: 0–500000
content.email_mjmlstringHayırUzunluk: 0–500000
content.email_preheaderstringHayırUzunluk: 0–500
content.email_from_namestringHayırUzunluk: 0–200
content.email_from_addressstring (email)HayırUzunluk: 0–320
content.email_reply_to_addressstring (email)HayırUzunluk: 0–320
content.disable_email_click_trackingbooleanHayır
content.sms_fromstringHayırUzunluk: 1–20
content.disable_sms_link_shorteningbooleanHayır
content.add_to_inboxbooleanHayır
content.inbox_ttlintegerHayırAralık: 60–31536000
content.thread_idstringHayırUzunluk: 0–100
content.ios_relevance_scorenumberHayırAralık: 0–1
content.target_content_identifierstringHayırUzunluk: 0–200
content.small_iconstringHayırUzunluk: 0–100
content.large_iconstring (url) | stringHayır
content.android_accent_colorstringHayır
content.android_visibility1 | 0 | -1Hayır
content.web_buttonsarray<object>HayırÖğe: 0–2
content.web_buttons[].idstringEvetUzunluk: 1–64
content.web_buttons[].textstringEvetUzunluk: 1–100
content.web_buttons[].iconstring (url)HayırUzunluk: 0–2000
content.web_buttons[].urlstring (url)HayırUzunluk: 0–2000
content.require_interactionbooleanHayır
content.sms_media_urlsarray<string (url)>HayırÖğe: 1–10
content.whatsapp_templateobjectHayır
content.whatsapp_template.namestringEvet
content.whatsapp_template.languagestringEvet
content.whatsapp_template.headerobjectHayır
content.whatsapp_template.body_paramsarray<string>HayırÖğe: 0–20
content.whatsapp_template.button_paramsarray<object>HayırÖğe: 0–10
content.whatsapp_mediaobjectHayır
content.whatsapp_media.typeenumEvetDeğerler: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)EvetUzunluk: 0–2000
content.whatsapp_media.filenamestringHayırUzunluk: 1–240
content.whatsapp_interactiveobjectHayır
content.whatsapp_interactive.typeenumEvetDeğerler: "button", "list"
content.whatsapp_interactive.headerstringHayırUzunluk: 1–60
content.whatsapp_interactive.footerstringHayırUzunluk: 1–60
content.whatsapp_interactive.buttonsarray<object>HayırÖğe: 1–3
content.whatsapp_interactive.listobjectHayır
content.rcs_cardobjectHayır
content.rcs_card.titlemap<string, string>Hayır
content.rcs_card.descriptionmap<string, string>Hayır
content.rcs_card.media_urlstring (url)HayırUzunluk: 0–2000
content.rcs_card.media_heightenumHayırDeğerler: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumHayırDeğerler: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>HayırÖğe: 0–11
content.rcs_content_sidstringHayır
content.rcs_content_variablesmap<string, string>Hayır
content.rcs_fallback_textmap<string, string>Hayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/templates/{templateId}

UpdateWarehouseExportDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 1–100
tablesarray<enum>HayırÖğe: 1–6
scheduleenumHayırDeğerler: "hourly", "daily"
enabledbooleanHayır
configmap<string, any>Hayır
credentialsmap<string, any>Hayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/warehouse-exports/{exportId}

UpdateWarmupPlanDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 1–100
statusenumHayırDeğerler: "active", "paused"
daily_limitsarray<integer>HayırÖğe: 1–120
provider_sharesobject | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}

UpdateWebhookDto

AlanTürZorunluAçıklama
urlstringHayırUzunluk: 1–2048
descriptionstring | nullHayır
eventsarray<enum>HayırÖğe: 1–31
event_filtersobjectHayır
event_filters.event_namesarray<string>HayırÖğe: 0–50
batchbooleanHayır
headersmap<string, string> | nullHayır
statusenumHayırDeğerler: "active", "disabled"
body_templatestring | nullHayır
body_content_typeenumHayırŞablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain"
filtersobject | nullHayır

Kullanıldığı işlemler: PATCH /v1/apps/{appId}/webhooks/{webhookId}

UpsertUserDto

AlanTürZorunluAçıklama
identityobjectHayır
identity.external_idstringEvetUzunluk: 1–255
external_idstringHayırUzunluk: 1–255
propertiesmap<string, any>Hayır
tagsmap<string, string>Hayır
subscriptionsarray<object>HayırÖğe: 0–20
subscriptions[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
subscriptions[].tokenstringEvetUzunluk: 1–4096
subscriptions[].deviceobjectHayırVarsayılan: {}
subscriptions[].device.modelstringHayırUzunluk: 0–100
subscriptions[].device.osstringHayırUzunluk: 0–50
subscriptions[].device.os_versionstringHayırUzunluk: 0–50
subscriptions[].device.app_versionstring | nullHayır
subscriptions[].device.sdk_versionstringHayırUzunluk: 0–50
subscriptions[].device.sdk_platformstringHayırUzunluk: 0–50
subscriptions[].device.carrierstringHayırUzunluk: 0–100
subscriptions[].device.localestringHayırUzunluk: 0–20
subscriptions[].device.timezonestringHayırUzunluk: 0–64
subscriptions[].device.push_capablebooleanHayır
subscriptions[].device.push_environmentenumHayırDeğerler: "sandbox", "production"
subscriptions[].statusenumHayırDeğerler: "subscribed", "unsubscribed"
subscriptions[].opt_inobjectHayır
subscriptions[].opt_in.sourcestringEvetUzunluk: 1–100
subscriptions[].opt_in.atstring (date-time)Hayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/users

UsageReport

AlanTürZorunluAçıklama
org_idstringEvet
plan_codestringEvet
periodobjectEvet
period.startstringEvet
period.endstringEvet
metricsarray<object>Evet
metrics[].metricstringEvet
metrics[].usednumberEvet
metrics[].limitnumber | nullEvet
metrics[].percentnumber | nullEvet
metrics[].hardbooleanEvet
appsarray<object>Evet
apps[].app_idstringEvet
apps[].namestringEvet
apps[].messages_sentnumberEvet
apps[].active_subscriptionsnumberEvet
apps[].maunumberEvet
dailyarray<object>Evet
daily[].datestringEvet
daily[].messages_sentnumberEvet
daily[].api_requestsnumberEvet
daily[].events_ingestednumberEvet
trialingbooleanEvet
trial_ends_atstring | nullEvet

Kullanıldığı işlemler: GET /v1/organization/usage

User

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
external_idstring | nullEvet
propertiesmap<string, any>Evet
tagsmap<string, string>Evet
first_seen_atstringEvet
last_active_atstringEvet
session_countintegerEvet
usage_secondsintegerEvet
merged_intostring | nullEvet
created_atstringEvet
updated_atstringEvet
subscription_countintegerEvet
channelsarray<enum>Evet

UserDetail

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
external_idstring | nullEvet
propertiesmap<string, any>Evet
tagsmap<string, string>Evet
first_seen_atstringEvet
last_active_atstringEvet
session_countintegerEvet
usage_secondsintegerEvet
merged_intostring | nullEvet
created_atstringEvet
updated_atstringEvet
subscription_countintegerEvet
channelsarray<enum>Evet
aliasesarray<object>Evet
aliases[].labelstringEvet
aliases[].valuestringEvet
subscriptionsarray<object>Evet
subscriptions[].idstringEvet
subscriptions[].app_idstringEvet
subscriptions[].user_idstring | nullEvet
subscriptions[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
subscriptions[].tokenstringEvet
subscriptions[].statusenumEvetDeğerler: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullEvet
subscriptions[].deviceobjectEvet
subscriptions[].device.modelstringHayırUzunluk: 0–100
subscriptions[].device.osstringHayırUzunluk: 0–50
subscriptions[].device.os_versionstringHayırUzunluk: 0–50
subscriptions[].device.app_versionstring | nullHayır
subscriptions[].device.sdk_versionstringHayırUzunluk: 0–50
subscriptions[].device.sdk_platformstringHayırUzunluk: 0–50
subscriptions[].device.carrierstringHayırUzunluk: 0–100
subscriptions[].device.localestringHayırUzunluk: 0–20
subscriptions[].device.timezonestringHayırUzunluk: 0–64
subscriptions[].device.push_capablebooleanHayır
subscriptions[].device.push_environmentenumHayırDeğerler: "sandbox", "production"
subscriptions[].test_devicebooleanEvet
subscriptions[].test_device_namestring | nullEvet
subscriptions[].last_active_atstringEvet
subscriptions[].last_sent_atstring | nullEvet
subscriptions[].last_delivered_atstring | nullEvet
subscriptions[].opted_in_atstring | nullEvet
subscriptions[].opt_in_sourcestring | nullEvet
subscriptions[].unsubscribed_atstring | nullEvet
subscriptions[].locationobject | nullEvet
subscriptions[].created_atstringEvet

Kullanıldığı işlemler: 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

AlanTürZorunluAçıklama
exported_atstringEvet
userobjectEvet
user.idstringEvet
user.app_idstringEvet
user.external_idstring | nullEvet
user.propertiesmap<string, any>Evet
user.tagsmap<string, string>Evet
user.first_seen_atstringEvet
user.last_active_atstringEvet
user.session_countintegerEvet
user.usage_secondsintegerEvet
user.merged_intostring | nullEvet
user.created_atstringEvet
user.updated_atstringEvet
user.subscription_countintegerEvet
user.channelsarray<enum>Evet
user.aliasesarray<object>Evet
user.aliases[].labelstringEvet
user.aliases[].valuestringEvet
user.subscriptionsarray<object>Evet
user.subscriptions[].idstringEvet
user.subscriptions[].app_idstringEvet
user.subscriptions[].user_idstring | nullEvet
user.subscriptions[].channelenumEvetDeğerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"
user.subscriptions[].tokenstringEvet
user.subscriptions[].statusenumEvetDeğerler: "subscribed", "unsubscribed", "invalid", "pending"
user.subscriptions[].unsubscribe_reasonenum | nullEvet
user.subscriptions[].deviceobjectEvet
user.subscriptions[].test_devicebooleanEvet
user.subscriptions[].test_device_namestring | nullEvet
user.subscriptions[].last_active_atstringEvet
user.subscriptions[].last_sent_atstring | nullEvet
user.subscriptions[].last_delivered_atstring | nullEvet
user.subscriptions[].opted_in_atstring | nullEvet
user.subscriptions[].opt_in_sourcestring | nullEvet
user.subscriptions[].unsubscribed_atstring | nullEvet
user.subscriptions[].locationobject | nullEvet
user.subscriptions[].created_atstringEvet
eventsarray<object>Evet
events[].idstringEvet
events[].user_idstring | nullEvet
events[].subscription_idstring | nullEvet
events[].namestringEvet
events[].propertiesmap<string, any>Evet
events[].valuenumber | nullEvet
events[].sourceenumEvetDeğerler: "sdk", "api", "system", "import"
events[].occurred_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/export

UserIdentity

AlanTürZorunluAçıklama
identitymap<string, string>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/identity, GET /v1/apps/{appId}/subscriptions/{subscriptionId}/user/identity

UserJourneyRuns

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].journey_idstringEvet
data[].versionintegerEvet
data[].user_idstringEvet
data[].external_idstring | nullEvet
data[].statusenumEvetDeğerler: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullEvet
data[].next_action_atstring | nullEvet
data[].entered_atstringEvet
data[].completed_atstring | nullEvet
data[].exit_reasonstring | nullEvet
data[].goal_idstring | nullEvet
data[].goal_reached_atstring | nullEvet
data[].contextmap<string, any>Evet
data[].journey_namestringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/journeys

UserList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].external_idstring | nullEvet
data[].propertiesmap<string, any>Evet
data[].tagsmap<string, string>Evet
data[].first_seen_atstringEvet
data[].last_active_atstringEvet
data[].session_countintegerEvet
data[].usage_secondsintegerEvet
data[].merged_intostring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet
data[].subscription_countintegerEvet
data[].channelsarray<enum>Evet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/users, POST /v1/apps/{appId}/users/search

UserMessageList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].delivery_idstringEvet
data[].message_idstringEvet
data[].campaign_idstring | nullEvet
data[].sourcestringEvet
data[].channelstringEvet
data[].statusstringEvet
data[].titlestring | nullEvet
data[].bodystring | nullEvet
data[].error_codestring | nullEvet
data[].created_atstringEvet
data[].sent_atstring | nullEvet
data[].delivered_atstring | nullEvet
data[].opened_atstring | nullEvet
data[].clicked_atstring | nullEvet

UserPreferences

AlanTürZorunluAçıklama
user_idstringEvet
dataarray<object>Evet
data[].categorystringEvet
data[].channelstring | nullEvet
data[].opted_inbooleanEvet
data[].explicitbooleanEvet
data[].sourcestring | nullEvet
data[].updated_atstring | nullEvet
categoriesarray<object>Evet
categories[].idstringEvet
categories[].app_idstringEvet
categories[].keystringEvet
categories[].namemap<string, string>Evet
categories[].descriptionmap<string, string>Evet
categories[].channelsarray<string> | nullEvet
categories[].default_opted_inbooleanEvet
categories[].positionintegerEvet
categories[].opted_out_usersintegerEvet
categories[].created_atstringEvet
categories[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/preferences, PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences

VerifyAddressDto

AlanTürZorunluAçıklama
addressstringEvetUzunluk: 3–320

Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/verify-address

WarehouseConnectionResult

AlanTürZorunluAçıklama
okbooleanEvet
detailstring | nullEvet
errorobject | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports/test-connection, POST /v1/apps/{appId}/warehouse-exports/{exportId}/test

WarehouseConnectionTest

Tür: object

Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports/test-connection

WarehouseExport

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
destinationenumEvetDeğerler: "bigquery", "snowflake", "s3_parquet"
configmap<string, any>Evet
credentials_hintstringEvet
tablesarray<enum>Evet
scheduleenumEvetDeğerler: "hourly", "daily"
enabledbooleanEvet
statusenumEvetDeğerler: "active", "paused", "failing"
consecutive_failuresintegerEvet
last_errorstring | nullEvet
cursorsmap<string, object>Evet
schema_versionsmap<string, integer>Evet
last_run_atstring | nullEvet
last_success_atstring | nullEvet
next_run_atstring | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports, GET /v1/apps/{appId}/warehouse-exports/{exportId}, PATCH /v1/apps/{appId}/warehouse-exports/{exportId}

WarehouseExportCreate

Tür: object

Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports

WarehouseExportList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].destinationenumEvetDeğerler: "bigquery", "snowflake", "s3_parquet"
data[].configmap<string, any>Evet
data[].credentials_hintstringEvet
data[].tablesarray<enum>Evet
data[].scheduleenumEvetDeğerler: "hourly", "daily"
data[].enabledbooleanEvet
data[].statusenumEvetDeğerler: "active", "paused", "failing"
data[].consecutive_failuresintegerEvet
data[].last_errorstring | nullEvet
data[].cursorsmap<string, object>Evet
data[].schema_versionsmap<string, integer>Evet
data[].last_run_atstring | nullEvet
data[].last_success_atstring | nullEvet
data[].next_run_atstring | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports

WarehouseExportRun

AlanTürZorunluAçıklama
idstringEvet
export_idstringEvet
triggerenumEvetDeğerler: "schedule", "manual"
statusenumEvetDeğerler: "queued", "running", "succeeded", "failed"
tablesmap<string, object>Evet
row_countintegerEvet
attemptintegerEvet
errorstring | nullEvet
started_atstring | nullEvet
finished_atstring | nullEvet
duration_msinteger | nullEvet
created_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports/{exportId}/run

WarehouseExportRunPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].export_idstringEvet
data[].triggerenumEvetDeğerler: "schedule", "manual"
data[].statusenumEvetDeğerler: "queued", "running", "succeeded", "failed"
data[].tablesmap<string, object>Evet
data[].row_countintegerEvet
data[].attemptintegerEvet
data[].errorstring | nullEvet
data[].started_atstring | nullEvet
data[].finished_atstring | nullEvet
data[].duration_msinteger | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports/{exportId}/runs

WarehouseTables

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].nameenumEvetDeğerler: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions"
data[].modeenumEvetDeğerler: "incremental", "snapshot"
data[].schema_versionintegerEvet
data[].cursor_columnstring | nullEvet
data[].columnsarray<object>Evet
data[].columns[].namestringEvet
data[].columns[].typestringEvet
data[].columns[].nullablebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports/tables

Webhook

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
urlstringEvet
descriptionstring | nullEvet
eventsarray<string>Evet
event_filtersobjectEvet
event_filters.event_namesarray<string>Hayır
batchbooleanEvet
statusenumEvetDeğerler: "active", "failing", "disabled"
disabled_reasonstring | nullEvet
failure_countintegerEvet
failing_sincestring | nullEvet
last_success_atstring | nullEvet
last_failure_atstring | nullEvet
header_namesarray<string>Evet
previous_secret_expires_atstring | nullEvet
body_templatestring | nullEvet
body_content_typeenumEvetDeğerler: "application/json", "text/plain"
filtersobject | nullEvet
created_atstringEvet
updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks/{webhookId}, PATCH /v1/apps/{appId}/webhooks/{webhookId}

WebhookBulkReplayResult

AlanTürZorunluAçıklama
replayedintegerEvet

WebhookDeliveryDetail

AlanTürZorunluAçıklama
idstringEvet
endpoint_idstringEvet
event_typestringEvet
event_idstringEvet
subject_idstring | nullEvet
attemptintegerEvet
statusenumEvetDeğerler: "pending", "success", "failed", "dead"
response_statusinteger | nullEvet
response_body_excerptstring | nullEvet
errorstring | nullEvet
duration_msinteger | nullEvet
next_retry_atstring | nullEvet
delivered_atstring | nullEvet
replay_ofstring | nullEvet
created_atstringEvet
payloadmap<string, any>Evet

Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/{webhookId}/test, POST /v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replay

WebhookDeliveryPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].endpoint_idstringEvet
data[].event_typestringEvet
data[].event_idstringEvet
data[].subject_idstring | nullEvet
data[].attemptintegerEvet
data[].statusenumEvetDeğerler: "pending", "success", "failed", "dead"
data[].response_statusinteger | nullEvet
data[].response_body_excerptstring | nullEvet
data[].errorstring | nullEvet
data[].duration_msinteger | nullEvet
data[].next_retry_atstring | nullEvet
data[].delivered_atstring | nullEvet
data[].replay_ofstring | nullEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks/{webhookId}/deliveries

WebhookEventTypes

AlanTürZorunluAçıklama
dataarray<string>Evet

WebhookList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].urlstringEvet
data[].descriptionstring | nullEvet
data[].eventsarray<string>Evet
data[].event_filtersobjectEvet
data[].event_filters.event_namesarray<string>Hayır
data[].batchbooleanEvet
data[].statusenumEvetDeğerler: "active", "failing", "disabled"
data[].disabled_reasonstring | nullEvet
data[].failure_countintegerEvet
data[].failing_sincestring | nullEvet
data[].last_success_atstring | nullEvet
data[].last_failure_atstring | nullEvet
data[].header_namesarray<string>Evet
data[].previous_secret_expires_atstring | nullEvet
data[].body_templatestring | nullEvet
data[].body_content_typeenumEvetDeğerler: "application/json", "text/plain"
data[].filtersobject | nullEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks

WebhookPreviewDto

AlanTürZorunluAçıklama
event_typeenumEvetDeğerler: "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", "audit.created", "webhook.test"
datamap<string, any>Hayır
body_templatestring | nullHayır
body_content_typeenumHayırŞablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain"
filtersobject | nullHayır
batchbooleanHayır

Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/preview

WebhookPreviewResult

AlanTürZorunluAçıklama
payloadmap<string, any>Evet
matchedbooleanEvetOlay filtreden geçer mi (geçmezse gönderilmez).
failed_conditionsarray<object>Evet
failed_conditions[].fieldstringEvet
failed_conditions[].opstringEvet
failed_conditions[].valueanyHayır
bodystring | nullEvet
content_typestringEvet
errorobject | nullEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/preview

WebhookSecret

AlanTürZorunluAçıklama
secretstringEvet

WebhookWithSecret

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
urlstringEvet
descriptionstring | nullEvet
eventsarray<string>Evet
event_filtersobjectEvet
event_filters.event_namesarray<string>Hayır
batchbooleanEvet
statusenumEvetDeğerler: "active", "failing", "disabled"
disabled_reasonstring | nullEvet
failure_countintegerEvet
failing_sincestring | nullEvet
last_success_atstring | nullEvet
last_failure_atstring | nullEvet
header_namesarray<string>Evet
previous_secret_expires_atstring | nullEvet
body_templatestring | nullEvet
body_content_typeenumEvetDeğerler: "application/json", "text/plain"
filtersobject | nullEvet
created_atstringEvet
updated_atstringEvet
secretstringEvetYalnızca oluşturma ve rotasyon yanıtında bir kez döner.

Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks/{webhookId}/rotate-secret

WhatsAppTemplateList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].external_idstring | nullEvet
data[].namestringEvet
data[].languagestringEvet
data[].categorystringEvet
data[].statusstringEvet
data[].componentsarray<map<string, any>>Evet
data[].body_paramsintegerEvet
data[].rejected_reasonstring | nullEvet
data[].quality_scorestring | nullEvet
data[].synced_atstringEvet

Kullanıldığı işlemler: GET /v1/apps/{appId}/whatsapp/templates

WhatsAppTemplateSync

AlanTürZorunluAçıklama
totalintegerEvet
removedintegerEvet
dataarray<object>Evet
data[].idstringEvet
data[].external_idstring | nullEvet
data[].namestringEvet
data[].languagestringEvet
data[].categorystringEvet
data[].statusstringEvet
data[].componentsarray<map<string, any>>Evet
data[].body_paramsintegerEvet
data[].rejected_reasonstring | nullEvet
data[].quality_scorestring | nullEvet
data[].synced_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/whatsapp/templates/sync

ZapierHook

AlanTürZorunluAçıklama
idstringEvet
eventstringEvet
event_namestring | nullEvet
target_urlstringEvet
last_delivered_atstring | nullEvet
failure_countintegerEvet
created_atstringEvet

Kullanıldığı işlemler: POST /v1/apps/{appId}/integrations/zapier/hooks

ZapierHookList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].eventstringEvet
data[].event_namestring | nullEvet
data[].target_urlstringEvet
data[].last_delivered_atstring | nullEvet
data[].failure_countintegerEvet
data[].created_atstringEvet

ZapierMe

AlanTürZorunluAçıklama
app_idstringEvet
app_namestringEvet
org_idstringEvet
scopesarray<string>Evet

Kullanıldığı işlemler: GET /v1/apps/{appId}/integrations/zapier/me

ZapierSamples

Tür: array<object>

Kullanıldığı işlemler: GET /v1/apps/{appId}/integrations/zapier/samples

ZapierSubscribeDto

AlanTürZorunluAçıklama
target_urlstringEvetUzunluk: 1–2000
eventenumEvetDeğerler: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed"
event_namestringHayırUzunluk: 1–100

Kullanıldığı işlemler: POST /v1/apps/{appId}/integrations/zapier/hooks

Bu sayfada

DizinAcceptInviteResultAccountAccountExportAddAliasDtoAddSubscriptionDtoAiGlossaryEntryAiGlossaryListAiSettingsAiStatusAiSubjectScoreResultAiSuggestionsAiTranslateResultAiTranslationAiTranslationListAiUsageReportAiVariantsResultApiEventsDtoApiKeyApiKeyListAppAppListAppTransferAppTransferListAuditActionsAuditEntryAuditPageAuthConfigBillingStatusBrandingBrandResolutionCampaignCampaignPageCampaignStatsCampaignVariantStatsCellHandoffCellHandoffResultCellListCellOrgListChannelConfigChannelHookChannelListChannelStatusListChannelValidationCheckoutResultCleanupResultContentTableContentTableListContentTableRowsConversationConversationMessagePageConversationPageConversationReplyDtoConversationReplyResultConversionsReportCopyTemplateDtoCreateAppApiKeyDtoCreateAppDtoCreateCategoryDtoCreatedApiKeyCreateDataFeedDtoCreateExportDtoCreateIdentityKeyDtoCreateInAppDtoCreateKeywordDtoCreateLiveActivityTypeDtoCreateNotificationDtoCreateNotificationResultCreateSuppressionDtoCreateTemplateDtoCreateWarmupPlanDtoCreateWebhookDtoCustomDomainCustomDomainListDataFeedDataFeedListDataFeedTestResultDeliverabilitySettingsDtoDeliveryDeliveryListEmailAddressCheckEmailDeliverabilitySettingsEmailDesignEmailDesignPageEmailDesignPreviewEmailSavedBlockEmailSavedBlockListEmailWarmupPlanEmailWarmupPlanListEmailWarmupUsageEndLiveActivityDtoEngagementReportEstimateAudienceDtoEstimateAudienceResultEventDefinitionEventDefinitionDetailEventDefinitionListEventListEventsAcceptedEventsReportExportExportListFunnelBodyDtoFunnelReportIdentityKeyIdentityKeyListImportImportListInAppMessageInAppMessagePageInAppStatusDtoInAppTemplateInAppTemplateListInAppWinnerDtoInboxItemInboxPageInboxReadAllResultIntegrationIntegrationListIntegrationOkIntegrationRunListIntegrationSyncResultIntegrationTestResultInviteInviteListInvitePreviewInvoiceListJourneyJourneyDetailJourneyPageJourneyPublishResultJourneyRunJourneyRunDetailJourneyRunPageJourneyStatsJourneyTriggerResultJourneyVersionListLiveActivitySendResultLiveActivityTokenResultLiveActivityTypeLiveActivityTypeListLoginResultMeMemberMemberListMessageMessageCategoryMessageCategoryListMessageListMessagesReportMfaSetupOAuthApproveResultOAuthConsentContextOkOpenedDtoOrgOrgDataExportOrgListOrgNotificationListOverviewStatsPatchEventDefinitionDtoPatchSubscriptionDtoPatchUserDtoPlanListPortalResultProvidersReportRecentEventsRecoveryCodesRenderPreviewRenderTemplateDtoRequestLogRequestLogPageResellerChildOrgResellerChildOrgListResellerStatementRetentionReportScheduleCampaignDtoScimTokenCreatedScimTokenListSdkConfigSdkErrorPageSdkErrorsAcceptedSdkErrorsDtoSdkEventsDtoSdkIdentityDtoSdkIdentityResultSdkInAppEventDtoSdkInAppListSdkInboxActionDtoSdkLiveActivityTokenDeleteDtoSdkLiveActivityTokenDtoSdkLoginDtoSdkLogoutDtoSdkPreferencesSdkRegisterDtoSdkRegisterResultSdkSecretSdkSessionDtoSdkSetPreferencesDtoSdkSubscriptionPatchDtoSdkUserPatchDtoSdkUserResultSegmentSegmentCampaignsSegmentEstimateSegmentPageSegmentPreviewSelectWinnerDtoSessionListSetOwnerDtoSetPreferencesDtoSmsKeywordSmsKeywordListSsoConnectionSsoConnectionListSsoDiscoverResultSsoDomainSsoDomainListSsoSettingsSsoTestResultSsoTestStartStartLiveActivityDtoStatusTokenResultSubscriptionSubscriptionListSubscriptionsReportSuppressionSuppressionPageTemplateTemplatePageTemplateStatsTemplateVersionListTestDataFeedDtoTraceResultTriggerRunDtoUpdateApiKeyDtoUpdateAppDtoUpdateCategoryDtoUpdateContentTableDtoUpdateDataFeedDtoUpdateInAppDtoUpdateJourneyDtoUpdateKeywordDtoUpdateLiveActivityDtoUpdateLiveActivityTypeDtoUpdateNodeDtoUpdateTemplateDtoUpdateWarehouseExportDtoUpdateWarmupPlanDtoUpdateWebhookDtoUpsertUserDtoUsageReportUserUserDetailUserExportUserIdentityUserJourneyRunsUserListUserMessageListUserPreferencesVerifyAddressDtoWarehouseConnectionResultWarehouseConnectionTestWarehouseExportWarehouseExportCreateWarehouseExportListWarehouseExportRunWarehouseExportRunPageWarehouseTablesWebhookWebhookBulkReplayResultWebhookDeliveryDetailWebhookDeliveryPageWebhookEventTypesWebhookListWebhookPreviewDtoWebhookPreviewResultWebhookSecretWebhookWithSecretWhatsAppTemplateListWhatsAppTemplateSyncZapierHookZapierHookListZapierMeZapierSamplesZapierSubscribeDto