Skip to main content

Error Response Format

{
  "error": "Error message",
  "code": "ERROR_CODE"
}

Common Error Codes

HTTPCodeDescription
400VALIDATION_ERRORRequest parameter validation failed
400BAD_REQUESTInvalid request
401UNAUTHORIZEDAuthentication failed (API key error)
403FORBIDDENAccess denied
404NOT_FOUNDResource not found
409CONFLICTDuplicate resource
500INTERNAL_ERRORInternal server error

Date/Time Format

All date/time values must be sent in ISO 8601 format in UTC timezone. Format
YYYY-MM-DDTHH:mm:ss.sssZ
Example
{
  "purchasedAt": "2024-01-15T10:30:00.000Z"
}
ComponentDescriptionExample
YYYY-MM-DDDate (year-month-day)2024-01-15
TDate and time separatorT
HH:mm:ssTime (hour:minute:second)10:30:00
.sssMilliseconds (optional).000
ZUTC timezone indicatorZ
Send times in UTC, not local timezone. For example, 7:30 PM KST (Korea Standard Time, UTC+9) should be sent as 10:30 AM UTC (10:30:00Z).
Language Examples
// JavaScript
const now = new Date();
const isoString = now.toISOString();
// "2024-01-15T10:30:00.000Z"
# Python
from datetime import datetime, timezone

now = datetime.now(timezone.utc)
iso_string = now.isoformat(timespec='milliseconds').replace('+00:00', 'Z')
# "2024-01-15T10:30:00.000Z"
// Java
import java.time.Instant;

String isoString = Instant.now().toString();
// "2024-01-15T10:30:00.000Z"

Server API Endpoints

FunctionMethodEndpoint
Sponsor
Create/Update sponsorPOST/v1/server/sponsors
Get sponsor statusGET/v1/server/sponsors/user/:userId
Remove sponsorDELETE/v1/server/sponsors/user/:userId
Payment
Create paymentPOST/v1/server/payments
Get paymentGET/v1/server/payments/:transactionId
Get user paymentsGET/v1/server/payments/user/:userId
Refund paymentPOST/v1/server/payments/:transactionId/refund
Coupon
Validate couponPOST/v1/server/coupons/validate
Redeem couponPOST/v1/server/coupons/redeem
Get user couponsGET/v1/server/coupons/user/:userId
Query
List campaignsGET/v1/server/campaigns
Get campaignGET/v1/server/campaigns/:id
Search creatorsGET/v1/server/creators/search
Get creatorGET/v1/server/creators/:creatorKey
Get creator couponsGET/v1/server/creators/:creatorKey/coupons
Webhook
List webhooksGET/v1/server/webhooks
Create webhookPOST/v1/server/webhooks
Update webhookPUT/v1/server/webhooks/:id
Delete webhookDELETE/v1/server/webhooks/:id
Get webhook logsGET/v1/server/webhooks/:id/logs
Test webhookPOST/v1/server/webhooks/:id/test

Client API Endpoints

FunctionMethodEndpoint
Campaign
List campaignsGET/v1/client/campaigns
Get campaignGET/v1/client/campaigns/:id
List campaign creatorsGET/v1/client/campaigns/:id/creators
List campaign packagesGET/v1/client/campaigns/:id/packages
Creator
Search creatorsGET/v1/client/creators/search
Get creatorGET/v1/client/creators/:creatorKey
Coupon
Validate couponPOST/v1/client/coupons/validate
Sponsor
Get sponsor statusGET/v1/client/sponsors