Onboarding

Instant tenant + agent + API key provisioning (sandbox)

Public self-serve bootstrap endpoint. Returns API key once. Persist it securely because it cannot be recovered later.

post/v1/onboarding/instant

Request

  • Base URL: https://api.thrd.email
  • URL: https://api.thrd.email/v1/onboarding/instant
  • Auth: none declared

Request body

tenant_namestring

Optional tenant display name. If omitted or blank, server autogenerates one.

agent_namestring required

Required sender display name (used in the From header).

contact_emailstring email
inbox_prefixstring

Optional local-part base chosen by the agent. Server appends '-<4 alphanumeric>' to avoid duplicates.

source'human' | 'agent'
product_updates_consentboolean

Records onboarding intent only and requires contact_email. Commercial consent remains disabled until a later verified human action.

challenge_tokenstring

Opaque provider-neutral challenge response when adaptive onboarding risk checks request one.

Response

Provisioned instantly

Changes

No recorded changes to this operation across all 1 revision of this API.