Skip to content
Optail
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quickstart
API Reference
API Reference
Send Email
Templates
Providers
Metrics
Suppressions
Webhooks
SDKs
Node.js SDK
API Reference (auto-generated)
optail
Classes
Class: AuthenticationError
Class: ConflictError
Class: NotFoundError
Class: Optail
Class: OptailError
Class: RateLimitError
Class: ValidationError
Interfaces
Interface: AbTestResponse
Interface: AddBrandDomainParams
Interface: AddBrandTemplateParams
Interface: AddListMembersParams
Interface: AddListMembersResponse
Interface: AddSenderIpParams
Interface: AddSndsKeyParams
Interface: ApiKeyCreateResponse
Interface: ApiKeyResponse
Interface: ApiKeyRevokeResponse
Interface: BounceAnalysisResponse
Interface: BrandDomainResponse
Interface: BrandTemplateResponse
Interface: CheckoutParams
Interface: CheckoutResponse
Interface: ContactDetailResponse
Interface: ContactImportJobResponse
Interface: ContactListResponse
Interface: ContactResponse
Interface: CreateAbTestParams
Interface: CreateApiKeyParams
Interface: CreateContactParams
Interface: CreateExportParams
Interface: CreateListParams
Interface: CreateNotificationChannelParams
Interface: CreateProviderMappingParams
Interface: CreateProviderParams
Interface: CreateRoutingRuleParams
Interface: CreateSuppressionParams
Interface: CreateTemplateParams
Interface: CreateTemplateVersionParams
Interface: CreateTestInboxParams
Interface: CreateUnsubscribeGroupParams
Interface: CreateWarmupPlanParams
Interface: CreateWebhookEndpointParams
Interface: DeliverabilityStatusResponse
Interface: DmarcRuaResponse
Interface: DomainDetailResponse
Interface: DomainListItem
Interface: DomainProviderStatus
Interface: EmailEvent
Interface: ExportResponse
Interface: FailoverEventResponse
Interface: FailoverStatusResponse
Interface: ImportContactsParams
Interface: ImportProviderTemplatesResponse
Interface: ImportSuppressionsParams
Interface: ImportSuppressionsResponse
Interface: InboxRunDetail
Interface: InboxRunSummary
Interface: InterpretBounceParams
Interface: InterpretBounceResponse
Interface: ListAbTestsParams
Interface: ListContactListsParams
Interface: ListContactsParams
Interface: ListMemberResponse
Interface: ListMembershipResponse
Interface: ListMembersParams
Interface: ListMessagesParams
Interface: ListSuppressionsParams
Interface: ListTemplatesParams
Interface: ListWarmupPlansParams
Interface: MessageDetailResponse
Interface: MessageListItem
Interface: MetricsBreakdownItem
Interface: MetricsBreakdownParams
Interface: MetricsBreakdownResponse
Interface: MetricsDataPoint
Interface: MetricsQueryParams
Interface: MetricsResponse
Interface: MetricsSummaryData
Interface: MetricsSummaryParams
Interface: MetricsSummaryResponse
Interface: NotificationChannelResponse
Interface: NotificationChannelTestResponse
Interface: OptailConfig
Interface: OrganizationMemberResponse
Interface: OrganizationResponse
Interface: PaginatedResponse\<T\>
Interface: PaginationMeta
Interface: PaginationParams
Interface: PlanDefinition
Interface: PmtConnectParams
Interface: PmtConnectResponse
Interface: PmtCredentialsResponse
Interface: PortalResponse
Interface: PreviewTemplateParams
Interface: PreviewTemplateResponse
Interface: ProviderDomainResponse
Interface: ProviderHealth
Interface: ProviderMappingResponse
Interface: ProviderResponse
Interface: RecordWarmupParams
Interface: RefreshDomainResponse
Interface: ResetFailoverResponse
Interface: ResolveRoutingParams
Interface: ResolveRoutingResponse
Interface: RollbackTemplateResponse
Interface: RoutingRuleResponse
Interface: SendEmailParams
Interface: SendEmailResponse
Interface: SenderIpResponse
Interface: SendTimeRecommendationParams
Interface: SendTimeRecommendationResponse
Interface: ServiceHealth
Interface: ShareInboxRunResponse
Interface: SndsKeyResponse
Interface: SpamRewriteParams
Interface: SpamRewriteResponse
Interface: SpamScoreFinding
Interface: SpamScoreParams
Interface: SpamScoreResponse
Interface: StatusIncident
Interface: StatusResponse
Interface: StopAbTestParams
Interface: SubscriptionResponse
Interface: SuccessResponse
Interface: SuppressionCheckResponse
Interface: SuppressionResponse
Interface: SyncProviderUnsubscribeGroupsResponse
Interface: TemplateResponse
Interface: TemplateVersionListItem
Interface: TemplateVersionListResponse
Interface: TemplateVersionResponse
Interface: TemplateWithVersionResponse
Interface: TestInboxTokenResponse
Interface: UnsubscribeGroupResponse
Interface: UpdateContactParams
Interface: UpdateListParams
Interface: UpdateNotificationChannelParams
Interface: UpdateOrganizationParams
Interface: UpdateProviderParams
Interface: UpdateRoutingRuleParams
Interface: UpdateTemplateParams
Interface: UpdateUnsubscribeGroupParams
Interface: UpdateWebhookEndpointParams
Interface: UsageResponse
Interface: ValidateProviderResponse
Interface: WarmupOrchestrationResponse
Interface: WarmupPlanDetailResponse
Interface: WarmupPlanResponse
Interface: WebhookEndpointCreateResponse
Interface: WebhookEndpointResponse
Interface: WebhookEvent
Interface: WebhookTestResponse
Type Aliases
Type Alias: AbTestMetric
Type Alias: AbTestStatus
Type Alias: ContactStatus
Type Alias: ExportFormat
Type Alias: ExportStatus
Type Alias: FailoverState
Type Alias: NotificationChannelType
Type Alias: Permission
Type Alias: WarmupAggressiveness
Type Alias: WarmupStatus
Type Alias: WebhookEventType
Functions
Function: verifyWebhookSignature()
Guides
Template Guide
Unsubscribe Management
Provider Setup
SendGrid
Postmark
Mailgun
Amazon SES
GitHub
Select theme
Dark
Light
Auto
Type Alias: ExportFormat
type
ExportFormat
=
"
csv
"
|
"
jsonl
"
|
"
parquet
"
;
Defined in:
sdk/src/types.ts:906
