Skip to content

Varmply Backend API (0.1.0)

Varmply API – MVP backend for campaigns, wallets, authentication, and influencer participation.

Error Messages

Common error codes: - NOT_FOUND - Resource not found (404) - VALIDATION_ERROR - Input validation failed (400) - PERMISSION_DENIED - User lacks permission (403) - CONFLICT - Resource conflict (409) - UNAUTHORIZED - Authentication required (401) - INTERNAL_SERVER_ERROR - Unexpected server error (500)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs-staging.varmply.com/_mock/openapi/
Local development server
http://localhost:3000/
Staging environment
https://api-staging.varmply.com/
Production environment
https://api.varmply.com/

Health

Health check endpoints

Operations

Authentication

User registration, authentication, and email verification

Operations

Onboarding

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

Operations

Connections

Social media platform connection status and management

Operations

OAuth

Social media OAuth connection flows

Operations

Create or update sponsor profile

Request

Creates or updates the sponsor profile for the authenticated user. This endpoint is for sponsors (BRAND, ARTIST roles) to manage their organization profile information.

Security
bearerAuth
Bodyapplication/jsonrequired
displayNamestringnon-emptyrequired

Human-friendly name shown in UI

Example: "My Brand"
organizationNamestring or null

Organization or company name

Example: "My Company Inc."
websiteUrlstring or null(uri)

Website URL

Example: "https://example.com"
contactEmailstring or null(email)

Contact email (defaults to user email if not provided)

Example: "contact@example.com"
curl -i -X PUT \
  https://docs-staging.varmply.com/_mock/openapi/sponsor/profile \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "My Brand",
    "organizationName": "My Company Inc.",
    "websiteUrl": "https://example.com",
    "contactEmail": "contact@example.com"
  }'

Responses

Sponsor profile created or updated successfully

Bodyapplication/json
sponsorProfileobject
Response
application/json
{
  "sponsorProfile": {
    "id": "sponsor_profile_123",
    "displayName": "My Brand",
    "organizationName": "My Company Inc.",
    "websiteUrl": "https://example.com",
    "contactEmail": "contact@example.com"
  }
}

Wallet

Wallet balance and operations

Operations

Campaigns

Campaign creation, management, and funding

Operations

Marketplace

Public marketplace for discovering and joining campaigns

Operations

Participation

Campaign participation and content submission (creator-focused)

Operations

Analytics

Analytics and reporting endpoints for campaigns, participations, and submissions

Operations

Metrics

Metrics ingestion and refresh endpoints for participations and campaigns

Operations

Notifications

User notification management endpoints

Operations

Dev

Development-only endpoints for testing (not available in production)

Operations