Submit onboarding step

POST

/api/v1/enterprise/onboarding/step/{step_number}

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/enterprise/onboarding/step/1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "data": {} }'

• Production
• Local development

Submit a single onboarding step (1-6) and get the step result.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

step_number

required

Step Number

integer

Request Body^required

Media typeapplication/json

SubmitOnboardingStepRequest

Request body for submitting a single onboarding step.

Attributes: data: Step-specific data payload.

object

data

required

Data

Step-specific data payload

object

key

additional properties

any

Example^generated

{
  "data": {}
}

Responses

200

Successful Response

Media typeapplication/json

OnboardingStepResponse

Response for a single onboarding step submission.

object

result

required

Result

step

required

Step

integer

Example^generated

{
  "result": "example",
  "step": 1
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}