Skip to content

Select theme

Get started
- Checklist
- Getting started FAQ
Revenue
Identity
Delivery
- Overview
- Sites
- Versions
- First-party mount and proxy
Reference
- API
  - Tenant
    Overview
    ID
    Overview
    Read the ID configuration for a site
    Read the traits a site collects
    Send a magic link
    Consume a magic-link token
    Send a sign-in code
    Sign in with a code
    Sign in with a Google ID token
    Read the current user session
    Exchange an upstream credential for an EdgeKit session
    Sign out
    Request an identifier change
    Confirm an identifier change
    Read the signed-in user
    Update the signed-in user
    The upstream deleted this person
    The upstream locked this account or reset its password
    The upstream changed this person's address
    The upstream subject itself moved
    Checkout
    Overview
    Buy an offer the decision engine offered
    Newsletters
    Overview
    The newsletters this site offers
    Where one person stands on every list
    Replace one person’s standing on this site
    The newsletter confirmation interstitial
    Confirm a pending newsletter subscription
    The unsubscribe page
    Unsubscribe through an edition’s link
    Recommendations
    Overview
    Recommend items for a user or device
    Organizations
    Overview
    List the organizations the user belongs to
    Set the active organization
    Rename an organization
    Read the user’s own membership
    List the organization’s members
    Change a member’s role
    Remove a member
    Leave an organization
    Invite someone to an organization
    Cancel a pending invitation
    List an organization’s pending invitations
    Read one invitation
    List the user’s own pending invitations
    Accept an invitation
    List people refused a seat
    Reject an invitation
    Analytics
    Overview
    List every deployed schema URI
    Resolve a schema
    Streaming
    Overview
    Send a batch of the organization's own scores
    System
    Overview
    Healthcheck
    Grants
    List the signed-in user’s grants
    Content
    Re-read changed items from the CMS
    Publications
    A publication’s public archive index
  - Decide
    Overview
    Decide
    Overview
    Decide a batch of features (API key)
    Evaluate a journey feature and redirect
    Decide a batch of features (browser)
    Gift links
    Overview
    Create a gift link (API key)
    Create a gift link (browser)
    Interventions
    Overview
    Subscribe to interventions
- Error codes
- CLI
- SDKs
  - @edgekitcloud/client-browser
    Classes
    EdgeKitConfigError
    Type Aliases
    BrowserClientOptions
    BrowserDecideOptions
    CallResult
    CheckoutOptions
    CheckoutRequestBody
    CheckoutResponseBody
    CreateGiftLinkResponseBody
    DecidedFeature
    DecideResults
    DecisionsSchema
    EdgeKitSession
    ExternalSession
    FailedCall
    FeatureNameOf
    FeatureResult
    FeatureSchema
    GiftLinkOptions
    GiftLinkStatus
    Grant
    GrantsOptions
    GrantsResponseBody
    GrantState
    IdConfig
    IdMethod
    IdMode
    IdTraitConstraints
    IdTraitDescriptor
    IdUser
    NewsletterList
    NewsletterListsResponseBody
    NewsletterOptions
    NewsletterSubscription
    NewsletterSubscriptionsResponseBody
    NewsletterSubscriptionStatus
    Ok
    OkResult
    Organization
    OrgInvitation
    OrgMember
    OrgSeatRefusal
    OutcomeSchema
    OutcomeType
    SessionListener
    SessionRef
    SessionState
    SignInResult
    SignOutResult
    SiteSchema
    SubscriptionsInput
    TraitPatch
    TraitValues
    TraitValuesOf
    UnavailableCall
    UnavailableFeature
    UnknownFeature
    UnresolvedOutcome
    UserDetails
    UserDetailsInput
    Variables
    UNRESOLVED_OUTCOME
    Functions
    createClient
  - @edgekitcloud/client-server
    Classes
    EdgeKitConfigError
    Type Aliases
    DecidedFeature
    DecideResults
    DecisionsSchema
    FeatureNameOf
    FeatureResult
    FeatureSchema
    OutcomeSchema
    OutcomeType
    ServerClientOptions
    ServerDecideOptions
    SiteSchema
    UnavailableFeature
    UnknownFeature
    UnresolvedOutcome
    Variables
    UNRESOLVED_OUTCOME
    Functions
    createServerClient
  - @edgekitcloud/analytics-browser
    Type Aliases
    EdgeKitTracker
    EdgeKitTrackerOptions
    Functions
    createTracker
  - @edgekitcloud/proxy
    Type Aliases
    ConfigIssue
    ConfigOutcome
    ContentFacts
    DecisionIsland
    ProxyAdapter
    ProxyConfig
    ProxyElement
    ProxyElementHandlers
    ProxyMode
    ProxyRewriter
    ProxyWarning
    RewritePlan
    Variables
    MOUNT_PREFIX
    SCRIPT_PATH
    Functions
    createProxy
    readConfig

Select theme

On this page

Overview
Properties
- signal?

On this page

Overview
Properties
- signal?

NewsletterOptions

NewsletterOptions = object

Properties

Section titled “Properties”

signal?

Section titled “signal?”

optional signal?: AbortSignal

Cancels the round trip early.