Skip to main content
POST
/
sales-events
Create sales event page
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/sales-events \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "event_name": "Summer Blowout Sale",
  "start_date": "2026-07-04T09:00:00Z",
  "end_date": "2026-07-07T21:00:00Z",
  "location": "123 Main St, Springfield, IL",
  "category": "Sales Event"
}
'
{
  "data": {
    "id": "d97902b2-be6f-4f0e-8a80-e48a18df90cf",
    "status": "generating",
    "article_type": "salesevent",
    "title": "Spring Clearance Sale",
    "event": {
      "name": "Spring Clearance Sale",
      "location": "315 W Jericho Tpke, Huntington, NY 11743",
      "category": "Sales Event",
      "start_date": "2026-04-01T09:00:00Z",
      "end_date": "2026-04-07T21:00:00Z",
      "description": null
    },
    "created_at": "2026-02-28T11:43:57.502664+00:00",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt

Use this file to discover all available pages before exploring further.

Creates and generates a promotional page for a dealership sales event. Supports multiple event categories and generates compelling marketing content. Generation is asynchronous; use GET /content/{id} to check status and retrieve the result. Scope required: content:write

​
Request body

​
event_name
string
required
Name of the event (max 500 characters).
​
start_date
string
required
Event start date/time in ISO 8601 format.
​
end_date
string
required
Event end date/time in ISO 8601 format.
​
location
string
required
Event location or address (max 500 characters).
​
category
string
required
Event category. One of: Sales Event, New Model Launch, Owner Appreciation, Service Special, Community Event, Holiday Celebration, Test Drive Event.
​
description
string
Additional context about the event for the AI to use during generation (max 2000 characters).
​
brand_voice_id
string
ID of a brand voice profile to use for tone and style.
​
language
string
default:"English"
Language for generated content. One of: English, Spanish, Mandarin Chinese, Japanese, Korean, Arabic, Farsi, Hebrew, French, Tagalog, Vietnamese, Portuguese, Russian.
​
title
string
Custom page title (max 500 characters). Defaults to the event name.
​
content_depth
string
default:"balanced"
Content depth preset that drives the article body. One of concise, steady, balanced, substantial, or in-depth. Replaces content_length.
​
content_length
integer
deprecated
Deprecated. Article length is now driven by content_depth; this field is accepted for backward compatibility but has no effect.

​
Response

Returns 202 Accepted when the sales event page starts generating: 
{
  "data": {
    "id": "d97902b2-be6f-4f0e-8a80-e48a18df90cf",
    "status": "generating",
    "article_type": "salesevent",
    "title": "Spring Clearance Sale",
    "event": {
      "name": "Spring Clearance Sale",
      "location": "315 W Jericho Tpke, Huntington, NY 11743",
      "category": "Sales Event",
      "start_date": "2026-04-01T09:00:00Z",
      "end_date": "2026-04-07T21:00:00Z",
      "description": null
    },
    "created_at": "2026-02-28T11:43:57.502664+00:00",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
Content generation is asynchronous and typically completes within a few minutes. Configure webhooks to receive real-time content.completed and content.failed notifications instead of polling.
Use GET /content/{id} to poll for completion, then GET /content/{id}/html to retrieve the generated HTML.

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
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
​
description
string

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

Maximum string length: 2000
​
brand_voice_id
string

ID of a brand voice profile to use for tone and style

​
language
enum<string>
default:English
Available options:
English,
Spanish,
Mandarin Chinese,
Japanese,
Korean,
Arabic,
Farsi,
Hebrew,
French,
Tagalog,
Vietnamese,
Portuguese,
Russian
​
title
string

Custom page title. Defaults to the event name

Maximum string length: 500
​
content_length
integer
deprecated

Deprecated. Article length is now driven by content_depth; this field is accepted for backward compatibility but has no effect.

Required range: 200 <= x <= 5000
​
content_depth
enum<string>

Content depth preset that drives the article body. Defaults to balanced. Replaces the legacy content_length field.

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

Response

Sales event page generation started

​
data
object
Last modified on May 1, 2026