Skip to main content
POST
Create sales event page

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
event_name
string
required
Required string length: 1 - 500
Example:

"Summer Blowout Sale"

start_date
string<date-time>
required
Example:

"2026-07-04T09:00:00Z"

end_date
string<date-time>
required

Must be on or after start_date

Example:

"2026-07-07T21:00:00Z"

location
string
required
Required string length: 1 - 500
Example:

"123 Main St, Springfield, IL"

category
enum<string>
required
Available options:
Sales Event,
New Model Launch,
Owner Appreciation,
Service Special,
Community Event,
Holiday Celebration,
Test Drive Event
brand_voice_id
string

Brand voice profile id (sets tone to BrandVoice:{id})

tone
enum<string>

Enum tone when not using brand_voice_id. Default first brand voice or Informative.

Available options:
Informative,
Authoritative,
Persuasive,
Confident,
Analytical,
Empathetic,
Witty,
Enthusiastic,
Inspiring,
Motivating,
Creative
language
enum<string>
default:English
Available options:
English,
Spanish,
Mandarin Chinese,
Japanese,
Korean,
Arabic,
Farsi,
Hebrew,
French,
Tagalog,
Vietnamese,
Portuguese,
Russian
title
string
Maximum string length: 500
content_length
integer
deprecated
Required range: 200 <= x <= 5000
content_depth
enum<string>

Defaults to balanced

Available options:
concise,
steady,
balanced,
substantial,
in-depth
include_tables
boolean

Defaults to false only when content_depth is concise

selected_trims
string[]

Model landing only — multi-trim selection (omit when empty)

target_geo_overrides
object[]

Included geos from GET /site/target-geography with priority order

output_format
enum<string>
default:standard

Rich Text (standard) or Layouts (visual). Visual requires Layouts plan entitlement.

Available options:
standard,
visual
visual_design_mode
enum<string>

When visual — custom=AI Design (default), user-template=My Template

Available options:
template,
custom,
user-template
selected_template_id
string<uuid>

Required when visual + user-template; from GET /layouts

description
string

Additional context about the event for the AI to use during generation

Maximum string length: 2000

Response

Sales event page generation started

data
object
Last modified on August 30, 2026