Skip to main content
POST
Create user metadata

Authorizations

X-API-KEY
string
header
required

Body

application/json

Body

Schema for a create user metadata schema

userId
string<uuid>
walletAddress
string
isBlocked
boolean
epicAccountIdentifier
string | null
discordUser
string | null
discordUserId
string | null
twitterUser
string | null
twitterUserFollowersCount
number | null
twitterUserId
string | null
emailAddress
string<email> | null
walletGroupIdentifier
string | null
userGroupId
string<uuid>
telegramUserId
string | null
telegramUsername
string | null
steamUserId
string | null
Maximum string length: 128
steamUsername
string | null
Maximum string length: 128
googleUserId
string | null
Maximum string length: 128
googleUser
string | null
YTChannelId
string | null
displayName
string | null
location
string | null
Maximum string length: 255
bio
string | null
Maximum string length: 255
portfolioUrl
string | null
Maximum string length: 255
externalLoyaltyScore
string | null
blockStatusReason
enum<string> | null
Available options:
sybil_and_multi_account,
account_migration,
abuse_manipulation,
not_sybil,
issue_resolved,
twitter_suspended,
other
isBlockExempt
boolean
internalNotes
string | null
logoUrl
string | null
userGroupExternalIdentifier
string | null
externalIdentifier
string | null
Maximum string length: 255
websiteId
string<uuid>
organizationId
string<uuid>
tiktokUser
string | null
tiktokUserId
string | null
sybilScore
number | null
Required range: 1 <= x <= 100
githubUser
string | null
githubUserId
string | null
phoneNumber
string | null

Phone number in E.164 format (e.g., +14155552671)

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+14155552671"

Response

200

Schema for a user metadata

id
string<uuid>
required

Unique identifier for the user metadata

Example:

"123e4567-e89b-12d3-a456-426614174000"

websiteId
string<uuid>
required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174001"

organizationId
string<uuid>
required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174002"

walletGroupIdentifier
string | null
required

Identifier for the user wallet group set via api

Example:

"wallet-group-id"

userGroupId
string<uuid> | null
required

Identifier for the user group set via api

Example:

"user-group-id"

userGroup
User group · object | null
required

User group associated with the user

Example:
user
object
required
createdAt
string<date-time>
required

Timestamp when the wallet was created

Example:

"2023-10-01T12:34:56Z"