Ş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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
org_id | string | Evet | |
org_slug | string | Evet | |
role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
Account
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
email | string | Evet | |
name | string | Evet | |
locale | string | Evet | |
timezone | string | Evet | |
email_verified | boolean | Evet | |
mfa_enabled | boolean | Evet | |
is_platform_admin | boolean | Evet | |
has_password | boolean | Evet | |
marketing_opt_in | boolean | Evet | |
created_at | string | Evet |
AccountExport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
format_version | integer | Evet | |
generated_at | string | Evet | |
account | object | Evet | |
account.id | string | Evet | |
account.email | string | Evet | |
account.name | string | Evet | |
account.locale | string | Evet | |
account.timezone | string | Evet | |
account.status | string | Evet | |
account.email_verified_at | string | null | Evet | |
account.has_password | boolean | Evet | |
account.mfa_enabled | boolean | Evet | |
account.is_platform_admin | boolean | Evet | |
account.last_login_at | string | null | Evet | |
account.created_at | string | Evet | |
account.updated_at | string | Evet | |
consents | object | Evet | |
consents.terms_accepted_at | string | null | Evet | |
consents.terms_version | string | null | Evet | |
consents.marketing_opt_in | boolean | Evet | |
consents.marketing_opt_in_at | string | null | Evet | |
memberships | array<object> | Evet | |
memberships[].org_id | string | Evet | |
memberships[].org_name | string | Evet | |
memberships[].org_slug | string | Evet | |
memberships[].role | string | Evet | |
memberships[].is_primary_owner | boolean | Evet | |
memberships[].app_scopes | array<string> | Evet | |
memberships[].joined_at | string | Evet | |
sessions | array<object> | Evet | |
sessions[].id | string | Evet | |
sessions[].ip | string | null | Evet | |
sessions[].user_agent | string | null | Evet | |
sessions[].auth_method | string | Evet | |
sessions[].persistent | boolean | Evet | |
sessions[].created_at | string | Evet | |
sessions[].last_seen_at | string | Evet | |
sessions[].expires_at | string | Evet | |
sessions[].revoked_at | string | null | Evet | |
identities | array<object> | Evet | |
identities[].provider | string | Evet | |
identities[].provider_user_id | string | Evet | |
identities[].email | string | null | Evet | |
identities[].created_at | string | Evet | |
mfa_factors | array<object> | Evet | |
mfa_factors[].type | string | Evet | |
mfa_factors[].verified_at | string | null | Evet | |
mfa_factors[].last_used_at | string | null | Evet | |
mfa_factors[].created_at | string | Evet | |
oauth_grants | array<object> | Evet | |
oauth_grants[].client_name | string | Evet | |
oauth_grants[].org_id | string | Evet | |
oauth_grants[].app_id | string | null | Evet | |
oauth_grants[].scopes | array<string> | Evet | |
oauth_grants[].created_at | string | Evet | |
oauth_grants[].revoked_at | string | null | Evet | |
audit_entries | array<object> | Evet | |
audit_entries[].org_id | string | Evet | |
audit_entries[].app_id | string | null | Evet | |
audit_entries[].action | string | Evet | |
audit_entries[].target_type | string | null | Evet | |
audit_entries[].target_id | string | null | Evet | |
audit_entries[].metadata | map<string, any> | Evet | |
audit_entries[].ip | string | null | Evet | |
audit_entries[].created_at | string | Evet |
AddAliasDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
identity | map<string, string> | Evet |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/users/by/{label}/{value}/identity
AddSubscriptionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
token | string | Evet | Uzunluk: 1–4096 |
device | object | Hayır | Varsayılan: {} |
device.model | string | Hayır | Uzunluk: 0–100 |
device.os | string | Hayır | Uzunluk: 0–50 |
device.os_version | string | Hayır | Uzunluk: 0–50 |
device.app_version | string | null | Hayır | |
device.sdk_version | string | Hayır | Uzunluk: 0–50 |
device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
device.carrier | string | Hayır | Uzunluk: 0–100 |
device.locale | string | Hayır | Uzunluk: 0–20 |
device.timezone | string | Hayır | Uzunluk: 0–64 |
device.push_capable | boolean | Hayır | |
device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
status | enum | Hayır | Değerler: "subscribed", "unsubscribed" |
opt_in | object | Hayır | |
opt_in.source | string | Evet | Uzunluk: 1–100 |
opt_in.at | string (date-time) | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/users/by/{label}/{value}/subscriptions
AiGlossaryEntry
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
term | string | Evet | |
translations | map<string, string> | Evet | |
note | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
AiGlossaryList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].term | string | Evet | |
data[].translations | map<string, string> | Evet | |
data[].note | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
AiSettings
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
enabled | boolean | Evet | |
monthly_token_quota | integer | Evet | |
banned_phrases | array<string> | Evet | |
provider | enum | Evet | Değerler: "anthropic", "mock" |
available | boolean | Evet | |
models | object | Evet | |
models.default | string | Evet | |
models.long | string | Evet | |
usage | object | Evet | |
usage.used_tokens | integer | Evet | |
usage.quota_tokens | integer | Evet | |
usage.period_start | string | Evet |
AiStatus
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
enabled | boolean | Evet | |
available | boolean | Evet | |
provider | enum | Evet | Değerler: "anthropic", "mock" |
usage | object | Evet | |
usage.used_tokens | integer | Evet | |
usage.quota_tokens | integer | Evet | |
usage.period_start | string | Evet | |
languages | array<string> | Evet | |
default_language | string | Evet | |
field_limits | map<string, integer> | Evet | |
pending_translations | integer | Evet |
AiSubjectScoreResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
score | integer | Evet | |
reasons | array<string> | Evet | |
improved | array<string> | Evet | |
meta | object | Evet | |
meta.model | string | Evet | |
meta.filtered | integer | Evet | |
meta.warnings | array<string> | Evet |
AiSuggestions
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
suggestions | array<object> | Evet | |
suggestions[].text | string | Evet | |
suggestions[].length | integer | Evet | |
meta | object | Evet | |
meta.model | string | Evet | |
meta.filtered | integer | Evet | |
meta.warnings | array<string> | Evet |
AiTranslateResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].source_language | string | Evet | |
data[].target_language | string | Evet | |
data[].source | object | Evet | |
data[].source.headings | string | Hayır | |
data[].source.contents | string | Hayır | |
data[].source.subtitle | string | Hayır | |
data[].source.email_subject | string | Hayır | |
data[].source.email_preheader | string | Hayır | |
data[].result | object | Evet | |
data[].result.headings | string | Hayır | |
data[].result.contents | string | Hayır | |
data[].result.subtitle | string | Hayır | |
data[].result.email_subject | string | Hayır | |
data[].result.email_preheader | string | Hayır | |
data[].status | enum | Evet | Değerler: "pending", "approved", "rejected" |
data[].ref_type | string | null | Evet | |
data[].ref_id | string | null | Evet | |
data[].warnings | array<string> | Evet | |
data[].created_at | string | Evet | |
data[].reviewed_at | string | null | Evet | |
data[].reviewed_by | string | null | Evet | |
meta | object | Evet | |
meta.model | string | Evet | |
meta.filtered | integer | Evet | |
meta.warnings | array<string> | Evet |
AiTranslation
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
source_language | string | Evet | |
target_language | string | Evet | |
source | object | Evet | |
source.headings | string | Hayır | |
source.contents | string | Hayır | |
source.subtitle | string | Hayır | |
source.email_subject | string | Hayır | |
source.email_preheader | string | Hayır | |
result | object | Evet | |
result.headings | string | Hayır | |
result.contents | string | Hayır | |
result.subtitle | string | Hayır | |
result.email_subject | string | Hayır | |
result.email_preheader | string | Hayır | |
status | enum | Evet | Değerler: "pending", "approved", "rejected" |
ref_type | string | null | Evet | |
ref_id | string | null | Evet | |
warnings | array<string> | Evet | |
created_at | string | Evet | |
reviewed_at | string | null | Evet | |
reviewed_by | string | null | Evet |
AiTranslationList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].source_language | string | Evet | |
data[].target_language | string | Evet | |
data[].source | object | Evet | |
data[].source.headings | string | Hayır | |
data[].source.contents | string | Hayır | |
data[].source.subtitle | string | Hayır | |
data[].source.email_subject | string | Hayır | |
data[].source.email_preheader | string | Hayır | |
data[].result | object | Evet | |
data[].result.headings | string | Hayır | |
data[].result.contents | string | Hayır | |
data[].result.subtitle | string | Hayır | |
data[].result.email_subject | string | Hayır | |
data[].result.email_preheader | string | Hayır | |
data[].status | enum | Evet | Değerler: "pending", "approved", "rejected" |
data[].ref_type | string | null | Evet | |
data[].ref_id | string | null | Evet | |
data[].warnings | array<string> | Evet | |
data[].created_at | string | Evet | |
data[].reviewed_at | string | null | Evet | |
data[].reviewed_by | string | null | Evet |
AiUsageReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
period_start | string | Evet | |
used_tokens | integer | Evet | |
quota_tokens | integer | Evet | |
by_feature | array<object> | Evet | |
by_feature[].feature | string | Evet | |
by_feature[].model | string | Evet | |
by_feature[].requests | integer | Evet | |
by_feature[].input_tokens | integer | Evet | |
by_feature[].output_tokens | integer | Evet |
AiVariantsResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
variants | array<object> | Evet | |
variants[].name | string | Evet | |
variants[].title | string | Evet | |
variants[].body | string | Evet | |
variants[].rationale | string | Evet | |
meta | object | Evet | |
meta.model | string | Evet | |
meta.filtered | integer | Evet | |
meta.warnings | array<string> | Evet |
ApiEventsDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
events | array<object> | Evet | Öğe: 1–500 |
events[].name | string | Evet | Uzunluk: 1–100 |
events[].properties | map<string, any> | Hayır | Varsayılan: {} |
events[].value | number | Hayır | |
events[].occurred_at | string (date-time) | Hayır | |
events[].event_id | string | Hayır | Uzunluk: 8–64 |
events[].subscription_id | string | Hayır | Uzunluk: 1–∞ |
events[].external_id | string | Hayır | Uzunluk: 1–255 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/events
ApiKey
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
org_id | string | Evet | |
app_id | string | null | Evet | |
name | string | Evet | |
prefix | string | Evet | |
scopes | array<string> | Evet | |
last_used_at | string | null | Evet | |
expires_at | string | null | Evet | |
revoked_at | string | null | Evet | |
ip_allowlist | array<string> | Evet | |
rotated_at | string | null | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/api-keys/{keyId}
ApiKeyList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].org_id | string | Evet | |
data[].app_id | string | null | Evet | |
data[].name | string | Evet | |
data[].prefix | string | Evet | |
data[].scopes | array<string> | Evet | |
data[].last_used_at | string | null | Evet | |
data[].expires_at | string | null | Evet | |
data[].revoked_at | string | null | Evet | |
data[].ip_allowlist | array<string> | Evet | |
data[].rotated_at | string | null | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/api-keys
App
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
org_id | string | Evet | |
name | string | Evet | |
slug | string | Evet | |
platform_flags | object | Evet | |
platform_flags.ios | boolean | Hayır | |
platform_flags.android | boolean | Hayır | |
platform_flags.web | boolean | Hayır | |
platform_flags.email | boolean | Hayır | |
platform_flags.sms | boolean | Hayır | |
icon_url | string | null | Evet | |
default_language | string | Evet | |
timezone | string | Evet | |
settings | object | Evet | |
settings.quietHours | object | null | Hayır | |
settings.frequencyCap | object | null | Hayır | |
settings.frequencyCaps | array<object> | Hayır | Öğe: 0–10 |
settings.frequencyCaps[].max | integer | Evet | Aralık: 1–1000 |
settings.frequencyCaps[].window | object | Evet | |
settings.frequencyCaps[].channels | array<enum> | Hayır | Öğe: 1–8 |
settings.inApp | object | Hayır | |
settings.inApp.minIntervalSeconds | integer | Hayır | Aralık: 0–604800 |
settings.androidChannels | array<object> | Hayır | Öğe: 0–50 |
settings.androidChannels[].id | string | Evet | Uzunluk: 1–64 |
settings.androidChannels[].name | string | Evet | Uzunluk: 1–60 |
settings.androidChannels[].description | string | Hayır | Uzunluk: 0–200 |
settings.androidChannels[].importance | enum | Evet | Değerler: "low", "default", "high", "urgent" |
settings.androidChannels[].sound | string | Hayır | Uzunluk: 0–64 |
settings.androidChannels[].vibration | boolean | Hayır | |
settings.androidChannels[].group | string | Hayır | Uzunluk: 0–64 |
settings.sms | object | Hayır | |
settings.sms.helpReply | string | Hayır | Uzunluk: 0–320 |
settings.sms.stopReply | string | Hayır | Uzunluk: 0–320 |
settings.sms.autoReply | boolean | Hayır | |
settings.preferenceCenter | object | Hayır | |
settings.preferenceCenter.enabled | boolean | Hayır | |
settings.preferenceCenter.brandName | string | Hayır | Uzunluk: 0–80 |
settings.preferenceCenter.logoUrl | string (url) | Hayır | Uzunluk: 0–2000 |
settings.preferenceCenter.accentColor | string | Hayır | |
settings.preferenceCenter.customUnsubscribeUrl | string (url) | Hayır | Uzunluk: 0–2000 |
settings.preferenceCenter.texts | map<string, object> | Hayır | |
settings.defaultTtlSeconds | integer | Hayır | Aralık: 60–2419200 |
settings.identityVerificationRequired | boolean | Hayır | |
settings.allowedOrigins | array<string> | Hayır | Öğe: 0–50 |
settings.campaignApprovalRequired | boolean | Hayır | |
settings.webPush | object | Hayır | |
settings.webPush.serviceWorkerPath | string | Hayır | Uzunluk: 0–200 |
settings.webPush.serviceWorkerScope | string | Hayır | Uzunluk: 0–200 |
settings.webPush.prompt | object | Hayır | |
settings.webPush.welcomeNotification | object | Hayır | |
settings.webPush.clickBehavior | object | Hayır | |
settings.webPush.customLink | object | Hayır | |
settings.webPush.promptBackoffDays | array<integer> | Hayır | Öğe: 0–10 |
settings.onboarding | object | Hayır | |
settings.onboarding.step | integer | Evet | Aralık: 0–6 |
settings.onboarding.simulation | boolean | Hayır | |
settings.onboarding.completed_at | string | null | Hayır | |
settings.onboarding.version | integer | Hayır | Aralık: 1–100 |
settings.onboarding.platforms | array<enum> | Hayır | Öğe: 0–4 |
settings.onboarding.framework | enum | Hayır | Değerler: "native", "flutter", "react-native", "unity", "capacitor", "cordova", "maui" |
settings.onboarding.web_integration | enum | Hayır | Değerler: "code", "wordpress" |
settings.sdkSetup | object | null | Hayır | |
identity_verification_mode | enum | Evet | Değerler: "hmac", "jwt", "both" |
status | enum | Evet | Değerler: "active", "suspended", "deleted" |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps, GET /v1/apps/{appId}, PATCH /v1/apps/{appId}
AppList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].org_id | string | Evet | |
data[].name | string | Evet | |
data[].slug | string | Evet | |
data[].platform_flags | object | Evet | |
data[].platform_flags.ios | boolean | Hayır | |
data[].platform_flags.android | boolean | Hayır | |
data[].platform_flags.web | boolean | Hayır | |
data[].platform_flags.email | boolean | Hayır | |
data[].platform_flags.sms | boolean | Hayır | |
data[].icon_url | string | null | Evet | |
data[].default_language | string | Evet | |
data[].timezone | string | Evet | |
data[].settings | object | Evet | |
data[].settings.quietHours | object | null | Hayır | |
data[].settings.frequencyCap | object | null | Hayır | |
data[].settings.frequencyCaps | array<object> | Hayır | Öğe: 0–10 |
data[].settings.inApp | object | Hayır | |
data[].settings.androidChannels | array<object> | Hayır | Öğe: 0–50 |
data[].settings.sms | object | Hayır | |
data[].settings.preferenceCenter | object | Hayır | |
data[].settings.defaultTtlSeconds | integer | Hayır | Aralık: 60–2419200 |
data[].settings.identityVerificationRequired | boolean | Hayır | |
data[].settings.allowedOrigins | array<string> | Hayır | Öğe: 0–50 |
data[].settings.campaignApprovalRequired | boolean | Hayır | |
data[].settings.webPush | object | Hayır | |
data[].settings.onboarding | object | Hayır | |
data[].settings.sdkSetup | object | null | Hayır | |
data[].identity_verification_mode | enum | Evet | Değerler: "hmac", "jwt", "both" |
data[].status | enum | Evet | Değerler: "active", "suspended", "deleted" |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps
AppTransfer
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
app_name | string | null | Evet | |
from_org | object | Evet | |
from_org.id | string | Evet | |
from_org.name | string | null | Evet | |
from_org.slug | string | null | Evet | |
to_org | object | Evet | |
to_org.id | string | Evet | |
to_org.name | string | null | Evet | |
to_org.slug | string | null | Evet | |
status | enum | Evet | Değerler: "pending", "completed", "cancelled", "rejected", "failed" |
source_approved_at | string | null | Evet | |
target_approved_at | string | null | Evet | |
completed_at | string | null | Evet | |
failure_reason | string | null | Evet | |
created_at | string | Evet |
AppTransferList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].app_name | string | null | Evet | |
data[].from_org | object | Evet | |
data[].from_org.id | string | Evet | |
data[].from_org.name | string | null | Evet | |
data[].from_org.slug | string | null | Evet | |
data[].to_org | object | Evet | |
data[].to_org.id | string | Evet | |
data[].to_org.name | string | null | Evet | |
data[].to_org.slug | string | null | Evet | |
data[].status | enum | Evet | Değerler: "pending", "completed", "cancelled", "rejected", "failed" |
data[].source_approved_at | string | null | Evet | |
data[].target_approved_at | string | null | Evet | |
data[].completed_at | string | null | Evet | |
data[].failure_reason | string | null | Evet | |
data[].created_at | string | Evet |
AuditActions
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
actions | array<string> | Evet |
AuditEntry
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
org_id | string | Evet | |
app_id | string | null | Evet | |
actor_type | enum | Evet | Değerler: "account", "api_key", "system" |
actor_id | string | null | Evet | |
action | string | Evet | |
target_type | string | null | Evet | |
target_id | string | null | Evet | |
metadata | map<string, any> | Evet | |
ip | string | null | Evet | |
request_id | string | null | Evet | |
created_at | string | Evet |
AuditPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].org_id | string | Evet | |
data[].app_id | string | null | Evet | |
data[].actor_type | enum | Evet | Değerler: "account", "api_key", "system" |
data[].actor_id | string | null | Evet | |
data[].action | string | Evet | |
data[].target_type | string | null | Evet | |
data[].target_id | string | null | Evet | |
data[].metadata | map<string, any> | Evet | |
data[].ip | string | null | Evet | |
data[].request_id | string | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/organization/audit-logs
AuthConfig
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
turnstile_site_key | string | null | Evet |
BillingStatus
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
org_id | string | Evet | |
provider | string | Evet | stripe | iyzico | mock | none (ödeme sağlayıcısı yapılandırılmamış; checkout/portal 503 döner) |
plan | object | Evet | |
plan.code | string | Evet | |
plan.name | string | Evet | |
plan.monthly_price | integer | Evet | |
plan.currency | string | Evet | |
plan.position | integer | Evet | |
plan.is_public | boolean | Evet | |
plan.limits | object | Evet | |
plan.limits.subscriptions | integer | null | Evet | |
plan.limits.messages_per_month | integer | null | Evet | |
plan.limits.api_rps | integer | null | Evet | |
plan.limits.members | integer | null | Evet | |
plan.limits.apps | integer | null | Evet | |
plan.limits.retention_days | integer | null | Evet | |
plan.limits.journeys | integer | null | Evet | |
plan.limits.segments | integer | null | Evet | |
plan.limits.ab_variants | integer | null | Evet | |
plan.limits.tags_per_user | integer | null | Evet | |
plan.limits.aliases_per_user | integer | null | Evet | |
plan.limits.subscriptions_per_user | integer | null | Evet | |
plan.limits.report_history_days | integer | null | Evet | |
plan.limits.webhooks | integer | null | Evet | |
plan.limits.api_keys | integer | null | Evet | |
plan.features | object | Evet | |
plan.features.journeys | boolean | Evet | |
plan.features.ab_testing | boolean | Evet | |
plan.features.email | boolean | Evet | |
plan.features.sms | boolean | Evet | |
plan.features.in_app | boolean | Evet | |
plan.features.approval_flow | boolean | Evet | |
plan.features.sso | boolean | Evet | |
plan.features.scim | boolean | Hayır | |
plan.features.audit_export | boolean | Evet | |
plan.features.roles | array<string> | Evet | |
plan.purchasable | boolean | Evet | |
effective_plan_code | string | Evet | |
trialing | boolean | Evet | |
trial_ends_at | string | null | Evet | |
suspended | boolean | Evet | |
suspended_reason | string | null | Evet | |
subscription | object | null | Evet | |
billing_info | object | null | Evet |
Branding
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
product_name | string | null | Evet | |
logo_url | string | null | Evet | |
primary_color | string | null | Evet | |
secondary_color | string | null | Evet | |
support_email | string | null | Evet | |
hide_powered_by | boolean | Evet | |
effective | object | Evet | |
effective.product_name | string | Evet | |
effective.logo_url | string | null | Evet | |
effective.primary_color | string | null | Evet | |
effective.secondary_color | string | null | Evet | |
effective.support_email | string | null | Evet | |
effective.powered_by | boolean | Evet | |
effective.inherited | boolean | Evet | |
features | object | Evet | |
features.white_label | boolean | Evet | |
features.hide_powered_by | boolean | Evet |
BrandResolution
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
kind | enum | Evet | Değerler: "dashboard", "tracking", "preference_center", "status_page" |
org_slug | string | Evet | |
product_name | string | Evet | |
logo_url | string | null | Evet | |
primary_color | string | null | Evet | |
secondary_color | string | null | Evet | |
support_email | string | null | Evet | |
powered_by | boolean | Evet |
Campaign
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
labels | array<string> | Evet | |
category | string | null | Evet | |
ab_test | object | Evet | |
ab_test.enabled | boolean | Hayır | |
ab_test.test_percentage | integer | Hayır | Aralık: 1–100 |
ab_test.winner | object | Hayır | |
ab_test.winner.mode | enum | Evet | Değerler: "manual", "auto" |
ab_test.winner.metric | enum | Evet | Değerler: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | Hayır | Aralık: 5–10080 |
ab_test.phase | enum | Hayır | Değerler: "testing", "winner_sent" |
ab_test.winner_variant_id | string | Hayır | |
ab_test.decided_at | string | Hayır | |
ab_test.decided_by | string | Hayır | |
ab_test.significance | object | Hayır | |
ab_test.significance.p_value | number | Evet | |
ab_test.significance.significant | boolean | Evet | |
ab_test.significance.metric | string | Evet | |
variants | array<object> | Evet | |
variants[].id | string | Evet | |
variants[].name | string | Evet | |
variants[].weight_percent | integer | Evet | |
variants[].content | map<string, any> | null | Evet | |
variants[].is_control | boolean | Evet | |
variants[].position | integer | Evet | |
type | enum | Evet | Değerler: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Evet | Değerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Evet | |
content | map<string, any> | Evet | |
template_id | string | null | Evet | |
template_version | integer | null | Evet | |
delivery | object | Evet | |
delivery.timezone_mode | enum | Hayır | Değerler: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | Hayır | |
delivery.throttle_per_minute | integer | Hayır | Aralık: 1–1000000 |
delivery.ttl | integer | Hayır | Aralık: 60–2419200 |
delivery.priority | 5 | 10 | Hayır | |
delivery.collapse_id | string | Hayır | Uzunluk: 0–64 |
delivery.frequency_cap_exempt | boolean | Hayır | |
delivery.quiet_hours_exempt | boolean | Hayır | |
delivery.one_per_user | boolean | Hayır | |
recurrence | object | null | Evet | |
approval | object | Evet | |
approval.required | boolean | Evet | |
approval.pending_action | enum | Hayır | Değerler: "send", "schedule" |
approval.requested_by | string | Hayır | |
approval.requested_at | string | Hayır | |
approval.approved_by | string | Hayır | |
approval.approved_at | string | Hayır | |
approval.rejected_by | string | Hayır | |
approval.rejected_at | string | Hayır | |
stats | object | Evet | |
stats.runs | integer | Hayır | |
stats.targeted | integer | Hayır | |
stats.suppressed | integer | Hayır | |
stats.sent | integer | Hayır | |
stats.delivered | integer | Hayır | |
stats.failed | integer | Hayır | |
stats.opened | integer | Hayır | |
stats.clicked | integer | Hayır | |
stats.converted | integer | Hayır | |
stats.bounced | integer | Hayır | |
stats.complained | integer | Hayır | |
stats.unsubscribed | integer | Hayır | |
stats.sms_segments | integer | Hayır | |
send_at | string | null | Evet | |
next_run_at | string | null | Evet | |
last_run_at | string | null | Evet | |
run_count | integer | Evet | |
error | string | null | Evet | |
created_by | string | null | Evet | |
started_at | string | null | Evet | |
completed_at | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
estimated_recipients | integer | null | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].labels | array<string> | Evet | |
data[].category | string | null | Evet | |
data[].ab_test | object | Evet | |
data[].ab_test.enabled | boolean | Hayır | |
data[].ab_test.test_percentage | integer | Hayır | Aralık: 1–100 |
data[].ab_test.winner | object | Hayır | |
data[].ab_test.phase | enum | Hayır | Değerler: "testing", "winner_sent" |
data[].ab_test.winner_variant_id | string | Hayır | |
data[].ab_test.decided_at | string | Hayır | |
data[].ab_test.decided_by | string | Hayır | |
data[].ab_test.significance | object | Hayır | |
data[].variants | array<object> | Evet | |
data[].variants[].id | string | Evet | |
data[].variants[].name | string | Evet | |
data[].variants[].weight_percent | integer | Evet | |
data[].variants[].content | map<string, any> | null | Evet | |
data[].variants[].is_control | boolean | Evet | |
data[].variants[].position | integer | Evet | |
data[].type | enum | Evet | Değerler: "one_time", "scheduled", "recurring", "automated", "transactional" |
data[].status | enum | Evet | Değerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
data[].audience | map<string, any> | Evet | |
data[].content | map<string, any> | Evet | |
data[].template_id | string | null | Evet | |
data[].template_version | integer | null | Evet | |
data[].delivery | object | Evet | |
data[].delivery.timezone_mode | enum | Hayır | Değerler: "immediate", "per_user_timezone", "optimized" |
data[].delivery.delivery_time_of_day | string | Hayır | |
data[].delivery.throttle_per_minute | integer | Hayır | Aralık: 1–1000000 |
data[].delivery.ttl | integer | Hayır | Aralık: 60–2419200 |
data[].delivery.priority | 5 | 10 | Hayır | |
data[].delivery.collapse_id | string | Hayır | Uzunluk: 0–64 |
data[].delivery.frequency_cap_exempt | boolean | Hayır | |
data[].delivery.quiet_hours_exempt | boolean | Hayır | |
data[].delivery.one_per_user | boolean | Hayır | |
data[].recurrence | object | null | Evet | |
data[].approval | object | Evet | |
data[].approval.required | boolean | Evet | |
data[].approval.pending_action | enum | Hayır | Değerler: "send", "schedule" |
data[].approval.requested_by | string | Hayır | |
data[].approval.requested_at | string | Hayır | |
data[].approval.approved_by | string | Hayır | |
data[].approval.approved_at | string | Hayır | |
data[].approval.rejected_by | string | Hayır | |
data[].approval.rejected_at | string | Hayır | |
data[].stats | object | Evet | |
data[].stats.runs | integer | Hayır | |
data[].stats.targeted | integer | Hayır | |
data[].stats.suppressed | integer | Hayır | |
data[].stats.sent | integer | Hayır | |
data[].stats.delivered | integer | Hayır | |
data[].stats.failed | integer | Hayır | |
data[].stats.opened | integer | Hayır | |
data[].stats.clicked | integer | Hayır | |
data[].stats.converted | integer | Hayır | |
data[].stats.bounced | integer | Hayır | |
data[].stats.complained | integer | Hayır | |
data[].stats.unsubscribed | integer | Hayır | |
data[].stats.sms_segments | integer | Hayır | |
data[].send_at | string | null | Evet | |
data[].next_run_at | string | null | Evet | |
data[].last_run_at | string | null | Evet | |
data[].run_count | integer | Evet | |
data[].error | string | null | Evet | |
data[].created_by | string | null | Evet | |
data[].started_at | string | null | Evet | |
data[].completed_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
data[].estimated_recipients | integer | null | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns
CampaignStats
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
campaign | object | Evet | |
campaign.id | string | Evet | |
campaign.app_id | string | Evet | |
campaign.name | string | Evet | |
campaign.labels | array<string> | Evet | |
campaign.category | string | null | Evet | |
campaign.ab_test | object | Evet | |
campaign.ab_test.enabled | boolean | Hayır | |
campaign.ab_test.test_percentage | integer | Hayır | Aralık: 1–100 |
campaign.ab_test.winner | object | Hayır | |
campaign.ab_test.phase | enum | Hayır | Değerler: "testing", "winner_sent" |
campaign.ab_test.winner_variant_id | string | Hayır | |
campaign.ab_test.decided_at | string | Hayır | |
campaign.ab_test.decided_by | string | Hayır | |
campaign.ab_test.significance | object | Hayır | |
campaign.variants | array<object> | Evet | |
campaign.variants[].id | string | Evet | |
campaign.variants[].name | string | Evet | |
campaign.variants[].weight_percent | integer | Evet | |
campaign.variants[].content | map<string, any> | null | Evet | |
campaign.variants[].is_control | boolean | Evet | |
campaign.variants[].position | integer | Evet | |
campaign.type | enum | Evet | Değerler: "one_time", "scheduled", "recurring", "automated", "transactional" |
campaign.status | enum | Evet | Değerler: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
campaign.audience | map<string, any> | Evet | |
campaign.content | map<string, any> | Evet | |
campaign.template_id | string | null | Evet | |
campaign.template_version | integer | null | Evet | |
campaign.delivery | object | Evet | |
campaign.delivery.timezone_mode | enum | Hayır | Değerler: "immediate", "per_user_timezone", "optimized" |
campaign.delivery.delivery_time_of_day | string | Hayır | |
campaign.delivery.throttle_per_minute | integer | Hayır | Aralık: 1–1000000 |
campaign.delivery.ttl | integer | Hayır | Aralık: 60–2419200 |
campaign.delivery.priority | 5 | 10 | Hayır | |
campaign.delivery.collapse_id | string | Hayır | Uzunluk: 0–64 |
campaign.delivery.frequency_cap_exempt | boolean | Hayır | |
campaign.delivery.quiet_hours_exempt | boolean | Hayır | |
campaign.delivery.one_per_user | boolean | Hayır | |
campaign.recurrence | object | null | Evet | |
campaign.approval | object | Evet | |
campaign.approval.required | boolean | Evet | |
campaign.approval.pending_action | enum | Hayır | Değerler: "send", "schedule" |
campaign.approval.requested_by | string | Hayır | |
campaign.approval.requested_at | string | Hayır | |
campaign.approval.approved_by | string | Hayır | |
campaign.approval.approved_at | string | Hayır | |
campaign.approval.rejected_by | string | Hayır | |
campaign.approval.rejected_at | string | Hayır | |
campaign.stats | object | Evet | |
campaign.stats.runs | integer | Hayır | |
campaign.stats.targeted | integer | Hayır | |
campaign.stats.suppressed | integer | Hayır | |
campaign.stats.sent | integer | Hayır | |
campaign.stats.delivered | integer | Hayır | |
campaign.stats.failed | integer | Hayır | |
campaign.stats.opened | integer | Hayır | |
campaign.stats.clicked | integer | Hayır | |
campaign.stats.converted | integer | Hayır | |
campaign.stats.bounced | integer | Hayır | |
campaign.stats.complained | integer | Hayır | |
campaign.stats.unsubscribed | integer | Hayır | |
campaign.stats.sms_segments | integer | Hayır | |
campaign.send_at | string | null | Evet | |
campaign.next_run_at | string | null | Evet | |
campaign.last_run_at | string | null | Evet | |
campaign.run_count | integer | Evet | |
campaign.error | string | null | Evet | |
campaign.created_by | string | null | Evet | |
campaign.started_at | string | null | Evet | |
campaign.completed_at | string | null | Evet | |
campaign.created_at | string | Evet | |
campaign.updated_at | string | Evet | |
campaign.estimated_recipients | integer | null | Evet | |
rates | object | Evet | |
rates.delivery_rate | number | null | Evet | |
rates.open_rate | number | null | Evet | |
rates.click_rate | number | null | Evet | |
rates.failure_rate | number | null | Evet | |
rates.conversion_rate | number | null | Evet | |
channels | array<object> | Evet | |
channels[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
channels[].targeted | integer | Evet | |
channels[].sent | integer | Evet | |
channels[].failed | integer | Evet | |
channels[].opened | integer | Evet | |
channels[].clicked | integer | Evet | |
hourly | array<object> | Evet | |
hourly[].hour | string | Evet | |
hourly[].sent | integer | Evet | |
hourly[].failed | integer | Evet | |
hourly[].opened | integer | Evet | |
hourly[].clicked | integer | Evet | |
errors | array<object> | Evet | |
errors[].code | string | Evet | |
errors[].count | integer | Evet | |
messages | array<object> | Evet | |
messages[].id | string | Evet | |
messages[].app_id | string | Evet | |
messages[].source | enum | Evet | Değerler: "campaign", "api", "journey", "test" |
messages[].status | enum | Evet | Değerler: "queued", "processing", "completed", "cancelled", "failed" |
messages[].idempotency_key | string | null | Evet | |
messages[].name | string | null | Evet | |
messages[].content | map<string, any> | Evet | |
messages[].target | map<string, any> | Evet | |
messages[].options | map<string, any> | Evet | |
messages[].labels | array<string> | Evet | |
messages[].category | string | null | Evet | |
messages[].template_id | string | null | Evet | |
messages[].campaign_id | string | null | Evet | |
messages[].variants | array<object> | null | Evet | |
messages[].counts | object | Evet | |
messages[].counts.targeted | integer | Hayır | |
messages[].counts.suppressed | integer | Hayır | |
messages[].counts.sent | integer | Hayır | |
messages[].counts.delivered | integer | Hayır | |
messages[].counts.failed | integer | Hayır | |
messages[].counts.errored | integer | Hayır | |
messages[].counts.expired | integer | Hayır | |
messages[].counts.opened | integer | Hayır | |
messages[].counts.clicked | integer | Hayır | |
messages[].counts.converted | integer | Hayır | |
messages[].counts.bounced | integer | Hayır | |
messages[].counts.complained | integer | Hayır | |
messages[].counts.unsubscribed | integer | Hayır | |
messages[].counts.sms_segments | integer | Hayır | |
messages[].requested_by | object | Evet | |
messages[].requested_by.type | enum | Evet | Değerler: "api_key", "account", "system" |
messages[].requested_by.id | string | Hayır | |
messages[].error | string | null | Evet | |
messages[].scheduled_for | string | null | Evet | |
messages[].started_at | string | null | Evet | |
messages[].completed_at | string | null | Evet | |
messages[].created_at | string | Evet | |
messages[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns/{campaignId}/stats
CampaignVariantStats
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ab_test | object | Evet | |
ab_test.enabled | boolean | Hayır | |
ab_test.test_percentage | integer | Hayır | Aralık: 1–100 |
ab_test.winner | object | Hayır | |
ab_test.winner.mode | enum | Evet | Değerler: "manual", "auto" |
ab_test.winner.metric | enum | Evet | Değerler: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | Hayır | Aralık: 5–10080 |
ab_test.phase | enum | Hayır | Değerler: "testing", "winner_sent" |
ab_test.winner_variant_id | string | Hayır | |
ab_test.decided_at | string | Hayır | |
ab_test.decided_by | string | Hayır | |
ab_test.significance | object | Hayır | |
ab_test.significance.p_value | number | Evet | |
ab_test.significance.significant | boolean | Evet | |
ab_test.significance.metric | string | Evet | |
variants | array<object> | Evet | |
variants[].variant_id | string | Evet | |
variants[].name | string | Evet | |
variants[].weight_percent | integer | Evet | |
variants[].is_control | boolean | Evet | |
variants[].targeted | integer | Evet | |
variants[].sent | integer | Evet | |
variants[].delivered | integer | Evet | |
variants[].opened | integer | Evet | |
variants[].clicked | integer | Evet | |
variants[].converted | integer | Evet | |
variants[].holdout | integer | Evet | |
variants[].open_rate | number | Evet | |
variants[].click_rate | number | Evet | |
variants[].conversion_rate | number | Evet | |
leader | string | null | Evet | |
significance | object | Evet | |
significance.p_value | number | Evet | |
significance.significant | boolean | Evet | |
significance.metric | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/campaigns/{campaignId}/variants/stats
CellHandoff
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet | |
expires_at | string | Evet |
CellHandoffResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
account | object | Evet | |
account.id | string | Evet | |
account.email | string | Evet | |
account.name | string | Evet | |
account.locale | string | Evet | |
account.timezone | string | Evet | |
account.email_verified | boolean | Evet | |
account.mfa_enabled | boolean | Evet | |
account.is_platform_admin | boolean | Evet | |
account.has_password | boolean | Evet | |
account.marketing_opt_in | boolean | Evet | |
account.created_at | string | Evet | |
next | string | null | Evet |
CellList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
enabled | boolean | Evet | |
current_cell_id | string | null | Evet | |
control_plane | boolean | Evet | |
control_plane_dashboard_url | string | null | Evet | |
cells | array<object> | Evet | |
cells[].id | string | Evet | |
cells[].name | string | Evet | |
cells[].api_url | string | Evet | |
cells[].dashboard_url | string | Evet |
CellOrgList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].slug | string | Evet | |
data[].role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
data[].region | string | null | Evet | |
data[].dashboard_url | string | null | Evet | |
data[].local | boolean | Evet | |
unavailable_cells | array<string> | Evet |
ChannelConfig
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
provider | enum | null | Evet | |
status | enum | Evet | Değerler: "unconfigured", "active", "invalid", "suspended" |
config | object | Evet | |
config.auth_type | enum | Hayır | Değerler: "token", "certificate" |
config.certificate_environment | enum | Hayır | Değerler: "sandbox", "production", "universal" |
config.certificate_subject | string | Hayır | |
config.certificate_expires_at | string | Hayır | |
config.key_id | string | Hayır | |
config.team_id | string | Hayır | |
config.bundle_id | string | Hayır | |
config.environment | enum | Hayır | Değerler: "sandbox", "production" |
config.project_id | string | Hayır | |
config.client_email | string | Hayır | |
config.hms_app_id | string | Hayır | |
config.high_priority | boolean | Hayır | |
config.subject | string | Hayır | |
config.vapid_public_key | string | Hayır | |
config.site_url | string | Hayır | |
config.from_address | string | Hayır | |
config.from_name | string | Hayır | |
config.reply_to | string | Hayır | |
config.dkim_selector | string | Hayır | |
config.postal_address | string | Hayır | |
config.host | string | Hayır | |
config.port | integer | Hayır | |
config.secure | boolean | Hayır | |
config.username | string | Hayır | |
config.region | string | Hayır | |
config.access_key_id | string | Hayır | |
config.configuration_set | string | Hayır | |
config.account_sid | string | Hayır | |
config.from_number | string | Hayır | |
config.messaging_service_sid | string | Hayır | |
config.usercode | string | Hayır | |
config.msgheader | string | Hayır | |
config.iys_filter | enum | Hayır | Değerler: "0", "11", "12" |
config.waba_id | string | Hayır | |
config.phone_number_id | string | Hayır | |
config.graph_api_version | string | Hayır | |
config.display_phone_number | string | Hayır | |
config.verified_name | string | Hayır | |
config.rbm_agent_id | string | Hayır | |
config.content_sid | string | Hayır | |
config.sms_fallback | boolean | Hayır | |
has_secret | boolean | Evet | |
has_hook | boolean | Evet | |
last_validated_at | string | null | Evet | |
last_error | string | null | Evet | |
updated_at | string | null | Evet | |
suspended_reason | string | null | Evet | |
dns_check | object | null | Evet |
Kullanıldığı işlemler: PUT /v1/apps/{appId}/channels/{channel}
ChannelHook
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | null | Evet | |
provider | string | Evet | |
polling | boolean | Evet | |
events | array<string> | Evet | |
verify_token | string | null | Hayır |
ChannelList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
data[].provider | enum | null | Evet | |
data[].status | enum | Evet | Değerler: "unconfigured", "active", "invalid", "suspended" |
data[].config | object | Evet | |
data[].config.auth_type | enum | Hayır | Değerler: "token", "certificate" |
data[].config.certificate_environment | enum | Hayır | Değerler: "sandbox", "production", "universal" |
data[].config.certificate_subject | string | Hayır | |
data[].config.certificate_expires_at | string | Hayır | |
data[].config.key_id | string | Hayır | |
data[].config.team_id | string | Hayır | |
data[].config.bundle_id | string | Hayır | |
data[].config.environment | enum | Hayır | Değerler: "sandbox", "production" |
data[].config.project_id | string | Hayır | |
data[].config.client_email | string | Hayır | |
data[].config.hms_app_id | string | Hayır | |
data[].config.high_priority | boolean | Hayır | |
data[].config.subject | string | Hayır | |
data[].config.vapid_public_key | string | Hayır | |
data[].config.site_url | string | Hayır | |
data[].config.from_address | string | Hayır | |
data[].config.from_name | string | Hayır | |
data[].config.reply_to | string | Hayır | |
data[].config.dkim_selector | string | Hayır | |
data[].config.postal_address | string | Hayır | |
data[].config.host | string | Hayır | |
data[].config.port | integer | Hayır | |
data[].config.secure | boolean | Hayır | |
data[].config.username | string | Hayır | |
data[].config.region | string | Hayır | |
data[].config.access_key_id | string | Hayır | |
data[].config.configuration_set | string | Hayır | |
data[].config.account_sid | string | Hayır | |
data[].config.from_number | string | Hayır | |
data[].config.messaging_service_sid | string | Hayır | |
data[].config.usercode | string | Hayır | |
data[].config.msgheader | string | Hayır | |
data[].config.iys_filter | enum | Hayır | Değerler: "0", "11", "12" |
data[].config.waba_id | string | Hayır | |
data[].config.phone_number_id | string | Hayır | |
data[].config.graph_api_version | string | Hayır | |
data[].config.display_phone_number | string | Hayır | |
data[].config.verified_name | string | Hayır | |
data[].config.rbm_agent_id | string | Hayır | |
data[].config.content_sid | string | Hayır | |
data[].config.sms_fallback | boolean | Hayır | |
data[].has_secret | boolean | Evet | |
data[].has_hook | boolean | Evet | |
data[].last_validated_at | string | null | Evet | |
data[].last_error | string | null | Evet | |
data[].updated_at | string | null | Evet | |
data[].suspended_reason | string | null | Evet | |
data[].dns_check | object | null | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/channels
ChannelStatusList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].channel | string | Evet | |
data[].provider | string | null | Evet | |
data[].status | string | Evet |
ChannelValidation
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | boolean | Evet | |
kind | enum | null | Evet | |
code | string | null | Evet | |
message | string | null | Evet | |
details | map<string, any> | null | Evet | |
channel | object | Evet | |
channel.channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
channel.provider | enum | null | Evet | |
channel.status | enum | Evet | Değerler: "unconfigured", "active", "invalid", "suspended" |
channel.config | object | Evet | |
channel.config.auth_type | enum | Hayır | Değerler: "token", "certificate" |
channel.config.certificate_environment | enum | Hayır | Değerler: "sandbox", "production", "universal" |
channel.config.certificate_subject | string | Hayır | |
channel.config.certificate_expires_at | string | Hayır | |
channel.config.key_id | string | Hayır | |
channel.config.team_id | string | Hayır | |
channel.config.bundle_id | string | Hayır | |
channel.config.environment | enum | Hayır | Değerler: "sandbox", "production" |
channel.config.project_id | string | Hayır | |
channel.config.client_email | string | Hayır | |
channel.config.hms_app_id | string | Hayır | |
channel.config.high_priority | boolean | Hayır | |
channel.config.subject | string | Hayır | |
channel.config.vapid_public_key | string | Hayır | |
channel.config.site_url | string | Hayır | |
channel.config.from_address | string | Hayır | |
channel.config.from_name | string | Hayır | |
channel.config.reply_to | string | Hayır | |
channel.config.dkim_selector | string | Hayır | |
channel.config.postal_address | string | Hayır | |
channel.config.host | string | Hayır | |
channel.config.port | integer | Hayır | |
channel.config.secure | boolean | Hayır | |
channel.config.username | string | Hayır | |
channel.config.region | string | Hayır | |
channel.config.access_key_id | string | Hayır | |
channel.config.configuration_set | string | Hayır | |
channel.config.account_sid | string | Hayır | |
channel.config.from_number | string | Hayır | |
channel.config.messaging_service_sid | string | Hayır | |
channel.config.usercode | string | Hayır | |
channel.config.msgheader | string | Hayır | |
channel.config.iys_filter | enum | Hayır | Değerler: "0", "11", "12" |
channel.config.waba_id | string | Hayır | |
channel.config.phone_number_id | string | Hayır | |
channel.config.graph_api_version | string | Hayır | |
channel.config.display_phone_number | string | Hayır | |
channel.config.verified_name | string | Hayır | |
channel.config.rbm_agent_id | string | Hayır | |
channel.config.content_sid | string | Hayır | |
channel.config.sms_fallback | boolean | Hayır | |
channel.has_secret | boolean | Evet | |
channel.has_hook | boolean | Evet | |
channel.last_validated_at | string | null | Evet | |
channel.last_error | string | null | Evet | |
channel.updated_at | string | null | Evet | |
channel.suspended_reason | string | null | Evet | |
channel.dns_check | object | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/channels/{channel}/validate
CheckoutResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet | |
session_id | string | Evet |
CleanupResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
deleted | integer | Evet |
ContentTable
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
key_column | string | Evet | |
columns | array<string> | Evet | |
row_count | integer | Evet | |
version | integer | Evet | |
source_file_name | string | null | Evet | |
liquid | string | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].key_column | string | Evet | |
data[].columns | array<string> | Evet | |
data[].row_count | integer | Evet | |
data[].version | integer | Evet | |
data[].source_file_name | string | null | Evet | |
data[].liquid | string | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/content-tables
ContentTableRows
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
columns | array<string> | Evet | |
key_column | string | Evet | |
total | integer | Evet | |
data | array<map<string, string>> | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/content-tables/{tableId}/rows
Conversation
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
channel | enum | Evet | Değerler: "sms", "whatsapp", "rcs" |
status | enum | Evet | Değerler: "open", "closed" |
subscription_id | string | Evet | |
subscription_status | string | Evet | |
user_id | string | null | Evet | |
external_id | string | null | Evet | |
contact | string | Evet | |
opted_in | boolean | Evet | |
last_message_at | string | Evet | |
last_inbound_at | string | null | Evet | |
last_direction | enum | null | Evet | |
last_message_preview | string | null | Evet | |
unread_count | integer | Evet | |
window | object | null | Evet | |
created_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations/{conversationId}, POST /v1/apps/{appId}/conversations/{conversationId}/read
ConversationMessagePage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].direction | enum | Evet | Değerler: "inbound", "outbound" |
data[].status | string | Evet | |
data[].body | string | null | Evet | |
data[].content | map<string, any> | Evet | |
data[].message_id | string | null | Evet | |
data[].delivery_id | string | null | Evet | |
data[].sent_by | string | null | Evet | |
data[].error_code | string | null | Evet | |
data[].read_at | string | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations/{conversationId}/messages
ConversationPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].channel | enum | Evet | Değerler: "sms", "whatsapp", "rcs" |
data[].status | enum | Evet | Değerler: "open", "closed" |
data[].subscription_id | string | Evet | |
data[].subscription_status | string | Evet | |
data[].user_id | string | null | Evet | |
data[].external_id | string | null | Evet | |
data[].contact | string | Evet | |
data[].opted_in | boolean | Evet | |
data[].last_message_at | string | Evet | |
data[].last_inbound_at | string | null | Evet | |
data[].last_direction | enum | null | Evet | |
data[].last_message_preview | string | null | Evet | |
data[].unread_count | integer | Evet | |
data[].window | object | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/conversations
ConversationReplyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
text | string | Hayır | Uzunluk: 1–4096 |
template | object | Hayır | |
template.name | string | Evet | |
template.language | string | Evet | |
template.header | object | Hayır | |
template.body_params | array<string> | Hayır | Öğe: 0–20 |
template.button_params | array<object> | Hayır | Öğe: 0–10 |
template.button_params[].index | integer | Evet | Aralık: 0–9 |
template.button_params[].sub_type | enum | Evet | Değerler: "url", "quick_reply", "copy_code" |
template.button_params[].value | string | Evet | Uzunluk: 1–256 |
media | object | Hayır | |
media.type | enum | Evet | Değerler: "image", "video", "document", "audio" |
media.url | string (url) | Evet | Uzunluk: 0–2000 |
media.filename | string | Hayır | Uzunluk: 1–240 |
interactive | object | Hayır | |
interactive.type | enum | Evet | Değerler: "button", "list" |
interactive.header | string | Hayır | Uzunluk: 1–60 |
interactive.footer | string | Hayır | Uzunluk: 1–60 |
interactive.buttons | array<object> | Hayır | Öğe: 1–3 |
interactive.buttons[].id | string | Evet | Uzunluk: 1–256 |
interactive.buttons[].title | string | Evet | Uzunluk: 1–20 |
interactive.list | object | Hayır | |
interactive.list.button | string | Evet | Uzunluk: 1–20 |
interactive.list.sections | array<object> | Evet | Öğe: 1–10 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/conversations/{conversationId}/messages
ConversationReplyResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
message_id | string | Evet | |
conversation_message | object | Evet | |
conversation_message.id | string | Evet | |
conversation_message.direction | enum | Evet | Değerler: "inbound", "outbound" |
conversation_message.status | string | Evet | |
conversation_message.body | string | null | Evet | |
conversation_message.content | map<string, any> | Evet | |
conversation_message.message_id | string | null | Evet | |
conversation_message.delivery_id | string | null | Evet | |
conversation_message.sent_by | string | null | Evet | |
conversation_message.error_code | string | null | Evet | |
conversation_message.read_at | string | null | Evet | |
conversation_message.created_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/conversations/{conversationId}/messages
ConversionsReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
totals | object | Evet | |
totals.conversions | integer | Evet | |
totals.direct | integer | Evet | |
totals.influenced | integer | Evet | |
totals.unattributed | integer | Evet | |
totals.revenue | number | Evet | |
previous | object | null | Evet | |
by_campaign | array<object> | Evet | |
by_campaign[].campaign_id | string | null | Evet | |
by_campaign[].name | string | Evet | |
by_campaign[].conversions | integer | Evet | |
by_campaign[].direct | integer | Evet | |
by_campaign[].influenced | integer | Evet | |
by_campaign[].unattributed | integer | Evet | |
by_campaign[].revenue | number | Evet | |
by_campaign[].sent | integer | Evet | |
by_campaign[].conversion_rate | number | null | Evet | |
rows | array<object> | Evet | |
rows[].date | string | Evet | |
rows[].conversions | integer | Evet | |
rows[].revenue | number | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/conversions
CopyTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
target_app_id | string | Evet | Uzunluk: 1–64 |
name | string | Hayır | Uzunluk: 2–100 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/copy_to_app
CreateAppApiKeyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 2–100 |
scopes | array<enum> | Evet | Öğe: 1–8 |
environment | enum | Hayır | Değerler: "live", "test"; Varsayılan: "live" |
expires_at | string (date-time) | null | Hayır | |
ip_allowlist | array<string> | Hayır | Öğe: 0–50 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/api-keys
CreateAppDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 2–100 |
slug | string | Hayır | |
platform_flags | object | Hayır | Varsayılan: {} |
platform_flags.ios | boolean | Hayır | |
platform_flags.android | boolean | Hayır | |
platform_flags.web | boolean | Hayır | |
platform_flags.email | boolean | Hayır | |
platform_flags.sms | boolean | Hayır | |
default_language | string | Hayır | Varsayılan: "en"; Uzunluk: 2–10 |
timezone | string | Hayır | Varsayılan: "UTC"; Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/apps
CreateCategoryDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
key | string | Evet | Uzunluk: 1–64 |
name | map<string, string> | Evet | |
description | map<string, string> | Hayır | |
channels | array<enum> | null | Hayır | |
default_opted_in | boolean | Hayır | |
position | integer | Hayır | Aralık: 0–1000 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/categories
CreatedApiKey
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
org_id | string | Evet | |
app_id | string | null | Evet | |
name | string | Evet | |
prefix | string | Evet | |
scopes | array<string> | Evet | |
last_used_at | string | null | Evet | |
expires_at | string | null | Evet | |
revoked_at | string | null | Evet | |
ip_allowlist | array<string> | Evet | |
rotated_at | string | null | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet | |
key | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/api-keys, POST /v1/apps/{appId}/api-keys/{keyId}/rotate
CreateDataFeedDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 1–64 |
description | string | null | Hayır | |
url_template | string | Evet | Uzunluk: 1–2048 |
method | enum | Hayır | Değerler: "GET", "POST" |
body_template | string | null | Hayır | |
headers | map<string, string> | Hayır | |
secret_headers | map<string, string> | Hayır | |
cache_ttl_seconds | integer | Hayır | Aralık: 0–86400 |
timeout_ms | integer | Hayır | Aralık: 100–2000 |
enabled | boolean | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds
CreateExportDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
type | enum | Evet | Değerler: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | Hayır | Varsayılan: {} |
filters.from | string (date-time) | Hayır | |
filters.to | string (date-time) | Hayır | |
filters.name | string | Hayır | Uzunluk: 0–100 |
filters.message_id | string | Hayır | Uzunluk: 0–64 |
filters.campaign_id | string | Hayır | Uzunluk: 0–64 |
filters.status | string | Hayır | Uzunluk: 0–32 |
filters.channel | enum | Hayır | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
filters.segment_id | string | Hayır | Uzunluk: 0–64 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/exports
CreateIdentityKeyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
kid | string | Hayır | Uzunluk: 1–64 |
label | string | Hayır | Uzunluk: 0–80 |
public_jwk | map<string, any> | Hayır | |
public_key_pem | string | Hayır | Uzunluk: 0–4000 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/identity-keys
CreateInAppDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 2–100 |
triggers | array<object> | Evet | Öğe: 1–5 |
trigger_groups | array<array<object>> | Hayır | Öğe: 1–10 |
variants | array<object> | Hayır | Öğe: 0–10 |
variants[].id | string | Evet | Uzunluk: 1–64 |
variants[].name | string | Evet | Uzunluk: 1–60 |
variants[].weight_percent | integer | Evet | Aralık: 1–99 |
variants[].display | object | Evet | |
variants[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | Hayır | |
variants[].display.text_color | string | Hayır | |
variants[].display.dismissible | boolean | Hayır | |
variants[].display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
variants[].display.content_type | enum | Hayır | Değerler: "blocks", "html" |
variants[].display.html | map<string, string> | Hayır | |
variants[].display.html_height | integer | Hayır | Aralık: 40–2000 |
variants[].display.blocks | array<object> | Evet | Öğe: 0–12 |
ab_test | object | Hayır | |
ab_test.winner | object | Hayır | |
ab_test.winner.mode | enum | Evet | Değerler: "manual", "auto" |
ab_test.winner.min_impressions | integer | Hayır | Aralık: 10–1000000 |
ab_test.winner.confidence | number | Hayır | Aralık: 0.8–0.99 |
display | object | Evet | |
display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | Hayır | |
display.text_color | string | Hayır | |
display.dismissible | boolean | Hayır | |
display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
display.content_type | enum | Hayır | Değerler: "blocks", "html" |
display.html | map<string, string> | Hayır | |
display.html_height | integer | Hayır | Aralık: 40–2000 |
display.blocks | array<object> | Evet | Öğe: 0–12 |
audience | object | Hayır | |
audience.included_segments | array<string> | Hayır | Öğe: 0–20 |
audience.excluded_segments | array<string> | Hayır | Öğe: 0–20 |
frequency | object | Hayır | |
frequency.max_impressions | integer | Hayır | Aralık: 1–1000 |
frequency.min_interval_seconds | integer | Hayır | Aralık: 0–31536000 |
frequency.stop_after_interaction | boolean | Hayır | |
journey_only | boolean | Hayır | |
priority | integer | Hayır | Aralık: 0–100 |
start_at | string (date-time) | null | Hayır | |
end_at | string (date-time) | null | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages
CreateKeywordDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
keyword | string | Evet | Uzunluk: 1–30 |
scope | enum | Hayır | Değerler: "org", "app" |
channels | array<enum> | Hayır | Öğe: 1–3 |
actions | object | Evet | |
actions.add_tags | map<string, string> | Hayır | |
actions.remove_tags | array<string> | Hayır | Öğe: 0–50 |
actions.event | object | Hayır | |
actions.event.name | string | Evet | |
actions.event.properties | map<string, string> | Hayır | |
actions.reply | object | Hayır | |
actions.reply.text | string | Evet | Uzunluk: 1–1600 |
actions.opt_in | boolean | Hayır | |
enabled | boolean | Hayır | |
description | string | Hayır | Uzunluk: 0–300 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/sms-keywords
CreateLiveActivityTypeDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 1–100 |
description | string | Hayır | Uzunluk: 0–300 |
content_state_schema | object | Evet | |
content_state_schema.type | "object" | Evet | |
content_state_schema.properties | map<string, object> | Evet | |
content_state_schema.required | array<string> | Hayır | Öğe: 0–50 |
attributes_schema | object | Hayır | |
attributes_schema.type | "object" | Evet | |
attributes_schema.properties | map<string, object> | Evet | |
attributes_schema.required | array<string> | Hayır | Öğe: 0–50 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/types
CreateNotificationDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
app_id | string | Hayır | Uzunluk: 1–∞ |
idempotency_key | string | Hayır | Uzunluk: 1–255 |
target | object | Evet | |
target.all | boolean | Hayır | |
target.include_subscription_ids | array<string> | Hayır | Öğe: 0–2000 |
target.include_external_ids | array<string> | Hayır | Öğe: 0–2000 |
target.include_aliases | map<string, array<string>> | Hayır | |
target.included_segments | array<string> | Hayır | Öğe: 0–50 |
target.excluded_segments | array<string> | Hayır | Öğe: 0–50 |
target.filters | any | Hayır | |
target.channels | array<enum> | Hayır | Öğe: 1–∞ |
target.test_devices_only | boolean | Hayır | |
target.email_to | array<string> | Hayır | Öğe: 1–2000 |
target.include_phone_numbers | array<string> | Hayır | Öğe: 1–2000 |
headings | map<string, string> | Hayır | |
contents | map<string, string> | Hayır | |
subtitle | map<string, string> | Hayır | |
url | string (url) | Hayır | Uzunluk: 0–2000 |
app_url | string (url) | Hayır | Uzunluk: 0–2000 |
data | map<string, string> | Hayır | |
buttons | array<object> | Hayır | Öğe: 0–3 |
buttons[].id | string | Evet | Uzunluk: 1–64 |
buttons[].text | string | Evet | Uzunluk: 1–100 |
buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
big_picture | string (url) | Hayır | Uzunluk: 0–2000 |
ios_attachments | map<string, string (url)> | Hayır | |
ios_sound | string | Hayır | Uzunluk: 0–100 |
ios_badge_type | enum | Hayır | Değerler: "None", "SetTo", "Increase" |
ios_badge_count | integer | Hayır | Aralık: 0–99999 |
ios_interruption_level | enum | Hayır | Değerler: "passive", "active", "time-sensitive", "critical" |
ios_category | string | Hayır | Uzunluk: 0–100 |
thread_id | string | Hayır | Uzunluk: 0–100 |
ios_relevance_score | number | Hayır | Aralık: 0–1 |
target_content_identifier | string | Hayır | Uzunluk: 0–200 |
android_channel_id | string | Hayır | Uzunluk: 0–100 |
android_group | string | Hayır | Uzunluk: 0–100 |
android_sound | string | Hayır | Uzunluk: 0–100 |
small_icon | string | Hayır | Uzunluk: 0–100 |
large_icon | string (url) | string | Hayır | |
android_accent_color | string | Hayır | |
android_visibility | 1 | 0 | -1 | Hayır | |
chrome_web_icon | string (url) | Hayır | Uzunluk: 0–2000 |
chrome_web_image | string (url) | Hayır | Uzunluk: 0–2000 |
chrome_web_badge | string (url) | Hayır | Uzunluk: 0–2000 |
web_push_topic | string | Hayır | Uzunluk: 0–32 |
web_buttons | array<object> | Hayır | Öğe: 0–2 |
web_buttons[].id | string | Evet | Uzunluk: 1–64 |
web_buttons[].text | string | Evet | Uzunluk: 1–100 |
web_buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
web_buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
require_interaction | boolean | Hayır | |
content_available | boolean | Hayır | |
mutable_content | boolean | Hayır | |
collapse_id | string | Hayır | Uzunluk: 0–64 |
priority | 5 | 10 | Hayır | |
ttl | integer | Hayır | Aralık: 60–2419200 |
send_after | string (date-time) | Hayır | |
delayed_option | enum | Hayır | Değerler: "timezone", "optimized" |
delivery_time_of_day | string | Hayır | |
template_id | string | Hayır | |
custom_data | map<string, any> | Hayır | |
email_subject | string | Hayır | Uzunluk: 0–998 |
email_body | string | Hayır | Uzunluk: 0–500000 |
email_mjml | string | Hayır | Uzunluk: 0–500000 |
email_preheader | string | Hayır | Uzunluk: 0–500 |
email_from_name | string | Hayır | Uzunluk: 0–200 |
email_from_address | string (email) | Hayır | Uzunluk: 0–320 |
email_reply_to_address | string (email) | Hayır | Uzunluk: 0–320 |
disable_email_click_tracking | boolean | Hayır | |
sms_from | string | Hayır | Uzunluk: 1–20 |
sms_media_urls | array<string (url)> | Hayır | Öğe: 1–10 |
disable_sms_link_shortening | boolean | Hayır | |
whatsapp_template | object | Hayır | |
whatsapp_template.name | string | Evet | |
whatsapp_template.language | string | Evet | |
whatsapp_template.header | object | Hayır | |
whatsapp_template.body_params | array<string> | Hayır | Öğe: 0–20 |
whatsapp_template.button_params | array<object> | Hayır | Öğe: 0–10 |
whatsapp_template.button_params[].index | integer | Evet | Aralık: 0–9 |
whatsapp_template.button_params[].sub_type | enum | Evet | Değerler: "url", "quick_reply", "copy_code" |
whatsapp_template.button_params[].value | string | Evet | Uzunluk: 1–256 |
whatsapp_media | object | Hayır | |
whatsapp_media.type | enum | Evet | Değerler: "image", "video", "document", "audio" |
whatsapp_media.url | string (url) | Evet | Uzunluk: 0–2000 |
whatsapp_media.filename | string | Hayır | Uzunluk: 1–240 |
whatsapp_interactive | object | Hayır | |
whatsapp_interactive.type | enum | Evet | Değerler: "button", "list" |
whatsapp_interactive.header | string | Hayır | Uzunluk: 1–60 |
whatsapp_interactive.footer | string | Hayır | Uzunluk: 1–60 |
whatsapp_interactive.buttons | array<object> | Hayır | Öğe: 1–3 |
whatsapp_interactive.buttons[].id | string | Evet | Uzunluk: 1–256 |
whatsapp_interactive.buttons[].title | string | Evet | Uzunluk: 1–20 |
whatsapp_interactive.list | object | Hayır | |
whatsapp_interactive.list.button | string | Evet | Uzunluk: 1–20 |
whatsapp_interactive.list.sections | array<object> | Evet | Öğe: 1–10 |
rcs_card | object | Hayır | |
rcs_card.title | map<string, string> | Hayır | |
rcs_card.description | map<string, string> | Hayır | |
rcs_card.media_url | string (url) | Hayır | Uzunluk: 0–2000 |
rcs_card.media_height | enum | Hayır | Değerler: "SHORT", "MEDIUM", "TALL" |
rcs_card.orientation | enum | Hayır | Değerler: "VERTICAL", "HORIZONTAL" |
rcs_suggestions | array<object> | Hayır | Öğe: 0–11 |
rcs_content_sid | string | Hayır | |
rcs_content_variables | map<string, string> | Hayır | |
rcs_fallback_text | map<string, string> | Hayır | |
add_to_inbox | boolean | Hayır | |
inbox_ttl | integer | Hayır | Aralık: 60–31536000 |
frequency_cap_exempt | boolean | Hayır | |
quiet_hours_exempt | boolean | Hayır | |
one_per_user | boolean | Hayır | |
throttle_rate_per_minute | integer | Hayır | Aralık: 0–1000000 |
include_unsubscribed | boolean | Hayır | |
name | string | Hayır | Uzunluk: 1–200 |
labels | array<string> | Hayır | Öğe: 0–10 |
category | string | Hayır | Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/notifications
CreateNotificationResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
status | enum | Evet | Değerler: "queued", "processing", "completed", "cancelled", "failed" |
recipients_estimate | integer | Evet | |
external_id_missing | array<string> | Evet |
Kullanıldığı işlemler: POST /v1/notifications
CreateSuppressionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Evet | Değerler: "email", "sms", "whatsapp", "rcs" |
value | string | Evet | Uzunluk: 3–320 |
reason | enum | Hayır | Değerler: "manual", "bounce", "complaint", "unsubscribe_link", "stop" |
expires_at | string (date-time) | Hayır | |
note | string | Hayır | Uzunluk: 0–500 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/suppressions
CreateTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 2–100 |
channel | enum | null | Hayır | |
tags | array<string> | Hayır | Öğe: 0–20 |
content | object | Evet | |
content.headings | map<string, string> | Hayır | |
content.contents | map<string, string> | Hayır | |
content.subtitle | map<string, string> | Hayır | |
content.url | string (url) | Hayır | Uzunluk: 0–2000 |
content.app_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.data | map<string, string> | Hayır | |
content.buttons | array<object> | Hayır | Öğe: 0–3 |
content.buttons[].id | string | Evet | Uzunluk: 1–64 |
content.buttons[].text | string | Evet | Uzunluk: 1–100 |
content.buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.big_picture | string (url) | Hayır | Uzunluk: 0–2000 |
content.ios_attachments | map<string, string (url)> | Hayır | |
content.ios_sound | string | Hayır | Uzunluk: 0–100 |
content.ios_badge_type | enum | Hayır | Değerler: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | Hayır | Aralık: 0–99999 |
content.ios_interruption_level | enum | Hayır | Değerler: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | Hayır | Uzunluk: 0–100 |
content.android_channel_id | string | Hayır | Uzunluk: 0–100 |
content.android_group | string | Hayır | Uzunluk: 0–100 |
content.android_sound | string | Hayır | Uzunluk: 0–100 |
content.chrome_web_icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_image | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_badge | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_push_topic | string | Hayır | Uzunluk: 0–32 |
content.content_available | boolean | Hayır | |
content.mutable_content | boolean | Hayır | |
content.custom_data | map<string, any> | Hayır | |
content.email_subject | string | Hayır | Uzunluk: 0–998 |
content.email_body | string | Hayır | Uzunluk: 0–500000 |
content.email_mjml | string | Hayır | Uzunluk: 0–500000 |
content.email_preheader | string | Hayır | Uzunluk: 0–500 |
content.email_from_name | string | Hayır | Uzunluk: 0–200 |
content.email_from_address | string (email) | Hayır | Uzunluk: 0–320 |
content.email_reply_to_address | string (email) | Hayır | Uzunluk: 0–320 |
content.disable_email_click_tracking | boolean | Hayır | |
content.sms_from | string | Hayır | Uzunluk: 1–20 |
content.disable_sms_link_shortening | boolean | Hayır | |
content.add_to_inbox | boolean | Hayır | |
content.inbox_ttl | integer | Hayır | Aralık: 60–31536000 |
content.thread_id | string | Hayır | Uzunluk: 0–100 |
content.ios_relevance_score | number | Hayır | Aralık: 0–1 |
content.target_content_identifier | string | Hayır | Uzunluk: 0–200 |
content.small_icon | string | Hayır | Uzunluk: 0–100 |
content.large_icon | string (url) | string | Hayır | |
content.android_accent_color | string | Hayır | |
content.android_visibility | 1 | 0 | -1 | Hayır | |
content.web_buttons | array<object> | Hayır | Öğe: 0–2 |
content.web_buttons[].id | string | Evet | Uzunluk: 1–64 |
content.web_buttons[].text | string | Evet | Uzunluk: 1–100 |
content.web_buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.require_interaction | boolean | Hayır | |
content.sms_media_urls | array<string (url)> | Hayır | Öğe: 1–10 |
content.whatsapp_template | object | Hayır | |
content.whatsapp_template.name | string | Evet | |
content.whatsapp_template.language | string | Evet | |
content.whatsapp_template.header | object | Hayır | |
content.whatsapp_template.body_params | array<string> | Hayır | Öğe: 0–20 |
content.whatsapp_template.button_params | array<object> | Hayır | Öğe: 0–10 |
content.whatsapp_media | object | Hayır | |
content.whatsapp_media.type | enum | Evet | Değerler: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Evet | Uzunluk: 0–2000 |
content.whatsapp_media.filename | string | Hayır | Uzunluk: 1–240 |
content.whatsapp_interactive | object | Hayır | |
content.whatsapp_interactive.type | enum | Evet | Değerler: "button", "list" |
content.whatsapp_interactive.header | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.footer | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.buttons | array<object> | Hayır | Öğe: 1–3 |
content.whatsapp_interactive.list | object | Hayır | |
content.rcs_card | object | Hayır | |
content.rcs_card.title | map<string, string> | Hayır | |
content.rcs_card.description | map<string, string> | Hayır | |
content.rcs_card.media_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.rcs_card.media_height | enum | Hayır | Değerler: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | Hayır | Değerler: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | Hayır | Öğe: 0–11 |
content.rcs_content_sid | string | Hayır | |
content.rcs_content_variables | map<string, string> | Hayır | |
content.rcs_fallback_text | map<string, string> | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/templates
CreateWarmupPlanDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 1–100 |
kind | enum | Evet | Değerler: "domain", "ip" |
target | string | Evet | Uzunluk: 2–253 |
start_date | string | Hayır | |
daily_limits | array<integer> | Hayır | Öğe: 1–120 |
curve | object | Hayır | |
curve.start | integer | Evet | Aralık: 1–1000000 |
curve.growth | number | Evet | Aralık: 1.05–3 |
curve.target | integer | Evet | Aralık: 1–10000000 |
provider_shares | object | Hayır | |
provider_shares.gmail | number | Evet | Aralık: 0–1 |
provider_shares.outlook | number | Evet | Aralık: 0–1 |
provider_shares.yahoo | number | Evet | Aralık: 0–1 |
provider_shares.other | number | Evet | Aralık: 0–1 |
timezone | string | Hayır | Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/warmup-plans
CreateWebhookDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet | Uzunluk: 1–2048 |
description | string | null | Hayır | |
events | array<enum> | Evet | Öğe: 1–31 |
event_filters | object | Hayır | |
event_filters.event_names | array<string> | Hayır | Öğe: 0–50 |
batch | boolean | Hayır | |
headers | map<string, string> | Hayır | |
body_template | string | null | Hayır | |
body_content_type | enum | Hayır | Şablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain" |
filters | object | null | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks
CustomDomain
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
kind | enum | Evet | Değerler: "dashboard", "tracking", "preference_center", "status_page" |
hostname | string | Evet | |
status | enum | Evet | Değerler: "pending", "verified", "active", "failed" |
verification | object | Evet | |
verification.txt_name | string | Evet | |
verification.txt_value | string | Evet | |
verification.cname_target | string | null | Evet | |
last_error | string | null | Evet | |
last_checked_at | string | null | Evet | |
verified_at | string | null | Evet | |
activated_at | string | null | Evet | |
created_at | string | Evet |
CustomDomainList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].kind | enum | Evet | Değerler: "dashboard", "tracking", "preference_center", "status_page" |
data[].hostname | string | Evet | |
data[].status | enum | Evet | Değerler: "pending", "verified", "active", "failed" |
data[].verification | object | Evet | |
data[].verification.txt_name | string | Evet | |
data[].verification.txt_value | string | Evet | |
data[].verification.cname_target | string | null | Evet | |
data[].last_error | string | null | Evet | |
data[].last_checked_at | string | null | Evet | |
data[].verified_at | string | null | Evet | |
data[].activated_at | string | null | Evet | |
data[].created_at | string | Evet |
DataFeed
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
url_template | string | Evet | |
method | enum | Evet | Değerler: "GET", "POST" |
body_template | string | null | Evet | |
headers | map<string, string> | Evet | |
secret_header_names | array<string> | Evet | |
cache_ttl_seconds | integer | Evet | |
timeout_ms | integer | Evet | |
enabled | boolean | Evet | |
liquid | string | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].url_template | string | Evet | |
data[].method | enum | Evet | Değerler: "GET", "POST" |
data[].body_template | string | null | Evet | |
data[].headers | map<string, string> | Evet | |
data[].secret_header_names | array<string> | Evet | |
data[].cache_ttl_seconds | integer | Evet | |
data[].timeout_ms | integer | Evet | |
data[].enabled | boolean | Evet | |
data[].liquid | string | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/data-feeds
DataFeedTestResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
status | enum | Evet | Değerler: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error" |
http_status | integer | null | Evet | |
duration_ms | integer | Evet | |
error | string | null | Evet | |
url | string | null | Evet | |
preview | any | Evet | |
truncated | boolean | Evet | |
user | object | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds/{feedId}/test
DeliverabilitySettingsDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
bcc_address | string (email) | null | Hayır | |
validation | object | Hayır | |
validation.enabled | boolean | Evet | |
validation.check_mx | boolean | Hayır | |
validation.block_disposable | boolean | Hayır | |
validation.block_role | boolean | Hayır | |
verifier | object | Hayır | |
verifier.provider | enum | null | Evet | |
verifier.api_key | string | Hayır | Uzunluk: 8–200 |
Kullanıldığı işlemler: PUT /v1/apps/{appId}/email-deliverability
Delivery
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
message_id | string | Evet | |
subscription_id | string | Evet | |
user_id | string | null | Evet | |
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
provider | string | null | Evet | |
status | enum | Evet | Değerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
attempt_count | integer | Evet | |
provider_message_id | string | null | Evet | |
error_code | string | null | Evet | |
error_message | string | null | Evet | |
suppression_reason | string | null | Evet | |
send_after | string | null | Evet | |
sent_at | string | null | Evet | |
delivered_at | string | null | Evet | |
opened_at | string | null | Evet | |
clicked_at | string | null | Evet | |
failed_at | string | null | Evet | |
created_at | string | Evet |
DeliveryList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].message_id | string | Evet | |
data[].subscription_id | string | Evet | |
data[].user_id | string | null | Evet | |
data[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
data[].provider | string | null | Evet | |
data[].status | enum | Evet | Değerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
data[].attempt_count | integer | Evet | |
data[].provider_message_id | string | null | Evet | |
data[].error_code | string | null | Evet | |
data[].error_message | string | null | Evet | |
data[].suppression_reason | string | null | Evet | |
data[].send_after | string | null | Evet | |
data[].sent_at | string | null | Evet | |
data[].delivered_at | string | null | Evet | |
data[].opened_at | string | null | Evet | |
data[].clicked_at | string | null | Evet | |
data[].failed_at | string | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/notifications/{messageId}/deliveries, GET /v1/apps/{appId}/campaigns/{campaignId}/deliveries
EmailAddressCheck
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | boolean | Evet | |
reason | enum | null | Evet | |
detail | string | null | Evet | |
checks | array<string> | Evet | |
unknown | array<string> | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/verify-address
EmailDeliverabilitySettings
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
bcc_address | string | null | Evet | |
validation | object | Evet | |
validation.enabled | boolean | Evet | |
validation.check_mx | boolean | Evet | |
validation.block_disposable | boolean | Evet | |
validation.block_role | boolean | Evet | |
verifier | object | Evet | |
verifier.provider | enum | null | Evet | |
verifier.has_key | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability
EmailDesign
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
subject | string | Evet | |
preheader | string | null | Evet | |
version | integer | Evet | |
template_id | string | null | Evet | |
template_version | integer | null | Evet | |
created_by | string | null | Evet | |
updated_by | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
document | object | Evet | |
document.version | 1 | Evet | |
document.settings | object | Evet | |
document.settings.width | integer | Hayır | Aralık: 480–800 |
document.settings.background_color | string | Hayır | |
document.settings.content_background_color | string | Hayır | |
document.settings.text_color | string | Hayır | |
document.settings.link_color | string | Hayır | |
document.settings.font_family | enum | Hayır | Değerler: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | Hayır | |
document.sections | array<object> | Evet | Öğe: 0–50 |
document.sections[].id | string | Evet | |
document.sections[].type | "section" | Evet | |
document.sections[].background_color | string | Hayır | |
document.sections[].background_image | string | Hayır | Uzunluk: 1–2000 |
document.sections[].padding | object | Hayır | |
document.sections[].stack_on_mobile | boolean | Hayır | |
document.sections[].columns | array<object> | Evet | Öğe: 1–4 |
issues | array<object> | Evet | |
issues[].code | enum | Evet | Değerler: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing" |
issues[].severity | enum | Evet | Değerler: "error", "warning" |
issues[].block_id | string | Evet | |
issues[].mode | enum | Hayır | Değerler: "light", "dark" |
issues[].ratio | number | Hayır | |
issues[].required | number | Hayır | |
issues[].foreground | string | Hayır | |
issues[].background | string | Hayır | |
warnings | array<string> | Evet |
EmailDesignPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].subject | string | Evet | |
data[].preheader | string | null | Evet | |
data[].version | integer | Evet | |
data[].template_id | string | null | Evet | |
data[].template_version | integer | null | Evet | |
data[].created_by | string | null | Evet | |
data[].updated_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
EmailDesignPreview
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
html | string | Evet | |
mjml | string | Evet | |
warnings | array<string> | Evet | |
issues | array<object> | Evet | |
issues[].code | enum | Evet | Değerler: "image_alt_missing", "low_contrast", "empty_link", "button_text_missing", "link_text_missing" |
issues[].severity | enum | Evet | Değerler: "error", "warning" |
issues[].block_id | string | Evet | |
issues[].mode | enum | Hayır | Değerler: "light", "dark" |
issues[].ratio | number | Hayır | |
issues[].required | number | Hayır | |
issues[].foreground | string | Hayır | |
issues[].background | string | Hayır |
EmailSavedBlock
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "section", "block" |
content | object | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet |
EmailSavedBlockList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].kind | enum | Evet | Değerler: "section", "block" |
data[].content | object | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet |
EmailWarmupPlan
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "domain", "ip" |
target | string | Evet | |
start_date | string | Evet | |
daily_limits | array<integer> | Evet | |
provider_shares | map<string, number> | Evet | |
timezone | string | Evet | |
status | enum | Evet | Değerler: "active", "paused", "completed" |
today | object | Evet | |
today.day | string | Evet | |
today.index | integer | Evet | |
today.limit | integer | null | Evet | |
today.used | integer | Evet | |
today.buckets | map<string, object> | Evet | |
scheduled_ahead | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].kind | enum | Evet | Değerler: "domain", "ip" |
data[].target | string | Evet | |
data[].start_date | string | Evet | |
data[].daily_limits | array<integer> | Evet | |
data[].provider_shares | map<string, number> | Evet | |
data[].timezone | string | Evet | |
data[].status | enum | Evet | Değerler: "active", "paused", "completed" |
data[].today | object | Evet | |
data[].today.day | string | Evet | |
data[].today.index | integer | Evet | |
data[].today.limit | integer | null | Evet | |
data[].today.used | integer | Evet | |
data[].today.buckets | map<string, object> | Evet | |
data[].scheduled_ahead | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability/warmup-plans
EmailWarmupUsage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].day | string | Evet | |
data[].bucket | string | Evet | |
data[].used | integer | Evet | |
data[].limit | integer | null | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usage
EndLiveActivityDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
activity_id | string | Evet | Uzunluk: 1–100 |
content_state | map<string, string | number | boolean> | Hayır | |
alert | object | Hayır | |
alert.title | map<string, string> | Hayır | |
alert.body | map<string, string> | Hayır | |
alert.sound | string | Hayır | Uzunluk: 0–100 |
stale_date | integer | Hayır | Aralık: 0–4102444800 |
dismissal_date | integer | Hayır | Aralık: 0–4102444800 |
relevance_score | number | Hayır | Aralık: 0–1 |
priority | 5 | 10 | Hayır | |
name | string | Hayır | Uzunluk: 0–200 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/end
EngagementReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
timezone | string | Evet | |
totals | object | Evet | |
totals.opened | integer | Evet | |
totals.clicked | integer | Evet | |
previous | object | null | Evet | |
cells | array<object> | Evet | |
cells[].weekday | integer | Evet | |
cells[].hour | integer | Evet | |
cells[].opened | integer | Evet | |
cells[].clicked | integer | Evet | |
rows | array<object> | Evet | |
rows[].date | string | Evet | |
rows[].opened | integer | Evet | |
rows[].clicked | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/engagement
EstimateAudienceDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
app_id | string | Hayır | Uzunluk: 1–∞ |
target | object | Evet | |
target.all | boolean | Hayır | |
target.include_subscription_ids | array<string> | Hayır | Öğe: 0–2000 |
target.include_external_ids | array<string> | Hayır | Öğe: 0–2000 |
target.include_aliases | map<string, array<string>> | Hayır | |
target.included_segments | array<string> | Hayır | Öğe: 0–50 |
target.excluded_segments | array<string> | Hayır | Öğe: 0–50 |
target.filters | any | Hayır | |
target.channels | array<enum> | Hayır | Öğe: 1–∞ |
target.test_devices_only | boolean | Hayır | |
target.email_to | array<string> | Hayır | Öğe: 1–2000 |
target.include_phone_numbers | array<string> | Hayır | Öğe: 1–2000 |
include_unsubscribed | boolean | Hayır |
Kullanıldığı işlemler: POST /v1/notifications/estimate
EstimateAudienceResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
recipients | integer | Evet | |
by_channel | map<string, integer> | Evet | |
new_contacts | integer | Evet | |
external_id_missing | array<string> | Evet |
Kullanıldığı işlemler: POST /v1/notifications/estimate
EventDefinition
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
display_name | string | null | Evet | |
properties_schema | map<string, string> | Evet | |
is_conversion | boolean | Evet | |
outcome_unique | boolean | Evet | |
outcome_unattributed | boolean | Evet | |
retention_days | integer | null | Evet | |
first_seen_at | string | Evet | |
last_seen_at | string | Evet | |
count_30d | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/events/definitions/{name}
EventDefinitionDetail
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
display_name | string | null | Evet | |
properties_schema | map<string, string> | Evet | |
is_conversion | boolean | Evet | |
outcome_unique | boolean | Evet | |
outcome_unattributed | boolean | Evet | |
retention_days | integer | null | Evet | |
first_seen_at | string | Evet | |
last_seen_at | string | Evet | |
count_30d | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
daily | array<object> | Evet | |
daily[].date | string | Evet | |
daily[].count | integer | Evet | |
daily[].users | integer | Evet | |
properties | array<object> | Evet | |
properties[].key | string | Evet | |
properties[].type | string | Evet | |
properties[].values | array<object> | Evet | |
properties[].values[].value | string | Evet | |
properties[].values[].count | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/events/definitions/{name}
EventDefinitionList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].display_name | string | null | Evet | |
data[].properties_schema | map<string, string> | Evet | |
data[].is_conversion | boolean | Evet | |
data[].outcome_unique | boolean | Evet | |
data[].outcome_unattributed | boolean | Evet | |
data[].retention_days | integer | null | Evet | |
data[].first_seen_at | string | Evet | |
data[].last_seen_at | string | Evet | |
data[].count_30d | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/events/definitions
EventList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].user_id | string | null | Evet | |
data[].subscription_id | string | null | Evet | |
data[].name | string | Evet | |
data[].properties | map<string, any> | Evet | |
data[].value | number | null | Evet | |
data[].source | enum | Evet | Değerler: "sdk", "api", "system", "import" |
data[].occurred_at | string | Evet |
EventsAccepted
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
accepted | integer | Evet |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/events, POST /v1/apps/{appId}/events
EventsReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
group_by | enum | Evet | Değerler: "day", "name" |
name | string | null | Evet | |
totals | object | Evet | |
totals.count | integer | Evet | |
totals.users | integer | Evet | |
previous | object | null | Evet | |
rows | array<object> | Evet | |
rows[].key | string | Evet | |
rows[].count | integer | Evet | |
rows[].users | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/events
Export
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
type | enum | Evet | Değerler: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | Evet | |
filters.from | string (date-time) | Hayır | |
filters.to | string (date-time) | Hayır | |
filters.name | string | Hayır | Uzunluk: 0–100 |
filters.message_id | string | Hayır | Uzunluk: 0–64 |
filters.campaign_id | string | Hayır | Uzunluk: 0–64 |
filters.status | string | Hayır | Uzunluk: 0–32 |
filters.channel | enum | Hayır | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
filters.segment_id | string | Hayır | Uzunluk: 0–64 |
status | enum | Evet | Değerler: "pending", "running", "completed", "failed" |
row_count | integer | null | Evet | |
error | string | null | Evet | |
download_url | string | null | Evet | |
expires_at | string | null | Evet | |
requested_by | string | null | Evet | |
created_at | string | Evet | |
completed_at | string | null | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].type | enum | Evet | Değerler: "users", "subscriptions", "events", "deliveries", "message_events" |
data[].filters | object | Evet | |
data[].filters.from | string (date-time) | Hayır | |
data[].filters.to | string (date-time) | Hayır | |
data[].filters.name | string | Hayır | Uzunluk: 0–100 |
data[].filters.message_id | string | Hayır | Uzunluk: 0–64 |
data[].filters.campaign_id | string | Hayır | Uzunluk: 0–64 |
data[].filters.status | string | Hayır | Uzunluk: 0–32 |
data[].filters.channel | enum | Hayır | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
data[].filters.segment_id | string | Hayır | Uzunluk: 0–64 |
data[].status | enum | Evet | Değerler: "pending", "running", "completed", "failed" |
data[].row_count | integer | null | Evet | |
data[].error | string | null | Evet | |
data[].download_url | string | null | Evet | |
data[].expires_at | string | null | Evet | |
data[].requested_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].completed_at | string | null | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/exports
FunnelBodyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
steps | array<object> | Evet | Öğe: 2–8 |
steps[].name | string | Evet | Uzunluk: 1–100 |
steps[].where | object | Hayır | |
steps[].where.key | string | Evet | Uzunluk: 1–64 |
steps[].where.value | string | Evet | Uzunluk: 0–500 |
from | string (date-time) | Hayır | |
to | string (date-time) | Hayır | |
window_hours | integer | Hayır | Varsayılan: 72; Aralık: 1–720 |
compare | boolean | Hayır | Varsayılan: false |
format | enum | Hayır | Değerler: "json", "csv"; Varsayılan: "json" |
Kullanıldığı işlemler: POST /v1/apps/{appId}/analytics/funnels
FunnelReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
window_hours | integer | Evet | |
steps | array<object> | Evet | |
steps[].name | string | Evet | |
steps[].users | integer | Evet | |
steps[].conversion_rate | number | null | Evet | |
steps[].drop_off | integer | Evet | |
overall_rate | number | null | Evet | |
previous | object | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/analytics/funnels
IdentityKey
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
kid | string | Evet | |
alg | "ES256" | Evet | |
public_jwk | map<string, string> | Evet | |
label | string | null | Evet | |
created_at | string | Evet | |
revoked_at | string | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}
IdentityKeyList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].kid | string | Evet | |
data[].alg | "ES256" | Evet | |
data[].public_jwk | map<string, string> | Evet | |
data[].label | string | null | Evet | |
data[].created_at | string | Evet | |
data[].revoked_at | string | null | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/identity-keys
Import
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
type | enum | Evet | Değerler: "onesignal_players", "csv_users" |
file_name | string | null | Evet | |
status | enum | Evet | Değerler: "pending", "running", "completed", "failed" |
stats | object | Evet | |
stats.processed | integer | Hayır | |
stats.created_users | integer | Hayır | |
stats.updated_users | integer | Hayır | |
stats.created_subscriptions | integer | Hayır | |
stats.skipped | integer | Hayır | |
stats.errors | integer | Hayır | |
error | string | null | Evet | |
error_report_url | string | null | Evet | |
requested_by | string | null | Evet | |
created_at | string | Evet | |
completed_at | string | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/imports, GET /v1/apps/{appId}/imports/{importId}
ImportList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].type | enum | Evet | Değerler: "onesignal_players", "csv_users" |
data[].file_name | string | null | Evet | |
data[].status | enum | Evet | Değerler: "pending", "running", "completed", "failed" |
data[].stats | object | Evet | |
data[].stats.processed | integer | Hayır | |
data[].stats.created_users | integer | Hayır | |
data[].stats.updated_users | integer | Hayır | |
data[].stats.created_subscriptions | integer | Hayır | |
data[].stats.skipped | integer | Hayır | |
data[].stats.errors | integer | Hayır | |
data[].error | string | null | Evet | |
data[].error_report_url | string | null | Evet | |
data[].requested_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].completed_at | string | null | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/imports
InAppMessage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
priority | integer | Evet | |
triggers | array<object> | Evet | |
trigger_groups | array<array<object>> | null | Evet | |
variants | array<object> | Evet | |
variants[].id | string | Evet | Uzunluk: 1–64 |
variants[].name | string | Evet | Uzunluk: 1–60 |
variants[].weight_percent | integer | Evet | Aralık: 1–99 |
variants[].display | object | Evet | |
variants[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | Hayır | |
variants[].display.text_color | string | Hayır | |
variants[].display.dismissible | boolean | Hayır | |
variants[].display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
variants[].display.content_type | enum | Hayır | Değerler: "blocks", "html" |
variants[].display.html | map<string, string> | Hayır | |
variants[].display.html_height | integer | Hayır | Aralık: 40–2000 |
variants[].display.blocks | array<object> | Evet | Öğe: 0–12 |
display | object | Evet | |
display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | Hayır | |
display.text_color | string | Hayır | |
display.dismissible | boolean | Hayır | |
display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
display.content_type | enum | Hayır | Değerler: "blocks", "html" |
display.html | map<string, string> | Hayır | |
display.html_height | integer | Hayır | Aralık: 40–2000 |
display.blocks | array<object> | Evet | Öğe: 0–12 |
audience | object | Evet | |
audience.included_segments | array<string> | Hayır | Öğe: 0–20 |
audience.excluded_segments | array<string> | Hayır | Öğe: 0–20 |
frequency | object | Evet | |
frequency.max_impressions | integer | Hayır | Aralık: 1–1000 |
frequency.min_interval_seconds | integer | Hayır | Aralık: 0–31536000 |
frequency.stop_after_interaction | boolean | Hayır | |
journey_only | boolean | Evet | |
start_at | string | null | Evet | |
end_at | string | null | Evet | |
stats | object | Evet | |
stats.impressions | integer | Evet | |
stats.clicks | integer | Evet | |
stats.dismissals | integer | Evet | |
stats.unique_users | integer | Evet | |
stats.ctr | number | Evet | |
variant_stats | array<object> | Evet | |
variant_stats[].variant_id | string | Evet | |
variant_stats[].impressions | integer | Evet | |
variant_stats[].clicks | integer | Evet | |
variant_stats[].ctr | number | Evet | |
ab_test | object | Evet | |
ab_test.winner | object | Hayır | |
ab_test.winner.mode | enum | Evet | Değerler: "manual", "auto" |
ab_test.winner.min_impressions | integer | Hayır | Aralık: 10–1000000 |
ab_test.winner.confidence | number | Hayır | Aralık: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Evet | |
ab_test.decided_at | string | null | Evet | |
ab_test.decided_by | string | null | Evet | |
variant_significance | object | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
data[].priority | integer | Evet | |
data[].triggers | array<object> | Evet | |
data[].trigger_groups | array<array<object>> | null | Evet | |
data[].variants | array<object> | Evet | |
data[].variants[].id | string | Evet | Uzunluk: 1–64 |
data[].variants[].name | string | Evet | Uzunluk: 1–60 |
data[].variants[].weight_percent | integer | Evet | Aralık: 1–99 |
data[].variants[].display | object | Evet | |
data[].display | object | Evet | |
data[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | Hayır | |
data[].display.text_color | string | Hayır | |
data[].display.dismissible | boolean | Hayır | |
data[].display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
data[].display.content_type | enum | Hayır | Değerler: "blocks", "html" |
data[].display.html | map<string, string> | Hayır | |
data[].display.html_height | integer | Hayır | Aralık: 40–2000 |
data[].display.blocks | array<object> | Evet | Öğe: 0–12 |
data[].audience | object | Evet | |
data[].audience.included_segments | array<string> | Hayır | Öğe: 0–20 |
data[].audience.excluded_segments | array<string> | Hayır | Öğe: 0–20 |
data[].frequency | object | Evet | |
data[].frequency.max_impressions | integer | Hayır | Aralık: 1–1000 |
data[].frequency.min_interval_seconds | integer | Hayır | Aralık: 0–31536000 |
data[].frequency.stop_after_interaction | boolean | Hayır | |
data[].journey_only | boolean | Evet | |
data[].start_at | string | null | Evet | |
data[].end_at | string | null | Evet | |
data[].stats | object | Evet | |
data[].stats.impressions | integer | Evet | |
data[].stats.clicks | integer | Evet | |
data[].stats.dismissals | integer | Evet | |
data[].stats.unique_users | integer | Evet | |
data[].stats.ctr | number | Evet | |
data[].variant_stats | array<object> | Evet | |
data[].variant_stats[].variant_id | string | Evet | |
data[].variant_stats[].impressions | integer | Evet | |
data[].variant_stats[].clicks | integer | Evet | |
data[].variant_stats[].ctr | number | Evet | |
data[].ab_test | object | Evet | |
data[].ab_test.winner | object | Hayır | |
data[].ab_test.winner_variant_id | string | null | Evet | |
data[].ab_test.decided_at | string | null | Evet | |
data[].ab_test.decided_by | string | null | Evet | |
data[].variant_significance | object | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/in-app-messages
InAppStatusDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages/{messageId}/status
InAppTemplate
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
source | enum | Evet | Değerler: "system", "org" |
category | enum | Evet | Değerler: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom" |
name | string | Evet | |
description | string | null | Evet | |
display | object | Evet | |
display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | Hayır | |
display.text_color | string | Hayır | |
display.dismissible | boolean | Hayır | |
display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
display.content_type | enum | Hayır | Değerler: "blocks", "html" |
display.html | map<string, string> | Hayır | |
display.html_height | integer | Hayır | Aralık: 40–2000 |
display.blocks | array<object> | Evet | Öğe: 0–12 |
created_at | string | null | Evet | |
updated_at | string | null | Evet |
InAppTemplateList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
gallery_version | string | Evet | |
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].source | enum | Evet | Değerler: "system", "org" |
data[].category | enum | Evet | Değerler: "welcome", "promotion", "cart", "survey", "rating", "onboarding", "update", "permission", "newsletter", "announcement", "loyalty", "custom" |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].display | object | Evet | |
data[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | Hayır | |
data[].display.text_color | string | Hayır | |
data[].display.dismissible | boolean | Hayır | |
data[].display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
data[].display.content_type | enum | Hayır | Değerler: "blocks", "html" |
data[].display.html | map<string, string> | Hayır | |
data[].display.html_height | integer | Hayır | Aralık: 40–2000 |
data[].display.blocks | array<object> | Evet | Öğe: 0–12 |
data[].created_at | string | null | Evet | |
data[].updated_at | string | null | Evet |
InAppWinnerDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
variant_id | string | Evet | Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/in-app-messages/{messageId}/winner
InboxItem
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
message_id | string | null | Evet | |
title | string | null | Evet | |
body | string | null | Evet | |
url | string | null | Evet | |
image_url | string | null | Evet | |
data | map<string, string> | Evet | |
read | boolean | Evet | |
read_at | string | null | Evet | |
archived_at | string | null | Evet | |
expires_at | string | null | Evet | |
created_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].message_id | string | null | Evet | |
data[].title | string | null | Evet | |
data[].body | string | null | Evet | |
data[].url | string | null | Evet | |
data[].image_url | string | null | Evet | |
data[].data | map<string, string> | Evet | |
data[].read | boolean | Evet | |
data[].read_at | string | null | Evet | |
data[].archived_at | string | null | Evet | |
data[].expires_at | string | null | Evet | |
data[].created_at | string | Evet | |
unread_count | integer | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/users/{userId}/inbox, GET /v1/apps/{appId}/users/by/{label}/{value}/inbox
InboxReadAllResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
updated | integer | Evet | |
unread_count | integer | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
type | enum | Evet | Değerler: "segment", "amplitude", "mixpanel", "zapier", "slack" |
name | string | Evet | |
status | enum | Evet | Değerler: "active", "paused", "error" |
settings | map<string, any> | Evet | |
events | array<string> | Evet | |
credentials | map<string, string> | Evet | |
state | map<string, any> | Evet | |
inbound_url | string | null | Evet | |
interactions_url | string | null | Evet | |
pending_events | integer | Evet | |
dead_events | integer | Evet | |
hooks | integer | Evet | |
consecutive_failures | integer | Evet | |
last_error | string | null | Evet | |
last_error_at | string | null | Evet | |
last_success_at | string | null | Evet | |
last_run_at | string | null | Evet | |
next_sync_at | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
IntegrationList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].type | enum | Evet | Değerler: "segment", "amplitude", "mixpanel", "zapier", "slack" |
data[].name | string | Evet | |
data[].status | enum | Evet | Değerler: "active", "paused", "error" |
data[].settings | map<string, any> | Evet | |
data[].events | array<string> | Evet | |
data[].credentials | map<string, string> | Evet | |
data[].state | map<string, any> | Evet | |
data[].inbound_url | string | null | Evet | |
data[].interactions_url | string | null | Evet | |
data[].pending_events | integer | Evet | |
data[].dead_events | integer | Evet | |
data[].hooks | integer | Evet | |
data[].consecutive_failures | integer | Evet | |
data[].last_error | string | null | Evet | |
data[].last_error_at | string | null | Evet | |
data[].last_success_at | string | null | Evet | |
data[].last_run_at | string | null | Evet | |
data[].next_sync_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
catalog | array<object> | Evet | |
catalog[].type | enum | Evet | Değerler: "segment", "amplitude", "mixpanel", "zapier", "slack" |
catalog[].events | array<string> | Evet | |
catalog[].cohorts | boolean | Evet | |
catalog[].inbound | boolean | Evet |
IntegrationOk
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | true | Evet |
Kullanıldığı işlemler: DELETE /v1/apps/{appId}/integrations/zapier/hooks/{hookId}
IntegrationRunList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].kind | enum | Evet | Değerler: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test" |
data[].trigger | enum | Evet | Değerler: "schedule", "manual", "event", "inbound" |
data[].status | enum | Evet | Değerler: "running", "succeeded", "partial", "failed" |
data[].stats | map<string, number> | Evet | |
data[].error | string | null | Evet | |
data[].started_at | string | Evet | |
data[].finished_at | string | null | Evet | |
data[].duration_ms | integer | null | Evet |
IntegrationSyncResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
queued | true | Evet | |
next_sync_at | string | Evet |
IntegrationTestResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | boolean | Evet | |
error | string | null | Evet | |
run_id | string | Evet |
Invite
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
email | string | Evet | |
role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
expires_at | string | Evet | |
invited_by | string | null | Evet | |
created_at | string | Evet |
InviteList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].email | string | Evet | |
data[].role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
data[].expires_at | string | Evet | |
data[].invited_by | string | null | Evet | |
data[].created_at | string | Evet |
InvitePreview
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
org_name | string | Evet | |
email | string | Evet | |
role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
expires_at | string | Evet | |
inviter_name | string | null | Evet |
InvoiceList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].provider_invoice_id | string | Evet | |
data[].amount | integer | Evet | |
data[].currency | string | Evet | |
data[].status | string | Evet | |
data[].pdf_url | string | null | Evet | |
data[].hosted_url | string | null | Evet | |
data[].period_start | string | null | Evet | |
data[].period_end | string | null | Evet | |
data[].issued_at | string | null | Evet |
Journey
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
current_version | integer | null | Evet | |
draft_version | integer | null | Evet | |
trigger_kind | string | null | Evet | |
published_at | string | null | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
summary | object | Evet | |
summary.runs_total | integer | Evet | |
summary.active | integer | Evet | |
summary.completed | integer | Evet | |
summary.exited | integer | Evet | |
summary.failed | integer | Evet | |
summary.goal_reached | integer | Evet |
JourneyDetail
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
current_version | integer | null | Evet | |
draft_version | integer | null | Evet | |
trigger_kind | string | null | Evet | |
published_at | string | null | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
summary | object | Evet | |
summary.runs_total | integer | Evet | |
summary.active | integer | Evet | |
summary.completed | integer | Evet | |
summary.exited | integer | Evet | |
summary.failed | integer | Evet | |
summary.goal_reached | integer | Evet | |
editing | object | Evet | |
editing.version | integer | Evet | |
editing.graph | map<string, any> | Evet | |
editing.settings | map<string, any> | Evet | |
editing.published_at | string | null | Evet | |
editing.published_by | string | null | Evet | |
editing.created_at | string | Evet | |
editing.updated_at | string | Evet | |
issues | array<object> | Evet | |
issues[].code | string | Evet | |
issues[].node_id | string | Hayır | |
issues[].edge_id | string | Hayır | |
issues[].message | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
data[].current_version | integer | null | Evet | |
data[].draft_version | integer | null | Evet | |
data[].trigger_kind | string | null | Evet | |
data[].published_at | string | null | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
data[].summary | object | Evet | |
data[].summary.runs_total | integer | Evet | |
data[].summary.active | integer | Evet | |
data[].summary.completed | integer | Evet | |
data[].summary.exited | integer | Evet | |
data[].summary.failed | integer | Evet | |
data[].summary.goal_reached | integer | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys
JourneyPublishResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
journey | object | Evet | |
journey.id | string | Evet | |
journey.app_id | string | Evet | |
journey.name | string | Evet | |
journey.description | string | null | Evet | |
journey.status | enum | Evet | Değerler: "draft", "active", "paused", "archived" |
journey.current_version | integer | null | Evet | |
journey.draft_version | integer | null | Evet | |
journey.trigger_kind | string | null | Evet | |
journey.published_at | string | null | Evet | |
journey.created_by | string | null | Evet | |
journey.created_at | string | Evet | |
journey.updated_at | string | Evet | |
journey.summary | object | Evet | |
journey.summary.runs_total | integer | Evet | |
journey.summary.active | integer | Evet | |
journey.summary.completed | integer | Evet | |
journey.summary.exited | integer | Evet | |
journey.summary.failed | integer | Evet | |
journey.summary.goal_reached | integer | Evet | |
version | integer | Evet | |
issues | array<object> | Evet | |
issues[].code | string | Evet | |
issues[].node_id | string | Hayır | |
issues[].edge_id | string | Hayır | |
issues[].message | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/publish
JourneyRun
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
journey_id | string | Evet | |
version | integer | Evet | |
user_id | string | Evet | |
external_id | string | null | Evet | |
status | enum | Evet | Değerler: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Evet | |
next_action_at | string | null | Evet | |
entered_at | string | Evet | |
completed_at | string | null | Evet | |
exit_reason | string | null | Evet | |
goal_id | string | null | Evet | |
goal_reached_at | string | null | Evet | |
context | map<string, any> | Evet |
JourneyRunDetail
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
journey_id | string | Evet | |
version | integer | Evet | |
user_id | string | Evet | |
external_id | string | null | Evet | |
status | enum | Evet | Değerler: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Evet | |
next_action_at | string | null | Evet | |
entered_at | string | Evet | |
completed_at | string | null | Evet | |
exit_reason | string | null | Evet | |
goal_id | string | null | Evet | |
goal_reached_at | string | null | Evet | |
context | map<string, any> | Evet | |
journey_name | string | Evet | |
steps | array<object> | Evet | |
steps[].id | string | Evet | |
steps[].node_id | string | Evet | |
steps[].node_type | string | Evet | |
steps[].status | enum | Evet | Değerler: "completed", "waiting", "failed", "skipped" |
steps[].branch | string | null | Evet | |
steps[].result | map<string, any> | Evet | |
steps[].started_at | string | Evet | |
steps[].finished_at | string | null | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}, DELETE /v1/apps/{appId}/journeys/{journeyId}/runs/{runId}
JourneyRunPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].journey_id | string | Evet | |
data[].version | integer | Evet | |
data[].user_id | string | Evet | |
data[].external_id | string | null | Evet | |
data[].status | enum | Evet | Değerler: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Evet | |
data[].next_action_at | string | null | Evet | |
data[].entered_at | string | Evet | |
data[].completed_at | string | null | Evet | |
data[].exit_reason | string | null | Evet | |
data[].goal_id | string | null | Evet | |
data[].goal_reached_at | string | null | Evet | |
data[].context | map<string, any> | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/runs
JourneyStats
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
version | integer | null | Evet | |
summary | object | Evet | |
summary.runs_total | integer | Evet | |
summary.active | integer | Evet | |
summary.completed | integer | Evet | |
summary.exited | integer | Evet | |
summary.failed | integer | Evet | |
summary.goal_reached | integer | Evet | |
summary.waiting | integer | Evet | |
summary.goal_conversion_rate | number | Evet | |
nodes | array<object> | Evet | |
nodes[].node_id | string | Evet | |
nodes[].node_type | string | Evet | |
nodes[].entered | integer | Evet | |
nodes[].completed | integer | Evet | |
nodes[].waiting_now | integer | Evet | |
nodes[].skipped | integer | Evet | |
nodes[].failed | integer | Evet | |
nodes[].branches | map<string, integer> | Evet | |
nodes[].messages | map<string, integer> | Hayır | |
nodes[].variants | array<object> | Hayır | |
nodes[].variants[].variant_id | string | Evet | |
nodes[].variants[].sent | integer | Evet | |
nodes[].variants[].opened | integer | Evet | |
nodes[].variants[].clicked | integer | Evet | |
nodes[].variants[].converted | integer | Evet | |
nodes[].variants[].winner | boolean | Evet | |
goals | array<object> | Evet | |
goals[].goal_id | string | Evet | |
goals[].reached | integer | Evet | |
exit_reasons | map<string, integer> | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/stats
JourneyTriggerResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
entered | boolean | Evet | |
run | object | null | Evet | |
reason | enum | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/runs
JourneyVersionList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].version | integer | Evet | |
data[].graph | map<string, any> | Evet | |
data[].settings | map<string, any> | Evet | |
data[].published_at | string | null | Evet | |
data[].published_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/journeys/{journeyId}/versions
LiveActivitySendResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
message_id | string | Evet | |
activity_id | string | Evet | |
event | enum | Evet | Değerler: "start", "update", "end" |
recipients_estimate | integer | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | true | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
content_state_schema | object | Evet | |
content_state_schema.type | "object" | Evet | |
content_state_schema.properties | map<string, object> | Evet | |
content_state_schema.required | array<string> | Hayır | Öğe: 0–50 |
attributes_schema | object | Evet | |
attributes_schema.type | "object" | Evet | |
attributes_schema.properties | map<string, object> | Evet | |
attributes_schema.required | array<string> | Hayır | Öğe: 0–50 |
push_to_start_tokens | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}
LiveActivityTypeList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].content_state_schema | object | Evet | |
data[].content_state_schema.type | "object" | Evet | |
data[].content_state_schema.properties | map<string, object> | Evet | |
data[].content_state_schema.required | array<string> | Hayır | Öğe: 0–50 |
data[].attributes_schema | object | Evet | |
data[].attributes_schema.type | "object" | Evet | |
data[].attributes_schema.properties | map<string, object> | Evet | |
data[].attributes_schema.required | array<string> | Hayır | Öğe: 0–50 |
data[].push_to_start_tokens | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/live-activities/types
LoginResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
mfa_required | boolean | Evet | |
mfa_token | string | Hayır | |
account | object | Hayır | |
account.id | string | Evet | |
account.email | string | Evet | |
account.name | string | Evet | |
account.locale | string | Evet | |
account.timezone | string | Evet | |
account.email_verified | boolean | Evet | |
account.mfa_enabled | boolean | Evet | |
account.is_platform_admin | boolean | Evet | |
account.has_password | boolean | Evet | |
account.marketing_opt_in | boolean | Evet | |
account.created_at | string | Evet |
Me
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
account | object | Evet | |
account.id | string | Evet | |
account.email | string | Evet | |
account.name | string | Evet | |
account.locale | string | Evet | |
account.timezone | string | Evet | |
account.email_verified | boolean | Evet | |
account.mfa_enabled | boolean | Evet | |
account.is_platform_admin | boolean | Evet | |
account.has_password | boolean | Evet | |
account.marketing_opt_in | boolean | Evet | |
account.created_at | string | Evet | |
memberships | array<object> | Evet | |
memberships[].org_id | string | Evet | |
memberships[].org_name | string | Evet | |
memberships[].org_slug | string | Evet | |
memberships[].role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
memberships[].app_scopes | array<string> | Evet | |
memberships[].mfa_required | boolean | Evet | |
admin_mfa_required | boolean | Evet | |
mock_providers_available | boolean | Evet |
Member
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
account_id | string | Evet | |
email | string | Evet | |
name | string | Evet | |
role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
app_scopes | array<string> | Evet | |
accepted_at | string | null | Evet | |
created_at | string | Evet | |
last_login_at | string | null | Evet |
MemberList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].account_id | string | Evet | |
data[].email | string | Evet | |
data[].name | string | Evet | |
data[].role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
data[].app_scopes | array<string> | Evet | |
data[].accepted_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].last_login_at | string | null | Evet |
Kullanıldığı işlemler: GET /v1/organization/members
Message
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
source | enum | Evet | Değerler: "campaign", "api", "journey", "test" |
status | enum | Evet | Değerler: "queued", "processing", "completed", "cancelled", "failed" |
idempotency_key | string | null | Evet | |
name | string | null | Evet | |
content | map<string, any> | Evet | |
target | map<string, any> | Evet | |
options | map<string, any> | Evet | |
labels | array<string> | Evet | |
category | string | null | Evet | |
template_id | string | null | Evet | |
campaign_id | string | null | Evet | |
variants | array<object> | null | Evet | |
counts | object | Evet | |
counts.targeted | integer | Hayır | |
counts.suppressed | integer | Hayır | |
counts.sent | integer | Hayır | |
counts.delivered | integer | Hayır | |
counts.failed | integer | Hayır | |
counts.errored | integer | Hayır | |
counts.expired | integer | Hayır | |
counts.opened | integer | Hayır | |
counts.clicked | integer | Hayır | |
counts.converted | integer | Hayır | |
counts.bounced | integer | Hayır | |
counts.complained | integer | Hayır | |
counts.unsubscribed | integer | Hayır | |
counts.sms_segments | integer | Hayır | |
requested_by | object | Evet | |
requested_by.type | enum | Evet | Değerler: "api_key", "account", "system" |
requested_by.id | string | Hayır | |
error | string | null | Evet | |
scheduled_for | string | null | Evet | |
started_at | string | null | Evet | |
completed_at | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/notifications/{messageId}, DELETE /v1/notifications/{messageId}
MessageCategory
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
key | string | Evet | |
name | map<string, string> | Evet | |
description | map<string, string> | Evet | |
channels | array<string> | null | Evet | |
default_opted_in | boolean | Evet | |
position | integer | Evet | |
opted_out_users | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}
MessageCategoryList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].key | string | Evet | |
data[].name | map<string, string> | Evet | |
data[].description | map<string, string> | Evet | |
data[].channels | array<string> | null | Evet | |
data[].default_opted_in | boolean | Evet | |
data[].position | integer | Evet | |
data[].opted_out_users | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/categories
MessageList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].source | enum | Evet | Değerler: "campaign", "api", "journey", "test" |
data[].status | enum | Evet | Değerler: "queued", "processing", "completed", "cancelled", "failed" |
data[].idempotency_key | string | null | Evet | |
data[].name | string | null | Evet | |
data[].content | map<string, any> | Evet | |
data[].target | map<string, any> | Evet | |
data[].options | map<string, any> | Evet | |
data[].labels | array<string> | Evet | |
data[].category | string | null | Evet | |
data[].template_id | string | null | Evet | |
data[].campaign_id | string | null | Evet | |
data[].variants | array<object> | null | Evet | |
data[].counts | object | Evet | |
data[].counts.targeted | integer | Hayır | |
data[].counts.suppressed | integer | Hayır | |
data[].counts.sent | integer | Hayır | |
data[].counts.delivered | integer | Hayır | |
data[].counts.failed | integer | Hayır | |
data[].counts.errored | integer | Hayır | |
data[].counts.expired | integer | Hayır | |
data[].counts.opened | integer | Hayır | |
data[].counts.clicked | integer | Hayır | |
data[].counts.converted | integer | Hayır | |
data[].counts.bounced | integer | Hayır | |
data[].counts.complained | integer | Hayır | |
data[].counts.unsubscribed | integer | Hayır | |
data[].counts.sms_segments | integer | Hayır | |
data[].requested_by | object | Evet | |
data[].requested_by.type | enum | Evet | Değerler: "api_key", "account", "system" |
data[].requested_by.id | string | Hayır | |
data[].error | string | null | Evet | |
data[].scheduled_for | string | null | Evet | |
data[].started_at | string | null | Evet | |
data[].completed_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/notifications, GET /v1/apps/{appId}/campaigns/{campaignId}/messages
MessagesReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
group_by | enum | Evet | Değerler: "day", "channel", "campaign" |
totals | object | Evet | |
totals.sent | integer | Evet | |
totals.delivered | integer | Evet | |
totals.failed | integer | Evet | |
totals.opened | integer | Evet | |
totals.clicked | integer | Evet | |
totals.converted | integer | Evet | |
totals.delivery_rate | number | null | Evet | |
totals.open_rate | number | null | Evet | |
totals.click_rate | number | null | Evet | |
previous | object | null | Evet | |
rows | array<object> | Evet | |
rows[].key | string | Evet | |
rows[].label | string | Evet | |
rows[].sent | integer | Evet | |
rows[].delivered | integer | Evet | |
rows[].failed | integer | Evet | |
rows[].opened | integer | Evet | |
rows[].clicked | integer | Evet | |
rows[].converted | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/messages
MfaSetup
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
secret | string | Evet | |
otpauth_uri | string | Evet |
OAuthApproveResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
redirect_to | string | Evet |
OAuthConsentContext
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
client | object | Evet | |
client.client_id | string | Evet | |
client.client_name | string | Evet | |
client.client_uri | string | null | Evet | |
client.redirect_host | string | Evet | |
requested_scopes | array<string> | Evet | |
available_scopes | array<string> | Evet | |
deny_url | string | Evet | |
organizations | array<object> | Evet | |
organizations[].id | string | Evet | |
organizations[].name | string | Evet | |
organizations[].slug | string | Evet | |
organizations[].role | string | Evet | |
organizations[].org_wide_allowed | boolean | Evet | |
organizations[].grantable_scopes | array<string> | Evet | |
organizations[].apps | array<object> | Evet | |
organizations[].apps[].id | string | Evet | |
organizations[].apps[].name | string | Evet |
Ok
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | true | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
button_id | string | Hayır | Uzunluk: 0–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/deliveries/{deliveryId}/opened
Org
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
slug | string | Evet | |
plan_code | string | Evet | |
status | enum | Evet | Değerler: "active", "suspended", "deleted" |
settings | object | Evet | |
settings.mfaRequired | boolean | Hayır | |
settings.ipAllowlist | array<string> | Hayır | Öğe: 0–50 |
settings.retentionDays | integer | Hayır | Aralık: 7–3650 |
settings.sessionMaxHours | integer | Hayır | Aralık: 1–2160 |
settings.auditStream | object | Hayır | |
settings.auditStream.s3 | boolean | Hayır | |
settings.auditStream.webhookAppId | string | null | Hayır | |
created_at | string | Evet | |
region | string | null | Evet | |
managed_by_reseller | boolean | Evet |
Kullanıldığı işlemler: GET /v1/organization
OrgDataExport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].app_id | string | Evet | |
data[].app_name | string | Evet | |
data[].export_ids | array<string> | Evet |
OrgList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].slug | string | Evet | |
data[].plan_code | string | Evet | |
data[].status | enum | Evet | Değerler: "active", "suspended", "deleted" |
data[].settings | object | Evet | |
data[].settings.mfaRequired | boolean | Hayır | |
data[].settings.ipAllowlist | array<string> | Hayır | Öğe: 0–50 |
data[].settings.retentionDays | integer | Hayır | Aralık: 7–3650 |
data[].settings.sessionMaxHours | integer | Hayır | Aralık: 1–2160 |
data[].settings.auditStream | object | Hayır | |
data[].created_at | string | Evet | |
data[].region | string | null | Evet | |
data[].managed_by_reseller | boolean | Evet | |
data[].role | enum | Evet | Değerler: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer" |
data[].app_scopes | array<string> | Evet |
OrgNotificationList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].kind | enum | Evet | Değerler: "channel_invalid", "channel_expiring", "campaign_approval", "message_failed", "export_ready", "import_finished", "webhook_unhealthy" |
data[].severity | enum | Evet | Değerler: "error", "warning", "info", "success" |
data[].app_id | string | Evet | |
data[].app_name | string | Evet | |
data[].title | string | Evet | |
data[].detail | string | null | Evet | |
data[].target_id | string | null | Evet | |
data[].at | string | Evet |
OverviewStats
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
range | enum | Evet | Değerler: "7d", "30d", "custom" |
from | string | Evet | |
to | string | Evet | |
kpis | object | Evet | |
kpis.sent | integer | Evet | |
kpis.delivered | integer | Evet | |
kpis.failed | integer | Evet | |
kpis.opened | integer | Evet | |
kpis.clicked | integer | Evet | |
kpis.delivery_rate | number | null | Evet | |
kpis.open_rate | number | null | Evet | |
kpis.click_rate | number | null | Evet | |
kpis.active_subscriptions | integer | Evet | |
kpis.new_subscriptions | integer | Evet | |
kpis.opt_outs | integer | Evet | |
series | array<object> | Evet | |
series[].date | string | Evet | |
series[].sent | integer | Evet | |
series[].delivered | integer | Evet | |
series[].failed | integer | Evet | |
series[].opened | integer | Evet | |
recent_messages | array<object> | Evet | |
recent_messages[].id | string | Evet | |
recent_messages[].app_id | string | Evet | |
recent_messages[].source | enum | Evet | Değerler: "campaign", "api", "journey", "test" |
recent_messages[].status | enum | Evet | Değerler: "queued", "processing", "completed", "cancelled", "failed" |
recent_messages[].idempotency_key | string | null | Evet | |
recent_messages[].name | string | null | Evet | |
recent_messages[].content | map<string, any> | Evet | |
recent_messages[].target | map<string, any> | Evet | |
recent_messages[].options | map<string, any> | Evet | |
recent_messages[].labels | array<string> | Evet | |
recent_messages[].category | string | null | Evet | |
recent_messages[].template_id | string | null | Evet | |
recent_messages[].campaign_id | string | null | Evet | |
recent_messages[].variants | array<object> | null | Evet | |
recent_messages[].counts | object | Evet | |
recent_messages[].counts.targeted | integer | Hayır | |
recent_messages[].counts.suppressed | integer | Hayır | |
recent_messages[].counts.sent | integer | Hayır | |
recent_messages[].counts.delivered | integer | Hayır | |
recent_messages[].counts.failed | integer | Hayır | |
recent_messages[].counts.errored | integer | Hayır | |
recent_messages[].counts.expired | integer | Hayır | |
recent_messages[].counts.opened | integer | Hayır | |
recent_messages[].counts.clicked | integer | Hayır | |
recent_messages[].counts.converted | integer | Hayır | |
recent_messages[].counts.bounced | integer | Hayır | |
recent_messages[].counts.complained | integer | Hayır | |
recent_messages[].counts.unsubscribed | integer | Hayır | |
recent_messages[].counts.sms_segments | integer | Hayır | |
recent_messages[].requested_by | object | Evet | |
recent_messages[].requested_by.type | enum | Evet | Değerler: "api_key", "account", "system" |
recent_messages[].requested_by.id | string | Hayır | |
recent_messages[].error | string | null | Evet | |
recent_messages[].scheduled_for | string | null | Evet | |
recent_messages[].started_at | string | null | Evet | |
recent_messages[].completed_at | string | null | Evet | |
recent_messages[].created_at | string | Evet | |
recent_messages[].updated_at | string | Evet | |
recent_campaigns | array<object> | Evet | |
recent_campaigns[].id | string | Evet | |
recent_campaigns[].name | string | Evet | |
recent_campaigns[].type | string | Evet | |
recent_campaigns[].status | string | Evet | |
recent_campaigns[].sent | integer | Evet | |
recent_campaigns[].opened | integer | Evet | |
recent_campaigns[].clicked | integer | Evet | |
recent_campaigns[].updated_at | string | Evet | |
top_errors | array<object> | Evet | |
top_errors[].code | string | Evet | |
top_errors[].count | integer | Evet | |
channels | array<object> | Evet | |
channels[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
channels[].provider | enum | null | Evet | |
channels[].status | enum | Evet | Değerler: "unconfigured", "active", "invalid", "suspended" |
channels[].last_error | string | null | Evet | |
channels[].active_subscriptions | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/overview
PatchEventDefinitionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
display_name | string | null | Hayır | |
is_conversion | boolean | Hayır | |
outcome_unique | boolean | Hayır | |
outcome_unattributed | boolean | Hayır | |
retention_days | integer | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/events/definitions/{name}
PatchSubscriptionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
token | string | Hayır | Uzunluk: 1–4096 |
device | object | Hayır | |
device.model | string | Hayır | Uzunluk: 0–100 |
device.os | string | Hayır | Uzunluk: 0–50 |
device.os_version | string | Hayır | Uzunluk: 0–50 |
device.app_version | string | null | Hayır | |
device.sdk_version | string | Hayır | Uzunluk: 0–50 |
device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
device.carrier | string | Hayır | Uzunluk: 0–100 |
device.locale | string | Hayır | Uzunluk: 0–20 |
device.timezone | string | Hayır | Uzunluk: 0–64 |
device.push_capable | boolean | Hayır | |
device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
status | enum | Hayır | Değerler: "subscribed", "unsubscribed" |
test_device | boolean | Hayır | |
test_device_name | string | Hayır | Uzunluk: 0–100 |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/subscriptions/{subscriptionId}, PATCH /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}
PatchUserDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
properties | map<string, any> | Hayır | |
tags | map<string, string | null> | Hayır | |
deltas | object | Hayır | |
deltas.session_count | integer | Hayır | Aralık: -1000000–1000000 |
deltas.session_time | integer | Hayır | Aralık: 0–31536000 |
deltas.purchases | array<object> | Hayır | Öğe: 0–100 |
deltas.purchases[].sku | string | Evet | Uzunluk: 1–100 |
deltas.purchases[].amount | number | Evet | Aralık: 0–∞ |
deltas.purchases[].iso | string | Hayır | Uzunluk: 3–3 |
deltas.purchases[].count | integer | Hayır | Varsayılan: 1; Aralık: 1–1000 |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/users/by/{label}/{value}
PlanList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].code | string | Evet | |
data[].name | string | Evet | |
data[].monthly_price | integer | Evet | |
data[].currency | string | Evet | |
data[].position | integer | Evet | |
data[].is_public | boolean | Evet | |
data[].limits | object | Evet | |
data[].limits.subscriptions | integer | null | Evet | |
data[].limits.messages_per_month | integer | null | Evet | |
data[].limits.api_rps | integer | null | Evet | |
data[].limits.members | integer | null | Evet | |
data[].limits.apps | integer | null | Evet | |
data[].limits.retention_days | integer | null | Evet | |
data[].limits.journeys | integer | null | Evet | |
data[].limits.segments | integer | null | Evet | |
data[].limits.ab_variants | integer | null | Evet | |
data[].limits.tags_per_user | integer | null | Evet | |
data[].limits.aliases_per_user | integer | null | Evet | |
data[].limits.subscriptions_per_user | integer | null | Evet | |
data[].limits.report_history_days | integer | null | Evet | |
data[].limits.webhooks | integer | null | Evet | |
data[].limits.api_keys | integer | null | Evet | |
data[].features | object | Evet | |
data[].features.journeys | boolean | Evet | |
data[].features.ab_testing | boolean | Evet | |
data[].features.email | boolean | Evet | |
data[].features.sms | boolean | Evet | |
data[].features.in_app | boolean | Evet | |
data[].features.approval_flow | boolean | Evet | |
data[].features.sso | boolean | Evet | |
data[].features.scim | boolean | Hayır | |
data[].features.audit_export | boolean | Evet | |
data[].features.roles | array<string> | Evet | |
data[].purchasable | boolean | Evet |
PortalResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet |
ProvidersReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
totals | object | Evet | |
totals.sent | integer | Evet | |
totals.failed | integer | Evet | |
totals.failure_rate | number | null | Evet | |
previous | object | null | Evet | |
rows | array<object> | Evet | |
rows[].channel | string | Evet | |
rows[].provider | string | null | Evet | |
rows[].sent | integer | Evet | |
rows[].failed | integer | Evet | |
rows[].failure_rate | number | null | Evet | |
rows[].latency_p50_ms | number | null | Evet | |
rows[].latency_p95_ms | number | null | Evet | |
rows[].errors | array<object> | Evet | |
rows[].errors[].code | string | Evet | |
rows[].errors[].count | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/providers
RecentEvents
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].user_id | string | null | Evet | |
data[].subscription_id | string | null | Evet | |
data[].name | string | Evet | |
data[].properties | map<string, any> | Evet | |
data[].value | number | null | Evet | |
data[].source | enum | Evet | Değerler: "sdk", "api", "system", "import" |
data[].occurred_at | string | Evet |
RecoveryCodes
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
recovery_codes | array<string> | Evet |
RenderPreview
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
language | string | Evet | |
title | string | null | Evet | |
subtitle | string | null | Evet | |
body | string | null | Evet | |
url | string | null | Evet | |
image_url | string | null | Evet | |
icon_url | string | null | Evet | |
buttons | array<object> | Evet | |
buttons[].id | string | Evet | |
buttons[].text | string | Evet | |
buttons[].url | string | null | Evet | |
data | map<string, string> | Evet | |
warnings | array<string> | Evet | |
email | object | null | Hayır | |
sms | object | null | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/render
RenderTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Hayır | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs"; Varsayılan: "ios_push" |
language | string | Hayır | Uzunluk: 2–10 |
user | object | Hayır | |
user.external_id | string | Hayır | Uzunluk: 0–255 |
user.tags | map<string, string> | Hayır | |
user.properties | map<string, any> | Hayır | |
custom_data | map<string, any> | Hayır | |
content | object | Hayır | |
content.headings | map<string, string> | Hayır | |
content.contents | map<string, string> | Hayır | |
content.subtitle | map<string, string> | Hayır | |
content.url | string (url) | Hayır | Uzunluk: 0–2000 |
content.app_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.data | map<string, string> | Hayır | |
content.buttons | array<object> | Hayır | Öğe: 0–3 |
content.buttons[].id | string | Evet | Uzunluk: 1–64 |
content.buttons[].text | string | Evet | Uzunluk: 1–100 |
content.buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.big_picture | string (url) | Hayır | Uzunluk: 0–2000 |
content.ios_attachments | map<string, string (url)> | Hayır | |
content.ios_sound | string | Hayır | Uzunluk: 0–100 |
content.ios_badge_type | enum | Hayır | Değerler: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | Hayır | Aralık: 0–99999 |
content.ios_interruption_level | enum | Hayır | Değerler: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | Hayır | Uzunluk: 0–100 |
content.android_channel_id | string | Hayır | Uzunluk: 0–100 |
content.android_group | string | Hayır | Uzunluk: 0–100 |
content.android_sound | string | Hayır | Uzunluk: 0–100 |
content.chrome_web_icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_image | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_badge | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_push_topic | string | Hayır | Uzunluk: 0–32 |
content.content_available | boolean | Hayır | |
content.mutable_content | boolean | Hayır | |
content.custom_data | map<string, any> | Hayır | |
content.email_subject | string | Hayır | Uzunluk: 0–998 |
content.email_body | string | Hayır | Uzunluk: 0–500000 |
content.email_mjml | string | Hayır | Uzunluk: 0–500000 |
content.email_preheader | string | Hayır | Uzunluk: 0–500 |
content.email_from_name | string | Hayır | Uzunluk: 0–200 |
content.email_from_address | string (email) | Hayır | Uzunluk: 0–320 |
content.email_reply_to_address | string (email) | Hayır | Uzunluk: 0–320 |
content.disable_email_click_tracking | boolean | Hayır | |
content.sms_from | string | Hayır | Uzunluk: 1–20 |
content.disable_sms_link_shortening | boolean | Hayır | |
content.add_to_inbox | boolean | Hayır | |
content.inbox_ttl | integer | Hayır | Aralık: 60–31536000 |
content.thread_id | string | Hayır | Uzunluk: 0–100 |
content.ios_relevance_score | number | Hayır | Aralık: 0–1 |
content.target_content_identifier | string | Hayır | Uzunluk: 0–200 |
content.small_icon | string | Hayır | Uzunluk: 0–100 |
content.large_icon | string (url) | string | Hayır | |
content.android_accent_color | string | Hayır | |
content.android_visibility | 1 | 0 | -1 | Hayır | |
content.web_buttons | array<object> | Hayır | Öğe: 0–2 |
content.web_buttons[].id | string | Evet | Uzunluk: 1–64 |
content.web_buttons[].text | string | Evet | Uzunluk: 1–100 |
content.web_buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.require_interaction | boolean | Hayır | |
content.sms_media_urls | array<string (url)> | Hayır | Öğe: 1–10 |
content.whatsapp_template | object | Hayır | |
content.whatsapp_template.name | string | Evet | |
content.whatsapp_template.language | string | Evet | |
content.whatsapp_template.header | object | Hayır | |
content.whatsapp_template.body_params | array<string> | Hayır | Öğe: 0–20 |
content.whatsapp_template.button_params | array<object> | Hayır | Öğe: 0–10 |
content.whatsapp_media | object | Hayır | |
content.whatsapp_media.type | enum | Evet | Değerler: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Evet | Uzunluk: 0–2000 |
content.whatsapp_media.filename | string | Hayır | Uzunluk: 1–240 |
content.whatsapp_interactive | object | Hayır | |
content.whatsapp_interactive.type | enum | Evet | Değerler: "button", "list" |
content.whatsapp_interactive.header | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.footer | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.buttons | array<object> | Hayır | Öğe: 1–3 |
content.whatsapp_interactive.list | object | Hayır | |
content.rcs_card | object | Hayır | |
content.rcs_card.title | map<string, string> | Hayır | |
content.rcs_card.description | map<string, string> | Hayır | |
content.rcs_card.media_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.rcs_card.media_height | enum | Hayır | Değerler: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | Hayır | Değerler: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | Hayır | Öğe: 0–11 |
content.rcs_content_sid | string | Hayır | |
content.rcs_content_variables | map<string, string> | Hayır | |
content.rcs_fallback_text | map<string, string> | Hayır | |
version | integer | Hayır | Aralık: 1–∞ |
Kullanıldığı işlemler: POST /v1/apps/{appId}/templates/{templateId}/render
RequestLog
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
org_id | string | Evet | |
app_id | string | null | Evet | |
api_key_id | string | null | Evet | |
method | string | Evet | |
path | string | Evet | |
route | string | null | Evet | |
status | integer | Evet | |
duration_ms | integer | Evet | |
request_id | string | null | Evet | |
ip | string | null | Evet | |
error_code | string | null | Evet | |
created_at | string | Evet |
RequestLogPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].org_id | string | Evet | |
data[].app_id | string | null | Evet | |
data[].api_key_id | string | null | Evet | |
data[].method | string | Evet | |
data[].path | string | Evet | |
data[].route | string | null | Evet | |
data[].status | integer | Evet | |
data[].duration_ms | integer | Evet | |
data[].request_id | string | null | Evet | |
data[].ip | string | null | Evet | |
data[].error_code | string | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
ResellerChildOrg
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
slug | string | Evet | |
plan_code | string | Evet | |
status | enum | Evet | Değerler: "active", "suspended", "deleted" |
suspended_reason | string | null | Evet | |
members | number | Evet | |
access | enum | Evet | Değerler: "owner", "member", "support", "none" |
region | string | null | Evet | |
created_at | string | Evet |
ResellerChildOrgList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].slug | string | Evet | |
data[].plan_code | string | Evet | |
data[].status | enum | Evet | Değerler: "active", "suspended", "deleted" |
data[].suspended_reason | string | null | Evet | |
data[].members | number | Evet | |
data[].access | enum | Evet | Değerler: "owner", "member", "support", "none" |
data[].region | string | null | Evet | |
data[].created_at | string | Evet |
ResellerStatement
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
month | string | Evet | |
currency | string | Evet | |
items | array<object> | Evet | |
items[].org_id | string | Evet | |
items[].name | string | Evet | |
items[].slug | string | Evet | |
items[].plan_code | string | Evet | |
items[].status | string | Evet | |
items[].amount | number | Evet | |
items[].messages_sent | number | Evet | |
items[].events_ingested | number | Evet | |
items[].api_requests | number | Evet | |
items[].active_subscriptions | number | Evet | |
items[].mau | number | Evet | |
totals | object | Evet | |
totals.amount | number | Evet | |
totals.messages_sent | number | Evet | |
totals.events_ingested | number | Evet | |
totals.child_orgs | number | Evet |
RetentionReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
weeks | integer | Evet | |
cohorts | array<object> | Evet | |
cohorts[].week | string | Evet | |
cohorts[].users | integer | Evet | |
cohorts[].retention | array<number | null> | Evet | |
average | array<number | null> | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/retention
ScheduleCampaignDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
send_at | string (date-time) | Hayır | |
recurrence | object | Hayır | |
recurrence.cron | string | Evet | Uzunluk: 9–100 |
recurrence.until | string (date-time) | null | Hayır | |
recurrence.timezone | string | Hayır | Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/campaigns/{campaignId}/schedule
ScimTokenCreated
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
token | string | Evet | |
scim_base_url | string | Evet | |
data | object | Evet | |
data.id | string | Evet | |
data.name | string | Evet | |
data.prefix | string | Evet | |
data.last_used_at | string | null | Evet | |
data.revoked_at | string | null | Evet | |
data.created_at | string | Evet |
ScimTokenList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].prefix | string | Evet | |
data[].last_used_at | string | null | Evet | |
data[].revoked_at | string | null | Evet | |
data[].created_at | string | Evet |
SdkConfig
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
app_id | string | Evet | |
name | string | Evet | |
api_url | string | Evet | |
cell_id | string | null | Evet | |
identity_verification_required | boolean | Evet | |
identity_verification_mode | enum | Evet | Değerler: "hmac", "jwt", "both" |
platforms | object | Evet | |
platforms.ios | boolean | Evet | |
platforms.android | boolean | Evet | |
platforms.web | boolean | Evet | |
platforms.email | boolean | Evet | |
platforms.sms | boolean | Evet | |
web | object | Evet | |
web.vapid_public_key | string | null | Evet | |
web.allowed_origins | array<string> | Evet | |
web.service_worker_path | string | null | Evet | |
web.service_worker_scope | string | null | Evet | |
web.prompt | object | null | Evet | |
web.welcome_notification | object | null | Evet | |
web.click_behavior | object | null | Evet | |
web.custom_link | object | null | Evet | |
web.prompt_backoff_days | array<integer> | null | Evet | |
session | object | Evet | |
session.timeout_seconds | integer | Evet | |
in_app | object | Evet | |
in_app.min_interval_seconds | integer | Evet | |
android_channels | array<object> | Evet | |
android_channels[].id | string | Evet | |
android_channels[].name | string | Evet | |
android_channels[].description | string | null | Evet | |
android_channels[].importance | enum | Evet | Değerler: "low", "default", "high", "urgent" |
android_channels[].sound | string | null | Evet | |
android_channels[].vibration | boolean | Evet | |
android_channels[].group | string | null | Evet | |
categories | array<object> | Evet | |
categories[].key | string | Evet | |
categories[].name | map<string, string> | Evet | |
categories[].description | map<string, string> | Evet | |
categories[].channels | array<string> | null | Evet | |
categories[].default_opted_in | boolean | Evet |
Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/config
SdkErrorPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].subscription_id | string | null | Evet | |
data[].platform | string | Evet | |
data[].sdk_version | string | null | Evet | |
data[].level | string | Evet | |
data[].code | string | null | Evet | |
data[].message | string | Evet | |
data[].context | map<string, any> | Evet | |
data[].occurred_at | string | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
SdkErrorsAccepted
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
accepted | integer | Evet |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/errors
SdkErrorsDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
errors | array<object> | Evet | Öğe: 1–20 |
errors[].level | enum | Hayır | Değerler: "error", "warning"; Varsayılan: "error" |
errors[].platform | enum | Evet | Değerler: "web", "android", "ios", "flutter", "react_native", "node" |
errors[].sdk_version | string | Hayır | Uzunluk: 0–50 |
errors[].code | string | Hayır | Uzunluk: 0–100 |
errors[].message | string | Evet | Uzunluk: 1–2000 |
errors[].subscription_id | string | Hayır | Uzunluk: 0–64 |
errors[].context | map<string, any> | Hayır | |
errors[].occurred_at | string (date-time) | Hayır |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/errors
SdkEventsDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
events | array<object> | Evet | Öğe: 1–100 |
events[].name | string | Evet | Uzunluk: 1–100 |
events[].properties | map<string, any> | Hayır | Varsayılan: {} |
events[].value | number | Hayır | |
events[].occurred_at | string (date-time) | Hayır | |
events[].event_id | string | Hayır | Uzunluk: 8–64 |
events[].subscription_id | string | Hayır | Uzunluk: 1–∞ |
events[].external_id | string | Hayır | Uzunluk: 1–255 |
events[].token_hash | string | Hayır | |
events[].identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/events
SdkIdentityDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
identity | map<string, string> | Evet | |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/users/{userId}/identity
SdkIdentityResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
identity | map<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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscription_id | string | Evet | Uzunluk: 1–64 |
token_hash | string | Hayır | |
type | enum | Evet | Değerler: "impression", "click", "dismiss" |
button_id | string | Hayır | Uzunluk: 0–64 |
variant_id | string | Hayır | Uzunluk: 0–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/in-app/{messageId}/events
SdkInAppList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].priority | integer | Evet | |
data[].triggers | array<object> | Evet | |
data[].trigger_groups | array<array<object>> | Evet | |
data[].variant_id | string | null | Evet | |
data[].display | object | Evet | |
data[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | null | Evet | |
data[].display.text_color | string | null | Evet | |
data[].display.dismissible | boolean | Evet | |
data[].display.auto_dismiss_seconds | integer | null | Evet | |
data[].display.content_type | enum | Evet | Değerler: "blocks", "html" |
data[].display.html | string | null | Evet | |
data[].display.html_height | integer | null | Evet | |
data[].display.blocks | array<object> | Evet | |
data[].remaining_impressions | integer | Evet | |
data[].min_interval_seconds | integer | Evet | |
data[].stop_after_interaction | boolean | Evet | |
data[].last_impression_at | string | null | Evet | |
data[].end_at | string | null | Evet | |
language | string | Evet |
Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/in-app
SdkInboxActionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscription_id | string | Evet | Uzunluk: 1–64 |
identity_hash | string | Hayır | Uzunluk: 0–128 |
token_hash | string | Hayı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscription_id | string | Evet | Uzunluk: 1–64 |
activity_type | string | Evet | Uzunluk: 1–100 |
kind | enum | Evet | Değerler: "push_to_start", "update" |
activity_id | string | Hayır | Uzunluk: 1–100 |
token_hash | string | Hayır | Uzunluk: 64–64 |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/live-activities/tokens/delete
SdkLiveActivityTokenDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscription_id | string | Evet | Uzunluk: 1–64 |
activity_type | string | Evet | Uzunluk: 1–100 |
kind | enum | Evet | Değerler: "push_to_start", "update" |
activity_id | string | Hayır | Uzunluk: 1–100 |
token | string | Evet | |
token_hash | string | Hayır | Uzunluk: 64–64 |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/live-activities/tokens
SdkLoginDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
external_id | string | Evet | Uzunluk: 1–255 |
identity_hash | string | Hayır | Uzunluk: 64–64 |
token_hash | string | Hayır |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/login
SdkLogoutDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
token_hash | string | Hayır | |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logout
SdkPreferences
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].category | string | Evet | |
data[].channel | string | null | Evet | |
data[].opted_in | boolean | Evet | |
data[].explicit | boolean | Evet | |
data[].source | string | null | Evet | |
data[].updated_at | string | null | Evet | |
categories | array<object> | Evet | |
categories[].key | string | Evet | |
categories[].name | map<string, string> | Evet | |
categories[].description | map<string, string> | Evet | |
categories[].channels | array<string> | null | Evet | |
categories[].default_opted_in | boolean | Evet |
Kullanıldığı işlemler: GET /sdk/v1/apps/{appId}/preferences, PUT /sdk/v1/apps/{appId}/preferences
SdkRegisterDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
token | string | Evet | Uzunluk: 1–4096 |
device | object | Hayır | Varsayılan: {} |
device.model | string | Hayır | Uzunluk: 0–100 |
device.os | string | Hayır | Uzunluk: 0–50 |
device.os_version | string | Hayır | Uzunluk: 0–50 |
device.app_version | string | null | Hayır | |
device.sdk_version | string | Hayır | Uzunluk: 0–50 |
device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
device.carrier | string | Hayır | Uzunluk: 0–100 |
device.locale | string | Hayır | Uzunluk: 0–20 |
device.timezone | string | Hayır | Uzunluk: 0–64 |
device.push_capable | boolean | Hayır | |
device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
test_device | boolean | Hayır | |
user | object | Hayır | |
user.external_id | string | Hayır | Uzunluk: 1–255 |
user.identity_hash | string | Hayır | Uzunluk: 64–64 |
user.tags | map<string, string> | Hayır | |
user.properties | map<string, any> | Hayır | |
user.subscription_id | string | Hayır | Uzunluk: 1–64 |
user.token_hash | string | Hayır | |
ownership_proof | boolean | Hayır |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions
SdkRegisterResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscription_id | string | Evet | |
user_id | string | Evet | |
external_id | string | null | Evet | |
status | enum | Evet | Değerler: "subscribed", "unsubscribed", "invalid", "pending" |
created | boolean | Evet |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/subscriptions
SdkSecret
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
sdk_secret | string | Evet | |
identity_verification_required | boolean | Evet |
SdkSessionDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
token_hash | string | Hayır | |
identity_hash | string | Hayır | Uzunluk: 64–64 |
subscription_id | string | Evet | Uzunluk: 1–∞ |
duration_seconds | integer | Hayır | Aralık: 0–604800 |
app_version | string | null | Hayır | |
sdk_version | string | Hayır | Uzunluk: 0–50 |
Kullanıldığı işlemler: POST /sdk/v1/apps/{appId}/sessions
SdkSetPreferencesDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
preferences | array<object> | Evet | Öğe: 1–100 |
preferences[].category | string | Evet | Uzunluk: 1–64 |
preferences[].channel | enum | null | Hayır | |
preferences[].opted_in | boolean | Evet | |
subscription_id | string | Evet | Uzunluk: 1–64 |
token_hash | string | Hayır | |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: PUT /sdk/v1/apps/{appId}/preferences
SdkSubscriptionPatchDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
token_hash | string | Hayır | |
identity_hash | string | Hayır | Uzunluk: 64–64 |
token | string | Hayır | Uzunluk: 1–4096 |
device | object | Hayır | |
device.model | string | Hayır | Uzunluk: 0–100 |
device.os | string | Hayır | Uzunluk: 0–50 |
device.os_version | string | Hayır | Uzunluk: 0–50 |
device.app_version | string | null | Hayır | |
device.sdk_version | string | Hayır | Uzunluk: 0–50 |
device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
device.carrier | string | Hayır | Uzunluk: 0–100 |
device.locale | string | Hayır | Uzunluk: 0–20 |
device.timezone | string | Hayır | Uzunluk: 0–64 |
device.push_capable | boolean | Hayır | |
device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
opted_in | boolean | Hayır | |
location | object | null | Hayır |
Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}
SdkUserPatchDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
tags | map<string, string | null> | Hayır | |
properties | map<string, any> | Hayır | |
deltas | object | Hayır | |
deltas.session_count | integer | Hayır | Aralık: -1000000–1000000 |
deltas.session_time | integer | Hayır | Aralık: 0–31536000 |
deltas.purchases | array<object> | Hayır | Öğe: 0–100 |
deltas.purchases[].sku | string | Evet | Uzunluk: 1–100 |
deltas.purchases[].amount | number | Evet | Aralık: 0–∞ |
deltas.purchases[].iso | string | Hayır | Uzunluk: 3–3 |
deltas.purchases[].count | integer | Hayır | Varsayılan: 1; Aralık: 1–1000 |
identity_hash | string | Hayır | Uzunluk: 64–64 |
Kullanıldığı işlemler: PATCH /sdk/v1/apps/{appId}/users/{userId}
SdkUserResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
user_id | string | Evet | |
external_id | string | null | Evet | |
tags | map<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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
description | string | null | Evet | |
definition | map<string, any> | Evet | |
is_dynamic | boolean | Evet | |
estimated_count | integer | null | Evet | |
estimated_at | string | null | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].status | string | Evet | |
data[].type | string | Evet | |
data[].usage | enum | Evet | Değerler: "include", "exclude" |
data[].created_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/segments/{segmentId}/campaigns
SegmentEstimate
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
segment_id | string | null | Evet | |
subscriptions | integer | Evet | |
users | integer | Evet | |
estimated_at | string | Evet | |
cached | boolean | Evet | |
sampled | boolean | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/segments/{segmentId}/estimate
SegmentPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].description | string | null | Evet | |
data[].definition | map<string, any> | Evet | |
data[].is_dynamic | boolean | Evet | |
data[].estimated_count | integer | null | Evet | |
data[].estimated_at | string | null | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/segments
SegmentPreview
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
subscriptions | integer | Evet | |
users | integer | Evet | |
sampled | boolean | Evet | |
sample | array<object> | Evet | |
sample[].id | string | Evet | |
sample[].external_id | string | null | Evet | |
sample[].tags | map<string, string> | Evet | |
sample[].last_active_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/segments/preview
SelectWinnerDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
variant_id | string | Evet | Uzunluk: 1–∞ |
Kullanıldığı işlemler: POST /v1/apps/{appId}/campaigns/{campaignId}/winner
SessionList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].ip | string | null | Evet | |
data[].user_agent | string | null | Evet | |
data[].created_at | string | Evet | |
data[].last_seen_at | string | Evet | |
data[].expires_at | string | Evet | |
data[].current | boolean | Evet |
SetOwnerDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
external_id | string | Evet | Uzunluk: 1–255 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/subscriptions/{subscriptionId}/owner
SetPreferencesDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
preferences | array<object> | Evet | Öğe: 1–100 |
preferences[].category | string | Evet | Uzunluk: 1–64 |
preferences[].channel | enum | null | Hayır | |
preferences[].opted_in | boolean | Evet |
Kullanıldığı işlemler: PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences
SmsKeyword
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
keyword | string | Evet | |
scope | enum | Evet | Değerler: "org", "app" |
app_id | string | null | Evet | |
channels | array<enum> | Evet | |
actions | map<string, any> | Evet | |
enabled | boolean | Evet | |
description | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/sms-keywords, PATCH /v1/apps/{appId}/sms-keywords/{keywordId}
SmsKeywordList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].keyword | string | Evet | |
data[].scope | enum | Evet | Değerler: "org", "app" |
data[].app_id | string | null | Evet | |
data[].channels | array<enum> | Evet | |
data[].actions | map<string, any> | Evet | |
data[].enabled | boolean | Evet | |
data[].description | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
reserved | array<string> | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/sms-keywords
SsoConnection
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
type | enum | Evet | Değerler: "saml", "oidc" |
name | string | Evet | |
status | enum | Evet | Değerler: "draft", "active", "disabled" |
config | object | Evet | |
config.idp_entity_id | string | Hayır | Uzunluk: 1–500 |
config.idp_sso_url | string (uri) | Hayır | Uzunluk: 0–2000 |
config.idp_certificates | array<string> | Hayır | Öğe: 0–3 |
config.allow_idp_initiated | boolean | Hayır | |
config.groups_attribute | string | Hayır | Uzunluk: 0–200 |
config.email_attribute | string | Hayır | Uzunluk: 0–200 |
config.name_attribute | string | Hayır | Uzunluk: 0–200 |
config.issuer | string (uri) | Hayır | Uzunluk: 0–2000 |
config.client_id | string | Hayır | Uzunluk: 1–500 |
config.authorization_endpoint | string (uri) | Hayır | Uzunluk: 0–2000 |
config.token_endpoint | string (uri) | Hayır | Uzunluk: 0–2000 |
config.jwks_uri | string (uri) | Hayır | Uzunluk: 0–2000 |
config.scopes | array<string> | Hayır | Öğe: 0–20 |
config.groups_claim | string | Hayır | Uzunluk: 0–200 |
has_client_secret | boolean | Evet | |
default_role | string | Evet | |
group_role_map | map<string, string> | Evet | |
jit_enabled | boolean | Evet | |
last_login_at | string | null | Evet | |
sp | object | Evet | |
sp.entity_id | string | Evet | |
sp.acs_url | string | Evet | |
sp.metadata_url | string | Evet | |
sp.redirect_uri | string | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
SsoConnectionList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].type | enum | Evet | Değerler: "saml", "oidc" |
data[].name | string | Evet | |
data[].status | enum | Evet | Değerler: "draft", "active", "disabled" |
data[].config | object | Evet | |
data[].config.idp_entity_id | string | Hayır | Uzunluk: 1–500 |
data[].config.idp_sso_url | string (uri) | Hayır | Uzunluk: 0–2000 |
data[].config.idp_certificates | array<string> | Hayır | Öğe: 0–3 |
data[].config.allow_idp_initiated | boolean | Hayır | |
data[].config.groups_attribute | string | Hayır | Uzunluk: 0–200 |
data[].config.email_attribute | string | Hayır | Uzunluk: 0–200 |
data[].config.name_attribute | string | Hayır | Uzunluk: 0–200 |
data[].config.issuer | string (uri) | Hayır | Uzunluk: 0–2000 |
data[].config.client_id | string | Hayır | Uzunluk: 1–500 |
data[].config.authorization_endpoint | string (uri) | Hayır | Uzunluk: 0–2000 |
data[].config.token_endpoint | string (uri) | Hayır | Uzunluk: 0–2000 |
data[].config.jwks_uri | string (uri) | Hayır | Uzunluk: 0–2000 |
data[].config.scopes | array<string> | Hayır | Öğe: 0–20 |
data[].config.groups_claim | string | Hayır | Uzunluk: 0–200 |
data[].has_client_secret | boolean | Evet | |
data[].default_role | string | Evet | |
data[].group_role_map | map<string, string> | Evet | |
data[].jit_enabled | boolean | Evet | |
data[].last_login_at | string | null | Evet | |
data[].sp | object | Evet | |
data[].sp.entity_id | string | Evet | |
data[].sp.acs_url | string | Evet | |
data[].sp.metadata_url | string | Evet | |
data[].sp.redirect_uri | string | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
SsoDiscoverResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
sso | boolean | Evet | |
type | enum | null | Evet | |
start_url | string | null | Evet |
SsoDomain
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
domain | string | Evet | |
verified | boolean | Evet | |
verified_at | string | null | Evet | |
last_checked_at | string | null | Evet | |
txt_record | object | Evet | |
txt_record.name | string | Evet | |
txt_record.value | string | Evet | |
created_at | string | Evet |
SsoDomainList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].domain | string | Evet | |
data[].verified | boolean | Evet | |
data[].verified_at | string | null | Evet | |
data[].last_checked_at | string | null | Evet | |
data[].txt_record | object | Evet | |
data[].txt_record.name | string | Evet | |
data[].txt_record.value | string | Evet | |
data[].created_at | string | Evet |
SsoSettings
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
enforced | boolean | Evet | |
available | boolean | Evet | |
scim_available | boolean | Evet | |
recovery_codes | array<string> | Hayır | |
recovery_codes_remaining | integer | null | Evet |
SsoTestResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
connection_id | string | Evet | |
ok | boolean | Evet | |
error | string | null | Evet | |
email | string | null | Evet | |
name | string | null | Evet | |
groups | array<string> | Evet | |
mapped_role | string | null | Evet | |
domain_verified | boolean | Evet | |
account_exists | boolean | Evet | |
member | boolean | Evet | |
claims | map<string, any> | Evet | |
tested_at | string | Evet |
SsoTestStart
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet |
StartLiveActivityDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
activity_id | string | Hayır | Uzunluk: 1–100 |
attributes | map<string, string | number | boolean> | Hayır | |
target | object | Evet | |
target.include_external_ids | array<string> | Hayır | Öğe: 0–2000 |
target.include_subscription_ids | array<string> | Hayır | Öğe: 0–2000 |
target.included_segments | array<string> | Hayır | Öğe: 0–20 |
target.all | boolean | Hayır | |
content_state | map<string, string | number | boolean> | Evet | |
alert | object | Hayır | |
alert.title | map<string, string> | Hayır | |
alert.body | map<string, string> | Hayır | |
alert.sound | string | Hayır | Uzunluk: 0–100 |
stale_date | integer | Hayır | Aralık: 0–4102444800 |
dismissal_date | integer | Hayır | Aralık: 0–4102444800 |
relevance_score | number | Hayır | Aralık: 0–1 |
priority | 5 | 10 | Hayır | |
name | string | Hayır | Uzunluk: 0–200 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/start
StatusTokenResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | boolean | Evet |
Subscription
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
user_id | string | null | Evet | |
channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
token | string | Evet | |
status | enum | Evet | Değerler: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Evet | |
device | object | Evet | |
device.model | string | Hayır | Uzunluk: 0–100 |
device.os | string | Hayır | Uzunluk: 0–50 |
device.os_version | string | Hayır | Uzunluk: 0–50 |
device.app_version | string | null | Hayır | |
device.sdk_version | string | Hayır | Uzunluk: 0–50 |
device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
device.carrier | string | Hayır | Uzunluk: 0–100 |
device.locale | string | Hayır | Uzunluk: 0–20 |
device.timezone | string | Hayır | Uzunluk: 0–64 |
device.push_capable | boolean | Hayır | |
device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
test_device | boolean | Evet | |
test_device_name | string | null | Evet | |
last_active_at | string | Evet | |
last_sent_at | string | null | Evet | |
last_delivered_at | string | null | Evet | |
opted_in_at | string | null | Evet | |
opt_in_source | string | null | Evet | |
unsubscribed_at | string | null | Evet | |
location | object | null | Evet | |
created_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].user_id | string | null | Evet | |
data[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
data[].token | string | Evet | |
data[].status | enum | Evet | Değerler: "subscribed", "unsubscribed", "invalid", "pending" |
data[].unsubscribe_reason | enum | null | Evet | |
data[].device | object | Evet | |
data[].device.model | string | Hayır | Uzunluk: 0–100 |
data[].device.os | string | Hayır | Uzunluk: 0–50 |
data[].device.os_version | string | Hayır | Uzunluk: 0–50 |
data[].device.app_version | string | null | Hayır | |
data[].device.sdk_version | string | Hayır | Uzunluk: 0–50 |
data[].device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
data[].device.carrier | string | Hayır | Uzunluk: 0–100 |
data[].device.locale | string | Hayır | Uzunluk: 0–20 |
data[].device.timezone | string | Hayır | Uzunluk: 0–64 |
data[].device.push_capable | boolean | Hayır | |
data[].device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
data[].test_device | boolean | Evet | |
data[].test_device_name | string | null | Evet | |
data[].last_active_at | string | Evet | |
data[].last_sent_at | string | null | Evet | |
data[].last_delivered_at | string | null | Evet | |
data[].opted_in_at | string | null | Evet | |
data[].opt_in_source | string | null | Evet | |
data[].unsubscribed_at | string | null | Evet | |
data[].location | object | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
SubscriptionsReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
from | string | Evet | |
to | string | Evet | |
totals | object | Evet | |
totals.active | integer | Evet | |
totals.new | integer | Evet | |
totals.unsubscribed | integer | Evet | |
totals.opt_outs | integer | Evet | |
totals.net | integer | Evet | |
previous | object | null | Evet | |
rows | array<object> | Evet | |
rows[].date | string | Evet | |
rows[].new | integer | Evet | |
rows[].unsubscribed | integer | Evet | |
rows[].opt_outs | integer | Evet | |
rows[].net | integer | Evet | |
by_channel | array<object> | Evet | |
by_channel[].channel | string | Evet | |
by_channel[].active | integer | Evet | |
by_channel[].new | integer | Evet | |
by_channel[].unsubscribed | integer | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/analytics/subscriptions
Suppression
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
channel | enum | Evet | Değerler: "email", "sms", "whatsapp", "rcs" |
value_masked | string | Evet | |
reason | enum | Evet | Değerler: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
source | string | Evet | |
detail | map<string, any> | Evet | |
expires_at | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/suppressions
SuppressionPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].channel | enum | Evet | Değerler: "email", "sms", "whatsapp", "rcs" |
data[].value_masked | string | Evet | |
data[].reason | enum | Evet | Değerler: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
data[].source | string | Evet | |
data[].detail | map<string, any> | Evet | |
data[].expires_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/suppressions
Template
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
channel | enum | null | Evet | |
current_version | integer | Evet | |
tags | array<string> | Evet | |
content | map<string, any> | Evet | |
created_by | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].channel | enum | null | Evet | |
data[].current_version | integer | Evet | |
data[].tags | array<string> | Evet | |
data[].content | map<string, any> | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/templates
TemplateStats
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
template_id | string | Evet | |
messages | integer | Evet | |
campaigns | integer | Evet | |
targeted | integer | Evet | |
sent | integer | Evet | |
delivered | integer | Evet | |
opened | integer | Evet | |
clicked | integer | Evet | |
converted | integer | Evet | |
open_rate | number | Evet | |
click_rate | number | Evet | |
conversion_rate | number | Evet | |
last_used_at | string | null | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/templates/{templateId}/stats
TemplateVersionList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].version | integer | Evet | |
data[].content | map<string, any> | Evet | |
data[].created_by | string | null | Evet | |
data[].created_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/templates/{templateId}/versions
TestDataFeedDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
external_id | string | Hayır | Uzunluk: 1–256 |
user_id | string | Hayır | Uzunluk: 1–64 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/data-feeds/{feedId}/test
TraceResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
query | string | Evet | |
kind | string | Evet | |
items | array<object> | Evet | |
items[].delivery | object | Evet | |
items[].delivery.id | string | Evet | |
items[].delivery.message_id | string | Evet | |
items[].delivery.subscription_id | string | Evet | |
items[].delivery.user_id | string | null | Evet | |
items[].delivery.channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
items[].delivery.provider | string | null | Evet | |
items[].delivery.status | enum | Evet | Değerler: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
items[].delivery.attempt_count | integer | Evet | |
items[].delivery.provider_message_id | string | null | Evet | |
items[].delivery.error_code | string | null | Evet | |
items[].delivery.error_message | string | null | Evet | |
items[].delivery.suppression_reason | string | null | Evet | |
items[].delivery.send_after | string | null | Evet | |
items[].delivery.sent_at | string | null | Evet | |
items[].delivery.delivered_at | string | null | Evet | |
items[].delivery.opened_at | string | null | Evet | |
items[].delivery.clicked_at | string | null | Evet | |
items[].delivery.failed_at | string | null | Evet | |
items[].delivery.created_at | string | Evet | |
items[].events | array<object> | Evet | |
items[].events[].id | string | Evet | |
items[].events[].type | string | Evet | |
items[].events[].detail | map<string, any> | Evet | |
items[].events[].occurred_at | string | Evet | |
items[].subscription | object | null | Evet | |
items[].user | object | null | Evet | |
items[].render | object | null | Evet | |
items[].webhooks | array<object> | Evet | |
items[].webhooks[].id | string | Evet | |
items[].webhooks[].endpoint_id | string | Evet | |
items[].webhooks[].event_type | string | Evet | |
items[].webhooks[].status | string | Evet | |
items[].webhooks[].attempt | integer | Evet | |
items[].webhooks[].response_status | integer | null | Evet | |
items[].webhooks[].created_at | string | Evet | |
items[].message | object | null | Evet |
TriggerRunDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
external_id | string | Hayır | Uzunluk: 1–255 |
user_id | string | Hayır | Uzunluk: 1–64 |
alias | object | Hayır | |
alias.label | string | Evet | Uzunluk: 1–50 |
alias.value | string | Evet | Uzunluk: 1–255 |
context | map<string, any> | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/journeys/{journeyId}/runs
UpdateApiKeyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 2–100 |
scopes | array<enum> | Hayır | Öğe: 1–8 |
ip_allowlist | array<string> | Hayır | Öğe: 0–50 |
expires_at | string (date-time) | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/api-keys/{keyId}
UpdateAppDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 2–100 |
platform_flags | object | Hayır | |
platform_flags.ios | boolean | Hayır | |
platform_flags.android | boolean | Hayır | |
platform_flags.web | boolean | Hayır | |
platform_flags.email | boolean | Hayır | |
platform_flags.sms | boolean | Hayır | |
icon_url | string (uri) | null | Hayır | |
default_language | string | Hayır | Uzunluk: 2–10 |
timezone | string | Hayır | Uzunluk: 1–64 |
settings | object | Hayır | |
settings.quietHours | object | null | Hayır | |
settings.frequencyCap | object | null | Hayır | |
settings.frequencyCaps | array<object> | Hayır | Öğe: 0–10 |
settings.frequencyCaps[].max | integer | Evet | Aralık: 1–1000 |
settings.frequencyCaps[].window | object | Evet | |
settings.frequencyCaps[].channels | array<enum> | Hayır | Öğe: 1–8 |
settings.inApp | object | Hayır | |
settings.inApp.minIntervalSeconds | integer | Hayır | Aralık: 0–604800 |
settings.androidChannels | array<object> | Hayır | Öğe: 0–50 |
settings.androidChannels[].id | string | Evet | Uzunluk: 1–64 |
settings.androidChannels[].name | string | Evet | Uzunluk: 1–60 |
settings.androidChannels[].description | string | Hayır | Uzunluk: 0–200 |
settings.androidChannels[].importance | enum | Evet | Değerler: "low", "default", "high", "urgent" |
settings.androidChannels[].sound | string | Hayır | Uzunluk: 0–64 |
settings.androidChannels[].vibration | boolean | Hayır | |
settings.androidChannels[].group | string | Hayır | Uzunluk: 0–64 |
settings.sms | object | Hayır | |
settings.sms.helpReply | string | Hayır | Uzunluk: 0–320 |
settings.sms.stopReply | string | Hayır | Uzunluk: 0–320 |
settings.sms.autoReply | boolean | Hayır | |
settings.preferenceCenter | object | Hayır | |
settings.preferenceCenter.enabled | boolean | Hayır | |
settings.preferenceCenter.brandName | string | Hayır | Uzunluk: 0–80 |
settings.preferenceCenter.logoUrl | string (url) | Hayır | Uzunluk: 0–2000 |
settings.preferenceCenter.accentColor | string | Hayır | |
settings.preferenceCenter.customUnsubscribeUrl | string (url) | Hayır | Uzunluk: 0–2000 |
settings.preferenceCenter.texts | map<string, object> | Hayır | |
settings.defaultTtlSeconds | integer | Hayır | Aralık: 60–2419200 |
settings.identityVerificationRequired | boolean | Hayır | |
settings.allowedOrigins | array<string> | Hayır | Öğe: 0–50 |
settings.campaignApprovalRequired | boolean | Hayır | |
settings.webPush | object | Hayır | |
settings.webPush.serviceWorkerPath | string | Hayır | Uzunluk: 0–200 |
settings.webPush.serviceWorkerScope | string | Hayır | Uzunluk: 0–200 |
settings.webPush.prompt | object | Hayır | |
settings.webPush.welcomeNotification | object | Hayır | |
settings.webPush.clickBehavior | object | Hayır | |
settings.webPush.customLink | object | Hayır | |
settings.webPush.promptBackoffDays | array<integer> | Hayır | Öğe: 0–10 |
settings.onboarding | object | Hayır | |
settings.onboarding.step | integer | Evet | Aralık: 0–6 |
settings.onboarding.simulation | boolean | Hayır | |
settings.onboarding.completed_at | string | null | Hayır | |
settings.onboarding.version | integer | Hayır | Aralık: 1–100 |
settings.onboarding.platforms | array<enum> | Hayır | Öğe: 0–4 |
settings.onboarding.framework | enum | Hayır | Değerler: "native", "flutter", "react-native", "unity", "capacitor", "cordova", "maui" |
settings.onboarding.web_integration | enum | Hayır | Değerler: "code", "wordpress" |
settings.sdkSetup | object | null | Hayır | |
identity_verification_mode | enum | Hayır | Değerler: "hmac", "jwt", "both" |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}
UpdateCategoryDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | map<string, string> | Hayır | |
description | map<string, string> | Hayır | |
channels | array<enum> | null | Hayır | |
default_opted_in | boolean | Hayır | |
position | integer | Hayır | Aralık: 0–1000 |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/categories/{categoryId}
UpdateContentTableDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
description | string | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/content-tables/{tableId}
UpdateDataFeedDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
description | string | null | Hayır | |
url_template | string | Hayır | Uzunluk: 1–2048 |
method | enum | Hayır | Değerler: "GET", "POST" |
body_template | string | null | Hayır | |
headers | map<string, string> | Hayır | |
secret_headers | map<string, string> | null | Hayır | |
cache_ttl_seconds | integer | Hayır | Aralık: 0–86400 |
timeout_ms | integer | Hayır | Aralık: 100–2000 |
enabled | boolean | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/data-feeds/{feedId}
UpdateInAppDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 2–100 |
triggers | array<object> | Hayır | Öğe: 1–5 |
trigger_groups | array<array<object>> | Hayır | Öğe: 1–10 |
variants | array<object> | Hayır | Öğe: 0–10 |
variants[].id | string | Evet | Uzunluk: 1–64 |
variants[].name | string | Evet | Uzunluk: 1–60 |
variants[].weight_percent | integer | Evet | Aralık: 1–99 |
variants[].display | object | Evet | |
variants[].display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | Hayır | |
variants[].display.text_color | string | Hayır | |
variants[].display.dismissible | boolean | Hayır | |
variants[].display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
variants[].display.content_type | enum | Hayır | Değerler: "blocks", "html" |
variants[].display.html | map<string, string> | Hayır | |
variants[].display.html_height | integer | Hayır | Aralık: 40–2000 |
variants[].display.blocks | array<object> | Evet | Öğe: 0–12 |
ab_test | object | Hayır | |
ab_test.winner | object | Hayır | |
ab_test.winner.mode | enum | Evet | Değerler: "manual", "auto" |
ab_test.winner.min_impressions | integer | Hayır | Aralık: 10–1000000 |
ab_test.winner.confidence | number | Hayır | Aralık: 0.8–0.99 |
display | object | Hayır | |
display.layout | enum | Evet | Değerler: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | Hayır | |
display.text_color | string | Hayır | |
display.dismissible | boolean | Hayır | |
display.auto_dismiss_seconds | integer | Hayır | Aralık: 1–120 |
display.content_type | enum | Hayır | Değerler: "blocks", "html" |
display.html | map<string, string> | Hayır | |
display.html_height | integer | Hayır | Aralık: 40–2000 |
display.blocks | array<object> | Evet | Öğe: 0–12 |
audience | object | Hayır | |
audience.included_segments | array<string> | Hayır | Öğe: 0–20 |
audience.excluded_segments | array<string> | Hayır | Öğe: 0–20 |
frequency | object | Hayır | |
frequency.max_impressions | integer | Hayır | Aralık: 1–1000 |
frequency.min_interval_seconds | integer | Hayır | Aralık: 0–31536000 |
frequency.stop_after_interaction | boolean | Hayır | |
journey_only | boolean | Hayır | |
priority | integer | Hayır | Aralık: 0–100 |
start_at | string (date-time) | null | Hayır | |
end_at | string (date-time) | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/in-app-messages/{messageId}
UpdateJourneyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 2–120 |
description | string | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/journeys/{journeyId}
UpdateKeywordDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
keyword | string | Hayır | Uzunluk: 1–30 |
channels | array<enum> | Hayır | Öğe: 1–3 |
actions | object | Hayır | |
actions.add_tags | map<string, string> | Hayır | |
actions.remove_tags | array<string> | Hayır | Öğe: 0–50 |
actions.event | object | Hayır | |
actions.event.name | string | Evet | |
actions.event.properties | map<string, string> | Hayır | |
actions.reply | object | Hayır | |
actions.reply.text | string | Evet | Uzunluk: 1–1600 |
actions.opt_in | boolean | Hayır | |
enabled | boolean | Hayır | |
description | string | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/sms-keywords/{keywordId}
UpdateLiveActivityDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
activity_id | string | Evet | Uzunluk: 1–100 |
content_state | map<string, string | number | boolean> | Evet | |
alert | object | Hayır | |
alert.title | map<string, string> | Hayır | |
alert.body | map<string, string> | Hayır | |
alert.sound | string | Hayır | Uzunluk: 0–100 |
stale_date | integer | Hayır | Aralık: 0–4102444800 |
dismissal_date | integer | Hayır | Aralık: 0–4102444800 |
relevance_score | number | Hayır | Aralık: 0–1 |
priority | 5 | 10 | Hayır | |
name | string | Hayır | Uzunluk: 0–200 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/live-activities/{activityType}/update
UpdateLiveActivityTypeDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
description | string | null | Hayır | |
content_state_schema | object | Hayır | |
content_state_schema.type | "object" | Evet | |
content_state_schema.properties | map<string, object> | Evet | |
content_state_schema.required | array<string> | Hayır | Öğe: 0–50 |
attributes_schema | object | Hayır | |
attributes_schema.type | "object" | Evet | |
attributes_schema.properties | map<string, object> | Evet | |
attributes_schema.required | array<string> | Hayır | Öğe: 0–50 |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/live-activities/types/{activityType}
UpdateNodeDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | map<string, any> | Hayır | |
position | object | Hayır | |
position.x | number | Evet | |
position.y | number | Evet |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}
UpdateTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 2–100 |
channel | enum | null | Hayır | |
tags | array<string> | Hayır | Öğe: 0–20 |
content | object | Hayır | |
content.headings | map<string, string> | Hayır | |
content.contents | map<string, string> | Hayır | |
content.subtitle | map<string, string> | Hayır | |
content.url | string (url) | Hayır | Uzunluk: 0–2000 |
content.app_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.data | map<string, string> | Hayır | |
content.buttons | array<object> | Hayır | Öğe: 0–3 |
content.buttons[].id | string | Evet | Uzunluk: 1–64 |
content.buttons[].text | string | Evet | Uzunluk: 1–100 |
content.buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.big_picture | string (url) | Hayır | Uzunluk: 0–2000 |
content.ios_attachments | map<string, string (url)> | Hayır | |
content.ios_sound | string | Hayır | Uzunluk: 0–100 |
content.ios_badge_type | enum | Hayır | Değerler: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | Hayır | Aralık: 0–99999 |
content.ios_interruption_level | enum | Hayır | Değerler: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | Hayır | Uzunluk: 0–100 |
content.android_channel_id | string | Hayır | Uzunluk: 0–100 |
content.android_group | string | Hayır | Uzunluk: 0–100 |
content.android_sound | string | Hayır | Uzunluk: 0–100 |
content.chrome_web_icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_image | string (url) | Hayır | Uzunluk: 0–2000 |
content.chrome_web_badge | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_push_topic | string | Hayır | Uzunluk: 0–32 |
content.content_available | boolean | Hayır | |
content.mutable_content | boolean | Hayır | |
content.custom_data | map<string, any> | Hayır | |
content.email_subject | string | Hayır | Uzunluk: 0–998 |
content.email_body | string | Hayır | Uzunluk: 0–500000 |
content.email_mjml | string | Hayır | Uzunluk: 0–500000 |
content.email_preheader | string | Hayır | Uzunluk: 0–500 |
content.email_from_name | string | Hayır | Uzunluk: 0–200 |
content.email_from_address | string (email) | Hayır | Uzunluk: 0–320 |
content.email_reply_to_address | string (email) | Hayır | Uzunluk: 0–320 |
content.disable_email_click_tracking | boolean | Hayır | |
content.sms_from | string | Hayır | Uzunluk: 1–20 |
content.disable_sms_link_shortening | boolean | Hayır | |
content.add_to_inbox | boolean | Hayır | |
content.inbox_ttl | integer | Hayır | Aralık: 60–31536000 |
content.thread_id | string | Hayır | Uzunluk: 0–100 |
content.ios_relevance_score | number | Hayır | Aralık: 0–1 |
content.target_content_identifier | string | Hayır | Uzunluk: 0–200 |
content.small_icon | string | Hayır | Uzunluk: 0–100 |
content.large_icon | string (url) | string | Hayır | |
content.android_accent_color | string | Hayır | |
content.android_visibility | 1 | 0 | -1 | Hayır | |
content.web_buttons | array<object> | Hayır | Öğe: 0–2 |
content.web_buttons[].id | string | Evet | Uzunluk: 1–64 |
content.web_buttons[].text | string | Evet | Uzunluk: 1–100 |
content.web_buttons[].icon | string (url) | Hayır | Uzunluk: 0–2000 |
content.web_buttons[].url | string (url) | Hayır | Uzunluk: 0–2000 |
content.require_interaction | boolean | Hayır | |
content.sms_media_urls | array<string (url)> | Hayır | Öğe: 1–10 |
content.whatsapp_template | object | Hayır | |
content.whatsapp_template.name | string | Evet | |
content.whatsapp_template.language | string | Evet | |
content.whatsapp_template.header | object | Hayır | |
content.whatsapp_template.body_params | array<string> | Hayır | Öğe: 0–20 |
content.whatsapp_template.button_params | array<object> | Hayır | Öğe: 0–10 |
content.whatsapp_media | object | Hayır | |
content.whatsapp_media.type | enum | Evet | Değerler: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Evet | Uzunluk: 0–2000 |
content.whatsapp_media.filename | string | Hayır | Uzunluk: 1–240 |
content.whatsapp_interactive | object | Hayır | |
content.whatsapp_interactive.type | enum | Evet | Değerler: "button", "list" |
content.whatsapp_interactive.header | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.footer | string | Hayır | Uzunluk: 1–60 |
content.whatsapp_interactive.buttons | array<object> | Hayır | Öğe: 1–3 |
content.whatsapp_interactive.list | object | Hayır | |
content.rcs_card | object | Hayır | |
content.rcs_card.title | map<string, string> | Hayır | |
content.rcs_card.description | map<string, string> | Hayır | |
content.rcs_card.media_url | string (url) | Hayır | Uzunluk: 0–2000 |
content.rcs_card.media_height | enum | Hayır | Değerler: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | Hayır | Değerler: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | Hayır | Öğe: 0–11 |
content.rcs_content_sid | string | Hayır | |
content.rcs_content_variables | map<string, string> | Hayır | |
content.rcs_fallback_text | map<string, string> | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/templates/{templateId}
UpdateWarehouseExportDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 1–100 |
tables | array<enum> | Hayır | Öğe: 1–6 |
schedule | enum | Hayır | Değerler: "hourly", "daily" |
enabled | boolean | Hayır | |
config | map<string, any> | Hayır | |
credentials | map<string, any> | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/warehouse-exports/{exportId}
UpdateWarmupPlanDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 1–100 |
status | enum | Hayır | Değerler: "active", "paused" |
daily_limits | array<integer> | Hayır | Öğe: 1–120 |
provider_shares | object | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/email-deliverability/warmup-plans/{planId}
UpdateWebhookDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Hayır | Uzunluk: 1–2048 |
description | string | null | Hayır | |
events | array<enum> | Hayır | Öğe: 1–31 |
event_filters | object | Hayır | |
event_filters.event_names | array<string> | Hayır | Öğe: 0–50 |
batch | boolean | Hayır | |
headers | map<string, string> | null | Hayır | |
status | enum | Hayır | Değerler: "active", "disabled" |
body_template | string | null | Hayır | |
body_content_type | enum | Hayır | Şablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain" |
filters | object | null | Hayır |
Kullanıldığı işlemler: PATCH /v1/apps/{appId}/webhooks/{webhookId}
UpsertUserDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
identity | object | Hayır | |
identity.external_id | string | Evet | Uzunluk: 1–255 |
external_id | string | Hayır | Uzunluk: 1–255 |
properties | map<string, any> | Hayır | |
tags | map<string, string> | Hayır | |
subscriptions | array<object> | Hayır | Öğe: 0–20 |
subscriptions[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
subscriptions[].token | string | Evet | Uzunluk: 1–4096 |
subscriptions[].device | object | Hayır | Varsayılan: {} |
subscriptions[].device.model | string | Hayır | Uzunluk: 0–100 |
subscriptions[].device.os | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.os_version | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.app_version | string | null | Hayır | |
subscriptions[].device.sdk_version | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.carrier | string | Hayır | Uzunluk: 0–100 |
subscriptions[].device.locale | string | Hayır | Uzunluk: 0–20 |
subscriptions[].device.timezone | string | Hayır | Uzunluk: 0–64 |
subscriptions[].device.push_capable | boolean | Hayır | |
subscriptions[].device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
subscriptions[].status | enum | Hayır | Değerler: "subscribed", "unsubscribed" |
subscriptions[].opt_in | object | Hayır | |
subscriptions[].opt_in.source | string | Evet | Uzunluk: 1–100 |
subscriptions[].opt_in.at | string (date-time) | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/users
UsageReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
org_id | string | Evet | |
plan_code | string | Evet | |
period | object | Evet | |
period.start | string | Evet | |
period.end | string | Evet | |
metrics | array<object> | Evet | |
metrics[].metric | string | Evet | |
metrics[].used | number | Evet | |
metrics[].limit | number | null | Evet | |
metrics[].percent | number | null | Evet | |
metrics[].hard | boolean | Evet | |
apps | array<object> | Evet | |
apps[].app_id | string | Evet | |
apps[].name | string | Evet | |
apps[].messages_sent | number | Evet | |
apps[].active_subscriptions | number | Evet | |
apps[].mau | number | Evet | |
daily | array<object> | Evet | |
daily[].date | string | Evet | |
daily[].messages_sent | number | Evet | |
daily[].api_requests | number | Evet | |
daily[].events_ingested | number | Evet | |
trialing | boolean | Evet | |
trial_ends_at | string | null | Evet |
Kullanıldığı işlemler: GET /v1/organization/usage
User
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
external_id | string | null | Evet | |
properties | map<string, any> | Evet | |
tags | map<string, string> | Evet | |
first_seen_at | string | Evet | |
last_active_at | string | Evet | |
session_count | integer | Evet | |
usage_seconds | integer | Evet | |
merged_into | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
subscription_count | integer | Evet | |
channels | array<enum> | Evet |
UserDetail
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
external_id | string | null | Evet | |
properties | map<string, any> | Evet | |
tags | map<string, string> | Evet | |
first_seen_at | string | Evet | |
last_active_at | string | Evet | |
session_count | integer | Evet | |
usage_seconds | integer | Evet | |
merged_into | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
subscription_count | integer | Evet | |
channels | array<enum> | Evet | |
aliases | array<object> | Evet | |
aliases[].label | string | Evet | |
aliases[].value | string | Evet | |
subscriptions | array<object> | Evet | |
subscriptions[].id | string | Evet | |
subscriptions[].app_id | string | Evet | |
subscriptions[].user_id | string | null | Evet | |
subscriptions[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
subscriptions[].token | string | Evet | |
subscriptions[].status | enum | Evet | Değerler: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Evet | |
subscriptions[].device | object | Evet | |
subscriptions[].device.model | string | Hayır | Uzunluk: 0–100 |
subscriptions[].device.os | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.os_version | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.app_version | string | null | Hayır | |
subscriptions[].device.sdk_version | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.sdk_platform | string | Hayır | Uzunluk: 0–50 |
subscriptions[].device.carrier | string | Hayır | Uzunluk: 0–100 |
subscriptions[].device.locale | string | Hayır | Uzunluk: 0–20 |
subscriptions[].device.timezone | string | Hayır | Uzunluk: 0–64 |
subscriptions[].device.push_capable | boolean | Hayır | |
subscriptions[].device.push_environment | enum | Hayır | Değerler: "sandbox", "production" |
subscriptions[].test_device | boolean | Evet | |
subscriptions[].test_device_name | string | null | Evet | |
subscriptions[].last_active_at | string | Evet | |
subscriptions[].last_sent_at | string | null | Evet | |
subscriptions[].last_delivered_at | string | null | Evet | |
subscriptions[].opted_in_at | string | null | Evet | |
subscriptions[].opt_in_source | string | null | Evet | |
subscriptions[].unsubscribed_at | string | null | Evet | |
subscriptions[].location | object | null | Evet | |
subscriptions[].created_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
exported_at | string | Evet | |
user | object | Evet | |
user.id | string | Evet | |
user.app_id | string | Evet | |
user.external_id | string | null | Evet | |
user.properties | map<string, any> | Evet | |
user.tags | map<string, string> | Evet | |
user.first_seen_at | string | Evet | |
user.last_active_at | string | Evet | |
user.session_count | integer | Evet | |
user.usage_seconds | integer | Evet | |
user.merged_into | string | null | Evet | |
user.created_at | string | Evet | |
user.updated_at | string | Evet | |
user.subscription_count | integer | Evet | |
user.channels | array<enum> | Evet | |
user.aliases | array<object> | Evet | |
user.aliases[].label | string | Evet | |
user.aliases[].value | string | Evet | |
user.subscriptions | array<object> | Evet | |
user.subscriptions[].id | string | Evet | |
user.subscriptions[].app_id | string | Evet | |
user.subscriptions[].user_id | string | null | Evet | |
user.subscriptions[].channel | enum | Evet | Değerler: "ios_push", "android_push", "hms_push", "web_push", "email", "sms", "whatsapp", "rcs" |
user.subscriptions[].token | string | Evet | |
user.subscriptions[].status | enum | Evet | Değerler: "subscribed", "unsubscribed", "invalid", "pending" |
user.subscriptions[].unsubscribe_reason | enum | null | Evet | |
user.subscriptions[].device | object | Evet | |
user.subscriptions[].test_device | boolean | Evet | |
user.subscriptions[].test_device_name | string | null | Evet | |
user.subscriptions[].last_active_at | string | Evet | |
user.subscriptions[].last_sent_at | string | null | Evet | |
user.subscriptions[].last_delivered_at | string | null | Evet | |
user.subscriptions[].opted_in_at | string | null | Evet | |
user.subscriptions[].opt_in_source | string | null | Evet | |
user.subscriptions[].unsubscribed_at | string | null | Evet | |
user.subscriptions[].location | object | null | Evet | |
user.subscriptions[].created_at | string | Evet | |
events | array<object> | Evet | |
events[].id | string | Evet | |
events[].user_id | string | null | Evet | |
events[].subscription_id | string | null | Evet | |
events[].name | string | Evet | |
events[].properties | map<string, any> | Evet | |
events[].value | number | null | Evet | |
events[].source | enum | Evet | Değerler: "sdk", "api", "system", "import" |
events[].occurred_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/export
UserIdentity
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
identity | map<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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].journey_id | string | Evet | |
data[].version | integer | Evet | |
data[].user_id | string | Evet | |
data[].external_id | string | null | Evet | |
data[].status | enum | Evet | Değerler: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Evet | |
data[].next_action_at | string | null | Evet | |
data[].entered_at | string | Evet | |
data[].completed_at | string | null | Evet | |
data[].exit_reason | string | null | Evet | |
data[].goal_id | string | null | Evet | |
data[].goal_reached_at | string | null | Evet | |
data[].context | map<string, any> | Evet | |
data[].journey_name | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/journeys
UserList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].external_id | string | null | Evet | |
data[].properties | map<string, any> | Evet | |
data[].tags | map<string, string> | Evet | |
data[].first_seen_at | string | Evet | |
data[].last_active_at | string | Evet | |
data[].session_count | integer | Evet | |
data[].usage_seconds | integer | Evet | |
data[].merged_into | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
data[].subscription_count | integer | Evet | |
data[].channels | array<enum> | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/users, POST /v1/apps/{appId}/users/search
UserMessageList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].delivery_id | string | Evet | |
data[].message_id | string | Evet | |
data[].campaign_id | string | null | Evet | |
data[].source | string | Evet | |
data[].channel | string | Evet | |
data[].status | string | Evet | |
data[].title | string | null | Evet | |
data[].body | string | null | Evet | |
data[].error_code | string | null | Evet | |
data[].created_at | string | Evet | |
data[].sent_at | string | null | Evet | |
data[].delivered_at | string | null | Evet | |
data[].opened_at | string | null | Evet | |
data[].clicked_at | string | null | Evet |
UserPreferences
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
user_id | string | Evet | |
data | array<object> | Evet | |
data[].category | string | Evet | |
data[].channel | string | null | Evet | |
data[].opted_in | boolean | Evet | |
data[].explicit | boolean | Evet | |
data[].source | string | null | Evet | |
data[].updated_at | string | null | Evet | |
categories | array<object> | Evet | |
categories[].id | string | Evet | |
categories[].app_id | string | Evet | |
categories[].key | string | Evet | |
categories[].name | map<string, string> | Evet | |
categories[].description | map<string, string> | Evet | |
categories[].channels | array<string> | null | Evet | |
categories[].default_opted_in | boolean | Evet | |
categories[].position | integer | Evet | |
categories[].opted_out_users | integer | Evet | |
categories[].created_at | string | Evet | |
categories[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/users/by/{label}/{value}/preferences, PUT /v1/apps/{appId}/users/by/{label}/{value}/preferences
VerifyAddressDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
address | string | Evet | Uzunluk: 3–320 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/email-deliverability/verify-address
WarehouseConnectionResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | boolean | Evet | |
detail | string | null | Evet | |
error | object | null | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
name | string | Evet | |
destination | enum | Evet | Değerler: "bigquery", "snowflake", "s3_parquet" |
config | map<string, any> | Evet | |
credentials_hint | string | Evet | |
tables | array<enum> | Evet | |
schedule | enum | Evet | Değerler: "hourly", "daily" |
enabled | boolean | Evet | |
status | enum | Evet | Değerler: "active", "paused", "failing" |
consecutive_failures | integer | Evet | |
last_error | string | null | Evet | |
cursors | map<string, object> | Evet | |
schema_versions | map<string, integer> | Evet | |
last_run_at | string | null | Evet | |
last_success_at | string | null | Evet | |
next_run_at | string | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].name | string | Evet | |
data[].destination | enum | Evet | Değerler: "bigquery", "snowflake", "s3_parquet" |
data[].config | map<string, any> | Evet | |
data[].credentials_hint | string | Evet | |
data[].tables | array<enum> | Evet | |
data[].schedule | enum | Evet | Değerler: "hourly", "daily" |
data[].enabled | boolean | Evet | |
data[].status | enum | Evet | Değerler: "active", "paused", "failing" |
data[].consecutive_failures | integer | Evet | |
data[].last_error | string | null | Evet | |
data[].cursors | map<string, object> | Evet | |
data[].schema_versions | map<string, integer> | Evet | |
data[].last_run_at | string | null | Evet | |
data[].last_success_at | string | null | Evet | |
data[].next_run_at | string | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports
WarehouseExportRun
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
export_id | string | Evet | |
trigger | enum | Evet | Değerler: "schedule", "manual" |
status | enum | Evet | Değerler: "queued", "running", "succeeded", "failed" |
tables | map<string, object> | Evet | |
row_count | integer | Evet | |
attempt | integer | Evet | |
error | string | null | Evet | |
started_at | string | null | Evet | |
finished_at | string | null | Evet | |
duration_ms | integer | null | Evet | |
created_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/warehouse-exports/{exportId}/run
WarehouseExportRunPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].export_id | string | Evet | |
data[].trigger | enum | Evet | Değerler: "schedule", "manual" |
data[].status | enum | Evet | Değerler: "queued", "running", "succeeded", "failed" |
data[].tables | map<string, object> | Evet | |
data[].row_count | integer | Evet | |
data[].attempt | integer | Evet | |
data[].error | string | null | Evet | |
data[].started_at | string | null | Evet | |
data[].finished_at | string | null | Evet | |
data[].duration_ms | integer | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports/{exportId}/runs
WarehouseTables
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].name | enum | Evet | Değerler: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions" |
data[].mode | enum | Evet | Değerler: "incremental", "snapshot" |
data[].schema_version | integer | Evet | |
data[].cursor_column | string | null | Evet | |
data[].columns | array<object> | Evet | |
data[].columns[].name | string | Evet | |
data[].columns[].type | string | Evet | |
data[].columns[].nullable | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/warehouse-exports/tables
Webhook
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
url | string | Evet | |
description | string | null | Evet | |
events | array<string> | Evet | |
event_filters | object | Evet | |
event_filters.event_names | array<string> | Hayır | |
batch | boolean | Evet | |
status | enum | Evet | Değerler: "active", "failing", "disabled" |
disabled_reason | string | null | Evet | |
failure_count | integer | Evet | |
failing_since | string | null | Evet | |
last_success_at | string | null | Evet | |
last_failure_at | string | null | Evet | |
header_names | array<string> | Evet | |
previous_secret_expires_at | string | null | Evet | |
body_template | string | null | Evet | |
body_content_type | enum | Evet | Değerler: "application/json", "text/plain" |
filters | object | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks/{webhookId}, PATCH /v1/apps/{appId}/webhooks/{webhookId}
WebhookBulkReplayResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
replayed | integer | Evet |
WebhookDeliveryDetail
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
endpoint_id | string | Evet | |
event_type | string | Evet | |
event_id | string | Evet | |
subject_id | string | null | Evet | |
attempt | integer | Evet | |
status | enum | Evet | Değerler: "pending", "success", "failed", "dead" |
response_status | integer | null | Evet | |
response_body_excerpt | string | null | Evet | |
error | string | null | Evet | |
duration_ms | integer | null | Evet | |
next_retry_at | string | null | Evet | |
delivered_at | string | null | Evet | |
replay_of | string | null | Evet | |
created_at | string | Evet | |
payload | map<string, any> | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/{webhookId}/test, POST /v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replay
WebhookDeliveryPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].endpoint_id | string | Evet | |
data[].event_type | string | Evet | |
data[].event_id | string | Evet | |
data[].subject_id | string | null | Evet | |
data[].attempt | integer | Evet | |
data[].status | enum | Evet | Değerler: "pending", "success", "failed", "dead" |
data[].response_status | integer | null | Evet | |
data[].response_body_excerpt | string | null | Evet | |
data[].error | string | null | Evet | |
data[].duration_ms | integer | null | Evet | |
data[].next_retry_at | string | null | Evet | |
data[].delivered_at | string | null | Evet | |
data[].replay_of | string | null | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks/{webhookId}/deliveries
WebhookEventTypes
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<string> | Evet |
WebhookList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].app_id | string | Evet | |
data[].url | string | Evet | |
data[].description | string | null | Evet | |
data[].events | array<string> | Evet | |
data[].event_filters | object | Evet | |
data[].event_filters.event_names | array<string> | Hayır | |
data[].batch | boolean | Evet | |
data[].status | enum | Evet | Değerler: "active", "failing", "disabled" |
data[].disabled_reason | string | null | Evet | |
data[].failure_count | integer | Evet | |
data[].failing_since | string | null | Evet | |
data[].last_success_at | string | null | Evet | |
data[].last_failure_at | string | null | Evet | |
data[].header_names | array<string> | Evet | |
data[].previous_secret_expires_at | string | null | Evet | |
data[].body_template | string | null | Evet | |
data[].body_content_type | enum | Evet | Değerler: "application/json", "text/plain" |
data[].filters | object | null | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/webhooks
WebhookPreviewDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
event_type | enum | Evet | Değ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" |
data | map<string, any> | Hayır | |
body_template | string | null | Hayır | |
body_content_type | enum | Hayır | Şablon çıktısının içerik türü (varsayılan application/json).. Değerler: "application/json", "text/plain" |
filters | object | null | Hayır | |
batch | boolean | Hayır |
Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/preview
WebhookPreviewResult
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
payload | map<string, any> | Evet | |
matched | boolean | Evet | Olay filtreden geçer mi (geçmezse gönderilmez). |
failed_conditions | array<object> | Evet | |
failed_conditions[].field | string | Evet | |
failed_conditions[].op | string | Evet | |
failed_conditions[].value | any | Hayır | |
body | string | null | Evet | |
content_type | string | Evet | |
error | object | null | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/webhooks/preview
WebhookSecret
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
secret | string | Evet |
WebhookWithSecret
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
app_id | string | Evet | |
url | string | Evet | |
description | string | null | Evet | |
events | array<string> | Evet | |
event_filters | object | Evet | |
event_filters.event_names | array<string> | Hayır | |
batch | boolean | Evet | |
status | enum | Evet | Değerler: "active", "failing", "disabled" |
disabled_reason | string | null | Evet | |
failure_count | integer | Evet | |
failing_since | string | null | Evet | |
last_success_at | string | null | Evet | |
last_failure_at | string | null | Evet | |
header_names | array<string> | Evet | |
previous_secret_expires_at | string | null | Evet | |
body_template | string | null | Evet | |
body_content_type | enum | Evet | Değerler: "application/json", "text/plain" |
filters | object | null | Evet | |
created_at | string | Evet | |
updated_at | string | Evet | |
secret | string | Evet | Yalnı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].external_id | string | null | Evet | |
data[].name | string | Evet | |
data[].language | string | Evet | |
data[].category | string | Evet | |
data[].status | string | Evet | |
data[].components | array<map<string, any>> | Evet | |
data[].body_params | integer | Evet | |
data[].rejected_reason | string | null | Evet | |
data[].quality_score | string | null | Evet | |
data[].synced_at | string | Evet |
Kullanıldığı işlemler: GET /v1/apps/{appId}/whatsapp/templates
WhatsAppTemplateSync
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
total | integer | Evet | |
removed | integer | Evet | |
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].external_id | string | null | Evet | |
data[].name | string | Evet | |
data[].language | string | Evet | |
data[].category | string | Evet | |
data[].status | string | Evet | |
data[].components | array<map<string, any>> | Evet | |
data[].body_params | integer | Evet | |
data[].rejected_reason | string | null | Evet | |
data[].quality_score | string | null | Evet | |
data[].synced_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/whatsapp/templates/sync
ZapierHook
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
event | string | Evet | |
event_name | string | null | Evet | |
target_url | string | Evet | |
last_delivered_at | string | null | Evet | |
failure_count | integer | Evet | |
created_at | string | Evet |
Kullanıldığı işlemler: POST /v1/apps/{appId}/integrations/zapier/hooks
ZapierHookList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].event | string | Evet | |
data[].event_name | string | null | Evet | |
data[].target_url | string | Evet | |
data[].last_delivered_at | string | null | Evet | |
data[].failure_count | integer | Evet | |
data[].created_at | string | Evet |
ZapierMe
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
app_id | string | Evet | |
app_name | string | Evet | |
org_id | string | Evet | |
scopes | array<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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
target_url | string | Evet | Uzunluk: 1–2000 |
event | enum | Evet | Değerler: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed" |
event_name | string | Hayır | Uzunluk: 1–100 |
Kullanıldığı işlemler: POST /v1/apps/{appId}/integrations/zapier/hooks
SDK uçları (istemci)
SDK uçları (istemci) — 25 işlem (GET /sdk/v1/apps/{appId}/config, POST /sdk/v1/apps/{appId}/subscriptions, PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.
API değişiklik günlüğü
Public REST API, SDK'lar ve webhook'larla ilgili sürüm notları (CHANGELOG.md'den süzülür).