Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Basics

Create Website

Creates a new website in your organization. The website will be created with onboarding step 1, ready for further configuration. Partner integrations may include an external_id to map their own identifier onto the new Athena website.

post/api/v1/websites

Request body

urlstring uri required

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

external_idstring

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.

Example request

{
  "url": "https://example.com",
  "external_id": "ws_a7f3b2c9"
}

Response

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

billingEntityCreatedboolean 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.

Example response

{
  "website": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "websiteUrl": "example.com",
    "orgId": "987e6543-e21b-12d3-a456-426614174000",
    "onboardingStep": 1,
    "externalId": "ws_a7f3b2c9"
  }
}