Skip to content

Submit Agent Domain Response

POST
/agent/onboarding/domain-response

Answer the agent’s “is this your company domain?” card.

domain is REQUIRED when confirmed is false and ignored when it is true. The app enforces that with a 422 of its own, and this mirrors the model rather than the check, so a missing domain is refused by the handler with its own message rather than by a copy here that could drift.

A corrected domain is persisted immediately, so a late edit is not orphaned once the polling activity has already exited.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of DomainResponseRequest.

object
card_id
required

The domain_confirmation card id.

string
confirmed
required

True = the pre-filled domain is correct as it stands.

boolean
domain
Any of:
string
session_id
required

The proactive-setup canvas session id.

string

Responses

200

Successful Response

object
data
required

An open envelope for an onboarding or discovery result.

Open on purpose. Discovery state carries a per-field coverage matrix whose field set is the product’s own onboarding questionnaire - it changes as the questionnaire does, and a pinned mirror would silently DROP a field the customer had answered. On a surface whose whole job is “what do we still not know about you”, a dropped field reads as an answered question.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string