Sync user to external account

Sync a user to an external account.

POST /users/sync-to-external-account

Sync user to external account

cURL

curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/users/sync-to-external-account \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "email": "<string>",
  "externalUserId": "<string>",
  "displayName": "<string>",
  "profilePictureUrl": "<string>",
  "username": "<string>"
}
'

200

{
  "id": "<string>",
  "username": "<string>",
  "points": 123,
  "keys": 123,
  "xp": {
    "total": 1,
    "knowledge": 1,
    "creativity": 1,
    "loyalty": 1,
    "influence": 1,
    "participation": 1,
    "contribution": 1
  },
  "communityData": [
    {
      "communityId": "<string>",
      "streak": {
        "currentStreak": 1,
        "lastExtendedAt": "<string>",
        "longestStreak": 1
      },
      "challengesCompleted": 1,
      "achievementsCompleted": 1,
      "points": 123,
      "xp": {
        "total": 1,
        "knowledge": 1,
        "creativity": 1,
        "loyalty": 1,
        "influence": 1,
        "participation": 1,
        "contribution": 1
      },
      "hasAcceptedRules": true
    }
  ],
  "createdAt": "<string>",
  "roles": [
    "<string>"
  ],
  "email": "<string>",
  "isAnonymous": true,
  "updatedAt": "<string>",
  "organisationId": "<string>",
  "displayName": "<string>",
  "bio": "<string>",
  "profilePictureUrl": "<string>",
  "emailVerified": "<string>",
  "locale": "<string>",
  "socialHandles": {
    "instagram": "<string>",
    "loyaltyCardNumber": "<string>",
    "tiktok": "<string>"
  },
  "fullName": "John Doe",
  "parentEmail": "<string>",
  "birthDay": 123,
  "birthMonth": 123,
  "birthYear": 123,
  "externalUserId": "<string>"
}

Authorizations

x-api-token · string · header · required

Body

application/json

email · string · required

externalUserId · string · required

displayName · string | null

profilePictureUrl · string | null

username · string | null

Response

200

application/json

Successful response

A user

id · string · required

username · string · required

points · number · required

keys · number · required

xp · User XP Breakdown · object · required

User XP Breakdown

Show child attributes

communityData · object[] · required

Show child attributes

createdAt · string · required

roles · string[] · required

email · string · required

isAnonymous · boolean · required

updatedAt · string · required

organisationId · string | null

displayName · string | null

bio · string | null

profilePictureUrl · string | null

emailVerified · string | null

locale · string | null

socialHandles · SocialHandles · object

Social media handles and loyalty information for a user

Show child attributes

fullName · string | null

Example:

"John Doe"

parentEmail · string | null

birthDay · number | null

birthMonth · number | null

birthYear · number | null

externalUserId · string | null