Skip to content

POST Create Referral Code endpoint.

Endpoint

POST/web/v1/partner/referral-codes WEB

Authentication

  • Chain: WEB
  • JWT Token: true
  • API Key: false
  • Permissions: ["referral:write"]
  • Secure Channel: DISABLED

Rate Limit

120 requests per 60 seconds.

Headers

Frontend Headers

HeaderRequiredDescription
X-LOCALEYes用户的 locale
Accept-LanguageNo语言偏好

Cloudflare Headers

HeaderRequiredDescription
CF-Connecting-IPYesClient IP from Cloudflare
CF-IPCountryYesClient country code
CF-RayYesCloudflare Ray ID
CF-VisitorYesVisitor scheme
X-Real-IPYesReal client IP

Nginx Headers

HeaderRequiredDescription
X-PORTAL-ACCESS-CODEYesPortal access code
X-Real-IPYes客户端真实 IP
X-Forwarded-ForYes代理链
X-Forwarded-ProtoYes协议

Request Parameters

Body (JSON)

FieldTypeRequiredDescription
accountBizIdStringYesAccount business ID (max 64, must match current operator)
referralCodeStringNoReferral code (max 32)
extraDataStringNoExtra data

Response

201 Created

FieldTypeDescription
bizIdStringBusiness ID
accountBizIdStringAccount business ID
accountEmailStringAccount email
accountNameStringAccount name
referralCodeStringReferral code
codeStatusIntegerReferral code status
extraDataStringExtra data
createdAtInstantCreation time
updatedAtInstantUpdate time

Phase 3 Simulation

SlaunchX Internal Documentation