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"
}
'

import requests

url = "https://api.app.hrizn.io/v1/public/sales-events"

payload = {
    "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"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.app.hrizn.io/v1/public/sales-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.app.hrizn.io/v1/public/sales-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/sales-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": "d97902b2-be6f-4f0e-8a80-e48a18df90cf",
    "status": "generating",
    "article_type": "salesevent",
    "title": "Sales Event - 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"
  }
}

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"
}
'

import requests

url = "https://api.app.hrizn.io/v1/public/sales-events"

payload = {
    "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"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.app.hrizn.io/v1/public/sales-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.app.hrizn.io/v1/public/sales-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/sales-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": "d97902b2-be6f-4f0e-8a80-e48a18df90cf",
    "status": "generating",
    "article_type": "salesevent",
    "title": "Sales Event - 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"
  }
}

Creates and generates a promotional page for a dealership sales event. Supports multiple event categories and the same create options as Composer (tone/voice, depth, geo, Layouts). Generation is asynchronous; use GET /content/{id} to check status and retrieve the result. Scope required: content:write

Request body

string

required

Name of the event (max 500 characters).

string

required

Event start date/time in ISO 8601 format.

string

required

Event end date/time in ISO 8601 format. Must be on or after start_date.

string

required

Event location or address (max 500 characters).

string

required

Event category. One of: Sales Event, New Model Launch, Owner Appreciation, Service Special, Community Event, Holiday Celebration, Test Drive Event.

string

Additional context about the event for the AI to use during generation (max 2000 characters).

string

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

string

Enum tone when not using a brand voice. Defaults to the site’s first brand voice, otherwise Informative.

string

default:"English"

Language for generated content. One of: English, Spanish, Mandarin Chinese, Japanese, Korean, Arabic, Farsi, Hebrew, French, Tagalog, Vietnamese, Portuguese, Russian.

string

Custom page title (max 500 characters). Defaults to Sales Event - {event_name}.

string

default:"balanced"

Content depth preset: concise, steady, balanced, substantial, or in-depth.

boolean

Optional override. Defaults to false only when content_depth is concise.

object[]

Optional geo targeting: [{ element_id, priority }] from GET /site/target-geography.

string

default:"standard"

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

string

When visual: custom (AI Design), user-template (My Template), or template.

uuid

Required when visual + user-template. Use GET /layouts?content_type=salesevent.

integer

deprecated

Deprecated. Accepted for backward compatibility but has no effect. Use content_depth.

Response

Returns 202 Accepted when the sales event page starts generating:

{
  "data": {
    "id": "d97902b2-be6f-4f0e-8a80-e48a18df90cf",
    "status": "generating",
    "article_type": "salesevent",
    "title": "Sales Event - 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

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"

Response

Sales event page generation started

data

object

Hide child attributes

data.id

string<uuid>

data.status

enum<string>

Content generation status

Available options:

generating,

complete,

failed

data.article_type

string

Example:

"salesevent"

data.title

string

data.event

object

Hide child attributes

data.event.name

string

data.event.location

string

data.event.category

enum<string>

Available options:

Sales Event,

New Model Launch,

Owner Appreciation,

Service Special,

Community Event,

Holiday Celebration,

Test Drive Event

data.event.start_date

string<date-time>

data.event.end_date

string<date-time>

data.event.description

string | null

data.created_at

string<date-time>

data.message

string

Informational message about async processing and webhook configuration

Last modified on July 26, 2026

Overview

IdeaClouds

Content Intelligence

Content

Content Types

Compliance

Content Tools

Inventory

Market

Site

Dealership Config

Social

Webhooks

Reference

Health

Analytics

IdeaClouds

Content

Compliance

Content Tools

Inventory

Market

Site

Webhooks

Content Intelligence

Reference

Social

Create sales event page

Request body

Response

Authorizations

Body

Response

​Request body

​Response

Authorizations

Body

Response

Request body

Response