Add a registrable domain or a host to verify; returns its challenges
POST/v1/domains
The verification token belongs to your organization and the registrable domain: it is created with your first domain under that registrable domain, never changes, and is shared by every method and host below it. Adding a name you already have answers 409 domain_exists (details.domain_id).
Access: API key scope domains:write on a management key; portal users: organization admins and owners; refused with 403 integrations_disabled while domains are switched off for the platform or your organization.
Request
Responses
- 201
- 403
- 409
- 422
Created (status = unverified).
scope_missing (details.required_scope), role_insufficient, kb_not_in_allowlist, integrations_disabled (details.area, details.scope), domain_blocked.
webhook_limit, secret_rotation_in_progress, domain_exists, redelivery_unavailable, idempotency_key_conflict, idempotency_in_progress.
validation_failed, webhook_url_rejected (details.rule), event_type_unknown, domain_invalid, method_not_allowed_for_domain.