Skip to main content
POST
Purchase domains on the card on file (priced preview without confirm)

Authorizations

Authorization
string
header
required

API key: Authorization: Bearer og_live_...

Query Parameters

confirm
boolean

Body

application/json
domains
string[]
required
Required array length: 1 - 20 elements
Required string length: 3 - 253
forwarding_domain
string
Required string length: 3 - 253
timezone
string
Minimum string length: 1
metadata
object

Response

Job admitted

Shared Job resource returned by every async operation. Poll GET /jobs/{job_id} honoring next_poll_at, or subscribe to job.* webhooks.

object
enum<string>
Available options:
job
id
string<uuid>
operation
string

Catalog operation id

status
enum<string>
Available options:
queued,
running,
needs_input,
succeeded,
failed,
cancelled
cancel_requested
boolean
phase
enum<string> | null
Available options:
researching,
fetching,
enriching,
drafting,
rendering
progress
object | null
target
object | null
metadata
object | null
next_poll_at
string<date-time> | null
result
object | null
credits
object | null

This Job's credit totals; null for non-spending operations. settled flips true after delivered-lead settlement writes back.

error
object | null
needs_input
object | null
chat_id
string | null
created_at
string<date-time>
updated_at
string<date-time>