Skip to main content
POST
Create a special closing

Authorizations

x-api-key
string
header
required

Location/organization API key.

Headers

Idempotency-Key
string
required

Unique key that makes this create safe to retry; replays return the original response.

Path Parameters

location_id
string
required

Body

application/json
starts_at
string<date-time>
required
ends_at
string<date-time>
required
reason
string

Human-readable reason passed to the AI clerk as context so it can explain the closing to customers.

Response

The created special closing.

id
string
Example:

"6f094f38-0044-463c-9112-cf445c9ba5e5"

object
enum<string>
Available options:
special_closing
location_id
string
starts_at
string<date-time>
ends_at
string<date-time>
reason
string | null

Human-readable reason passed to the AI clerk as context so it can explain the closing to customers.

created_at
string<date-time>
updated_at
string<date-time>