Prepare a single-use sign-up link for a person (no account or trial is created)

Returns handoff_url and expires_in_seconds. The link carries language, industry and recommended plan into registration and onboarding and works once. The account and the trial are created only when the person signs up. Rate limited to 20 requests per hour per IP, REST and MCP together. Disabled by default: 503 with error handoff_disabled; /agents/start shows the current status.

post/api/agents/handoff

Request

  • Base URL: https://smartwebchat.eu
  • URL: https://smartwebchat.eu/api/agents/handoff
  • Auth: none required

Headers

Idempotency-Keystring

Send the same key on every retry of the same request: while the link is valid (up to 15 minutes) the retry returns the same handoff_url, marked Idempotency-Replayed: true. The same key with a different body gives 422.

Request body

localestring

Language of the sign-up page, for example 'en'. Unsupported languages fall back to 'de'.

industry_key'anwaelte' | 'apotheken' | 'arztpraxen' | 'fahrschulen' | 'friseure' | 'handwerker' | 'heilmittelpraxen' | 'hotels' | 'immobilien' | 'kfz-werkstaetten' | 'kosmetikstudios' | 'pflegedienste' | 'pflegeheime' | 'physiotherapie' | 'restaurants' | 'sanitaetshaeuser' | 'steuerberater' | 'tieraerzte' | 'versicherungsmakler' | 'zahnaerzte'

Industry of the business, one of how_to_test.agent_demo_contract.industries in /agents/start.

recommended_plan'business' | 'agency' | 'white_label'

Plan you recommend: business, agency, white_label. Only plans with a trial preselect the trial type; the person can change it.

demo_session_idstring

Optional demo session id from the scanner demo; its context is restored after sign-up.

Response

Replay of the same request (Idempotency-Replayed: true).

Changes

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