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"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "article_type": "salesevent",
    "title": "<string>",
    "event": {
      "name": "<string>",
      "location": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "description": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "message": "<string>"
  }
}

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.

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 7, 2026