Skip to main content
POST
Create Website

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for creating a new website

url
string<uri>
required

The URL of the website to create. Protocol (http/https) and trailing slashes will be automatically removed.

Example:

"https://example.com"

external_id
string

Partner-only. An identifier from your own system to map to this Athena website. Accepted only when authenticating with an API key for an organization flagged as a partner. Sending this field as a direct customer returns 403 Forbidden. Must be unique per resource type within your organization — duplicates return 409 with the existing resource in the payload.

Minimum string length: 1
Example:

"ws_a7f3b2c9"

Response

Website created successfully. Partner responses include an externalId field (string or null); direct-customer responses omit the field entirely.

website
object
required

A newly created website resource

billingEntityCreated
boolean
required

Whether the billing entity exists after provisioning. When false, entity creation failed even after a retry: the website exists but has no credits, and setting credits fails with a 400 until it is repaired. Contact AthenaHQ support in that case.