Record onboarding step

POST

/api/v1/beta/onboarding/step

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

• Production
• Local development

Record completion of an onboarding step for the current user.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

OnboardingStepRequest

Request body for recording an onboarding step.

Attributes: step: Step name (e.g. “welcome”, “business_scan”, “first_action”).

object

step

required

Step

Step name

string

>= 1 characters <= 100 characters

Example^generated

{
  "step": "example"
}

Responses

201

Successful Response

Media typeapplication/json

Response Record Onboarding Step Api V1 Beta Onboarding Step Post

object

key

additional properties

string

Example^generated

{
  "additionalProperty": "example"
}

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"
    }
  ]
}