Skip to content

Audience APIs

Changes to the Audience Management API (/audience/management/v1) and the Audience delivery API (/audience/delivery/v1). Newest first. How versions work is on Releases and versions.

2026-10-23 — Attribute a person to the campaign that brought them

Section titled “2026-10-23 — Attribute a person to the campaign that brought them”

POST /audience/management/v1/identify accepts an optional attribution ({ source, medium, campaign }, the utm_source, utm_medium and utm_campaign of the link the person followed, each at most 100 characters). Audience records it once, as the person’s first touch: a person with no Awareness pass gets one with those facts, an open pass with none is filled in, and anyone else is left as they are. The campaign text is matched to an existing campaign by alias and never registers one. The answer gains attribution: { status, campaignResolved }. Awareness gains a source fact, and the Attribution report groups people by source, medium and campaign.

@ebitex/visitors-sdk’s connectEmbeds takes an attribution option (a value or a function, defaulting to the page’s own utm_* tags) and hands it to the form frame with the token. @ebitex/forms-sdk’s <EbitexForm> takes the same attribution prop and sends it with the submission. Neither SDK stores anything. The public form submission accepts an optional attribution with the same members.

Section titled “2026-10-23 — The browser that follows a verification link is verified too”

When a verification link has a returnUrl, pressing the button on its page now also hands a one-time code to the page the person continues to. The “Continue” link carries it in the URL fragment, #ebitex-verify=<code>; it works once and expires after 10 minutes. @ebitex/content-sdk reads it, removes it from the address bar and calls the new POST /audience/delivery/v1/sign-in/handoff with the code and the browser’s own visitor token, so a link followed on a phone and continued from there unlocks the page on the phone. The route answers 202 with the same body whatever became of the code. The client gains audience.redeemHandoff(code) and an audience: { handoff: false } option, and the audience client gains redeemHandoff().

2026-10-21 — One signed token for a visitor’s audiences

Section titled “2026-10-21 — One signed token for a visitor’s audiences”

Which audiences a visitor is in now reaches Content as one signed token, and the two earlier ways are removed. POST /audience/delivery/v1/resolve returns an access member for every visitor: a token (a1.…), its expiry and the audiences it grants, each tagged verified, declared or context. Send it in the X-Ebitex-Audiences header on GET /path, GET /nodes, GET /components, GET /components/{provider}/{key} and GET /streams/{externalId}; Content verifies it, and a response that depends on it is private, no-store. resolve also takes an optional audiences list (up to 64; more is 400 too_many_audiences), and GET /content/delivery/v1/audiences lists the audiences your published content uses.

Removed: audiences in ctx (a request that sends it answers 400 audiences_not_in_ctx), POST /audience/delivery/v1/claim and the X-Ebitex-Membership header. A variant on a stored-membership audience is now withheld from a visitor who does not hold the audience, even when your site chooses variants itself, and is left out of search; a variant on an audience worked out from context is public copy.

@ebitex/content-sdk does the whole flow when you pass audience: { apiKey } to createContentClient: it asks which audiences your content uses, asks Audience about exactly those, keeps the token in memory, renews it, sends it, and refreshes when a Forms submission, a followed sign-in link or a stale token says the audiences changed. It gains forVisitor() for a server request, onChange, refresh(), useAudienceChange() and useSignIn(), and loses withAudiences, audience.claim(), ContextBag.audiences and the membership option. @ebitex/forms-sdk announces a completed submission to the page. Ebitex.Content.Delivery gains AudienceClient.GetAccessAsync and AudienceToken on PathOptions, NodesOptions, ComponentOptions and StreamQueryOptions, and loses ClaimAsync, ContentContext.Audiences and Membership. See Serve pages only to members and Personalize content.

2026-10-19 — Interactions and events are two things, and page views can be counted

Section titled “2026-10-19 — Interactions and events are two things, and page views can be counted”

Audience now keeps two kinds of record about what a visitor does. An interaction is a meaningful fact that appears on a person’s timeline. An event is a high-volume signal, such as a page viewed, that is kept briefly and counted by audiences.

This renames the call that recorded an interaction. POST /audience/delivery/v1/events is now POST /audience/delivery/v1/interaction, the eventId member is interactionId, the daily-limit code event_cap_reached is interaction_cap_reached, and in @ebitex/visitors-sdk track() is interaction() with { interactionId } in its options. The old route and method are removed. Behaviour is otherwise unchanged.

