Save the authenticated user's onboarding profile.

PUT /me/onboarding

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "email": "[e-mail]",
  "avatar_url": "<string>",
  "status": "active",
  "profile": {
    "display_name": "<string>",
    "legal_name": "<string>",
    "phone": "<string>",
    "acquisition_source": "<string>",
    "category_ids": [
      "<string>"
    ],
    "birth_date": "2023-12-25",
    "gender": "male"
  },
  "roles": [
    "<string>"
  ],
  "permissions": [
    "<string>"
  ],
  "referral_code": "<string>",
  "onboarding_completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

legal_name · string · required

Required string length: 1 - 160

birth_date · string<date> · required

gender · enum<string> · required

Available options: male, female, prefer_not_to_say

phone · string · required

Required string length: 1 - 40

category_ids · string[] · required

Required array length: 1 - 20 elements

acquisition_source · string · required

Required string length: 1 - 80

Response

200

application/json

Persisted profile and completed onboarding state.

id · string · required

email · string<email> · required

avatar_url · string · required

status · enum<string> · required

Available options: active, suspended, banned

profile · object · required

Show child attributes

roles · string[] | null · required

permissions · string[] | null · required

referral_code · string · required

onboarding_completed_at · string<date-time>