# Onboarding

User onboarding flow for all user types, including role assignment, profile setup (creator and sponsor), and settings configuration

## Get authenticated user snapshot

 - [GET /me](https://docs-staging.varmply.com/openapi/onboarding/getauthenticatedusersnapshot.md): Returns a canonical snapshot of the authenticated user including identity, roles, profile, onboarding status, and platform connections. This is a read-only endpoint that does not mutate any data.

## Update creator profile

 - [PATCH /me/profile](https://docs-staging.varmply.com/openapi/onboarding/updateuserprofile.md): Updates creator profile fields (displayName, profilePhotoUrl). This endpoint is for
creators (INFLUENCER role) to manage their personal profile information.
Both fields are optional, but required for creator marketplace readiness.


Validation rules:
- displayName: 2-40 characters, trimmed, cannot be only whitespace
- profilePhotoUrl: Must be a valid HTTPS URL, or null to clear

For creators (INFLUENCER role), both displayName and profilePhotoUrl are required
for marketplace readiness. Updating these fields will update the onboarding status.

## Update user settings

 - [PATCH /me/settings](https://docs-staging.varmply.com/openapi/onboarding/updateusersettings.md): Updates user settings (timezone, notifications) for all user types (creators and sponsors).
Returns the updated /me response.

## Get user settings

 - [GET /me/settings](https://docs-staging.varmply.com/openapi/onboarding/getusersettings.md): Returns a canonical snapshot of user settings including profile fields, roles, capabilities,
onboarding status, notification defaults, and integration capabilities. This is the single
source of truth for frontend gating decisions.

## Assign roles to user

 - [POST /me/roles/assign](https://docs-staging.varmply.com/openapi/onboarding/assignuserroles.md): Assigns roles to the authenticated user. Only ARTIST, BRAND, and INFLUENCER are allowed. ADMIN cannot be assigned. This operation is idempotent - adding an already-present role is a no-op. Returns the updated /me response.

## Get platform connections

 - [GET /me/platform-connections](https://docs-staging.varmply.com/openapi/onboarding/getplatformconnections.md): Returns the platform integration capabilities for the authenticated user. Same data as the connectedPlatforms field in /me response.