POST /audience/delivery/v1/event records an event for a recognised, linked person: today content.viewed, with the page’s category ids and their ancestors. It takes one event or up to 20, and never slows your page. The SDK has event() and pageViewed(), and the drop-in script can record a view on load when you add data-ebitex-page-views. An audience can then count “viewed a page in this category at least N times in the last D days”. Each page the Content Delivery API resolves now carries a classification (the ids of its categories with their ancestors) when it has any; @ebitex/content-sdk and Ebitex.Content.Delivery carry it through. See Interactions and events.

2026-10-18 — Record what a recognised visitor did

Section titled “2026-10-18 — Record what a recognised visitor did”

POST /audience/delivery/v1/events puts a named event on the timeline of the person a device is recognised as, for example pricing-viewed. It is not a page-view tracker: an event is stored only when the device holds a recognition token that has not been forgotten, consent is granted on that device, and the device is already linked to a person. For anyone else the answer is 202 with recorded: false and the reason, and nothing is stored. Properties may hold only visit properties your organization has declared (Settings, Visit properties in Audience), typed as declared; each device may record 200 events in any 24 hours; an eventId makes a retry safe. @ebitex/visitors-sdk gains track(), and VisitorsApiError gains an errors member naming each rejected property. See Record what a visitor did.

2026-10-17 — Restrict pages to an audience

Section titled “2026-10-17 — Restrict pages to an audience”

Editors can restrict a site, section or page to an audience, and the Content Delivery API enforces it. POST /audience/delivery/v1/claim returns a signed, short-lived membership claim for a visitor; send it in the new X-Ebitex-Membership header on GET /path and GET /nodes. A restricted page requested without a claim that admits the visitor answers 403 members_only with the door to offer and the unlock page to show, and is left out of sitemaps, include=paths listings and /nodes. Every response that depends on a claim is private, no-store. POST /audience/delivery/v1/sign-in emails a one-time sign-in link to a member of a verified-access audience, with the same answer for every address. @ebitex/content-sdk gains audience.claim(), audience.startSignIn(), a membership option on resolveLocation, getNavigation and resolvePath, and membersOnlyOf(error); Ebitex.Content.Delivery gains AudienceClient.ClaimAsync and StartSignInAsync, Membership on PathOptions and NodesOptions, and ContentDeliveryException.MembersOnly. See Serve pages only to members.

2026-10-15 — Audience Management API: a plan limit on people

Section titled “2026-10-15 — Audience Management API: a plan limit on people”

POST /audience/management/v1/individuals and POST /identify can now answer 403 quota_exceeded when the organization has reached its plan’s limit on people and the call would create a new person. Nothing already held changes. See Plan limits.

2026-10-13 — Render an email from your own site, or let ebitex render it

Section titled “2026-10-13 — Render an email from your own site, or let ebitex render it”

Audience can send an email whose content is a page in one of your Content sites. Choose the hosted renderer on the channel and ebitex renders the page with the channel’s delivery key, or choose your own renderer and serve the signed POST /render/v1 request, answering with a subject, HTML and text. @ebitex/content-sdk gains a render entry point for building a renderer. Audience never sends a renderer anything about a recipient. See Render an email from your own site.

Audiences are now defined in the Audience app and resolved by your site. POST /audience/delivery/v1/resolve answers which audiences a visitor is in, with ids, using an Audience delivery key; /audience/management/v1/audiences defines them from a script. Send the ids as ctx.audiences: a variant that names an audience is shown when its id is in that list. The Content Management API’s audiences routes, the audience kind in promotion and export, and the audiences section of a content model are gone, and an unresolved (client-resolve) response now carries each audience condition as { "audience": "<id>" } instead of the audience’s rule. @ebitex/content-sdk gains createAudienceClient and withAudiences; Ebitex.Content.Delivery gains AudienceClient. See Audiences.

2026-10-12 — Audience Management API: read and write the people your organization knows

Section titled “2026-10-12 — Audience Management API: read and write the people your organization knows”

A new API, at /audience/management/v1, lets your own server work with the individuals in Audience: create and update people, add and remove identities, record channel permissions and interactions, forget a person, and read the organization’s custom fields. POST /identify is the one call for the moment you learn who a visitor is: it finds or creates the person, merges on a verified identity, records an event, and, with the device’s consent signals forwarded, links the visitor’s browser. It takes an Audience management key created under Settings, API keys in the Audience app, with up to three scopes: audience.management.read, audience.management.write and audience.management.erase. See Knowing your audience.

These entries are written in full on another page.