Skip to main content

Overview

The Admin API is your command center for the Nudj platform, providing comprehensive control over every aspect of your gamified community. It enables you to build, customize, and manage engaging experiences at scale.

Base URL

Replace {subdomain} with your organization’s subdomain (e.g., acme-corp.nudj.cx).

Authentication

Admin tokens grant extensive platform control. Only trusted administrators should have access. Tokens are scoped to specific organizations and roles.

Core Capabilities

Community Builder

Design branded spaces with custom themes, domains, and content

Gamification Engine

Configure challenges, achievements, leaderboards, and progression systems

Reward Manager

Distribute prizes, manage giveaways, and track redemptions

User Administrator

Manage members, teams, roles, and permissions at scale

Content Controller

Create posts, moderate content, and manage community interactions

Platform Configurator

Set feature flags, integrations, variables, and system settings

Platform Management Areas

🏗️ Community Building

Build and customize engaging community spaces with full control over branding, structure, and member experience.
Complete community lifecycle management
  • Create multi-tenant branded spaces
  • Configure onboarding flows and requirements
  • Set member permissions and access controls
  • Customize navigation and layout
  • Manage community-wide settings and features
Visual customization engine
  • Custom color schemes and typography
  • Logo and asset management
  • Light/dark mode configurations
  • Component styling overrides
  • Custom CSS injection
Key endpoints:
  • GET/PATCH /themes - Theme configuration
  • POST /domains - Custom domain setup
Rapid deployment with pre-built templates
  • Community templates for different industries
  • Challenge bundles for common use cases
  • Achievement sets for various goals
  • Reward catalogs by category
  • Action libraries for engagement

🎮 Gamification System

Design sophisticated engagement mechanics with challenges, achievements, and progression systems.
Multi-step quest builder
  • Sequential and parallel action paths
  • Multiple action types available
  • Prerequisites and unlocking logic
  • Time-based challenges
  • Group challenges for team competition
Action Types Available:
  • Social media integrations
  • Content creation (posts, comments)
  • External link actions
  • Custom actions
Milestone and badge configuration
  • Progress-based achievements
  • Hidden/secret achievements
  • Tiered achievement chains
  • Custom unlock criteria
  • Visual badge designer
Criteria Types:
  • Action completions
  • Point thresholds
  • Streak maintenance
  • Community contributions
  • Time-based milestones
Competitive dynamics engine
  • Global, regional, and group leaderboards
  • Multiple ranking metrics (points, XP, achievements)
  • Time-scoped competitions (daily, weekly, seasonal)
  • Prize distribution automation
  • Real-time position tracking
Advanced gamification mechanics
  • Spin wheels and slot machines
  • Daily check-in bonuses
  • Loot boxes and mystery rewards
  • Mini-games and instant wins
  • Probability-based rewards
Key endpoints:
  • POST /game-configs - Create game
  • PATCH /game-configs/{id} - Update mechanics

🎁 Rewards & Incentives

Comprehensive reward management from creation to fulfillment, supporting physical, digital, and experiential prizes.
Multi-type reward system
  • Digital: Codes, vouchers, subscriptions
  • Physical: Merchandise, products, gift cards
  • Experiential: Event tickets, meetups
  • Virtual: Points, badges, titles
Inventory Management:
  • Stock tracking and alerts
  • Automatic reordering
  • Expiration handling
  • Regional availability
Flexible reward allocation
  • Direct: Manual distribution to users
  • Earned: Automatic on achievement
  • Purchased: Points marketplace
  • Giveaway: Random selection
  • Leaderboard: Rank-based distribution
  • Milestone: Progress rewards
End-to-end fulfillment
  • Redemption workflows
  • Shipping integration
  • Digital delivery automation
  • Tax documentation support
  • Customer support tools

👥 User & Team Management

Complete member lifecycle management with sophisticated role-based access control and team collaboration features.
Comprehensive member management
  • Bulk import/export
  • Custom profile fields
  • Role assignment
  • Activity monitoring
  • Points/XP adjustments
  • Account suspension/deletion
Multi-level hierarchy
  • Organization structure
  • Department/team creation
  • Role-based permissions
  • Invitation management
  • Access control lists
  • Cross-team competitions
Currency management system
  • Manual point adjustments
  • Transaction history
  • Balance corrections
  • Refunds and reversals
  • Currency conversion
  • Audit trails

⚙️ Platform Configuration

System-wide settings and integrations for complete platform customization.
Identity provider configuration
  • SSO/SAML setup
  • OAuth providers
  • Magic link authentication
  • MFA requirements
  • Session management
  • Password policies
Third-party connections
  • Social media platforms
  • Analytics services
  • Communication tools
  • Custom webhook integrations
Dynamic configuration
  • Environment-specific settings
  • A/B testing parameters
  • Feature toggles
  • Rate limits
  • Threshold values
  • System constants
Real-time event streaming
  • Custom event subscriptions
  • Payload customization
  • Retry policies
  • Event filtering
  • Webhook security
  • Audit logging

API Resource Groups

Quick Start Examples

Common Workflows

  1. Create campaign structure with challenges
  2. Configure rewards and distribution rules
  3. Set up leaderboards and competitions
  4. Enable relevant feature flags
  5. Configure webhooks for tracking
  6. Import or invite users
  7. Monitor via analytics
  1. Create reward with inventory
  2. Define eligibility criteria
  3. Set participation period
  4. Process random selection
  5. Notify winners
  6. Handle fulfillment
  7. Generate tax documents
  1. Create organization and community
  2. Configure SSO authentication
  3. Apply custom theme and domain
  4. Set up team structure
  5. Import users with roles
  6. Deploy from templates
  7. Configure integrations
  1. Create time-limited challenges
  2. Configure special rewards
  3. Set up event leaderboards
  4. Enable event features
  5. Schedule content
  6. Automate distributions
  7. Archive post-event

Response Format

All Admin API responses follow a consistent structure:

Error Handling

Rate Limits & Performance

Admin operations can affect many users. Rate limits are enforced to maintain platform stability.
Rate limits are enforced on all Admin API endpoints. Check response headers for current limits:
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After

Security & Compliance

Role-Based PermissionsSecurity Requirements
  • Strong authentication required for admin accounts
  • API tokens should be kept secure and rotated regularly

Migration & Deployment

Advanced Features

Bulk Operations

Process multiple records efficiently with batch endpoints

Webhook Support

Real-time event notifications for system changes

Support & Resources

API Reference

Detailed endpoint documentation

SDKs & Libraries

Official client libraries

Status Page

Service health monitoring

Developer Forum

Community support

Enterprise Support

Priority assistance

Changelog

Latest updates