Skip to main content

Create User

POST 
/users

Creates a new user

Request​

Body

required

    user_id string

    Optional user hash ID (will be generated if not provided)

    handle stringrequired

    User handle (unique username)

    wallet stringrequired

    Wallet address (required)

    name string

    Display name

    bio string

    Possible values: <= 256 characters

    User bio

    location string

    User location

    website uri

    Website URL

    donation string

    Donation link

    twitter_handle string

    Twitter handle (without @)

    instagram_handle string

    Instagram handle (without @)

    tiktok_handle string

    TikTok handle (without @)

    profile_picture string

    Profile picture CID or URL

    profile_picture_sizes string

    Profile picture sizes metadata

    cover_photo string

    Cover photo CID or URL

    cover_photo_sizes string

    Cover photo sizes metadata

    profile_type stringnullable

    Possible values: [label]

    Type of profile (e.g., 'label' for record labels)

    allow_ai_attribution boolean

    Whether to allow AI attribution

    spl_usdc_payout_wallet string

    Solana USDC payout wallet address

    playlist_library

    object

    User's playlist library with support for folders and playlists

    contents

    object[]

    required

    Array of folders and playlist identifiers

  • Array [

    • oneOf

    id stringrequired

    Unique folder identifier

    type stringrequired

    Possible values: [folder]

    name stringrequired

    Folder name

    contents

    object[]

    required

    Nested folders and playlist identifiers

  • Array [

    • oneOf

    type stringrequired

    Possible values: [playlist]

    playlist_id integerrequired

    Playlist ID

  • ]

  • ]

    • events

    object

    User events for tracking referrals and mobile users

    referrer string

    Hash ID of the user who referred this user

    is_mobile_user boolean

    Whether the user is on mobile

Responses​

User created successfully

Schema

    success boolean

    Whether the user was created successfully

    transaction_hash string

    The blockchain transaction hash

    user_id string

    The ID of the created user

Loading...