Request an email domain

Records a pending claim on a domain for Vitable to verify. The claim grants nothing until then — it does not auto-join anyone and does not reserve the domain against another organization. Requesting a domain the organization already claims returns that claim unchanged rather than creating a second one.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Headers

X-Vitable-OrganizationstringOptional

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.

Request

This endpoint expects an object.

domainstringRequired<=253 characters

Bare email domain to claim, without the local part — acme.com, not jane@acme.com. Matching is exact, so mail.acme.com is a separate claim.

Response headers

X-RateLimit-Limitinteger

Maximum number of requests allowed within the rate limit window

X-RateLimit-Remaininginteger

Number of requests remaining in the current rate limit window

X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error