Skip to main content
POST
Add a custom domain

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

app_id
string
required

App ID (e.g. app_abc123def456)

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

domain
string
required

Customer domain (e.g. 'search.acme.com')

is_primary
boolean
default:false

Set as primary domain

Response

The newly added domain configuration

domain
string
required
status
string
required
is_primary
boolean
required
verification_token
string | null
cname_target
string | null
verified_at
string | null