Render a zone with the name in the body

Renders a zone using a request body that carries both the zone name and the targeting data. Functionally equivalent to POST /v5/zones/{zone_name}; the path-based form is the recommended primary entry point. Use this form when the calling code constructs the full request payload upstream and prefers a single body shape. Returns the zone's configured content (HTML, JavaScript, JSON, or plain text) plus X-Extole-* headers describing the matched campaign and creative. Authenticated with a USER_SUPPORT scope access token.

post/v5/zones

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/zones/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

dataobject required

Open targeting data map merged into the rendering context. Recognised identity keys are email, partner_user_id, person_id, and event_time (ISO 8601). Additional keys are forwarded to the zone's targeting evaluator and creative renderer.

zone_namestring required

Name of the zone to render. Must match a zone configured on the client account.

Example request

{
  "zone_name": "global_header"
}

Response

Rendered zone content. The response body shape varies by the zone's creative configuration: HTML, JavaScript, JSON, or plain text. X-Extole-* response headers carry the matched campaign, frontend controller, creative, creative version, and input event identifiers, plus optional debug logs (X-Extole-Log).

Changes

No recorded changes to this operation across all 1 revision of this API.