Skip to documentation
SparkGlimDeveloper
AI integration hub
SparkGlimSparkGlim Developer
Search all documentation

Try a topic in your language or an exact API path.

    Documentation navigation

    API reference

    Request approval

    Records a review request for a supported account resource; escalation and account oversight policy determine the next reviewer.

    POSThttps://api.sparkglim.net/api/white-label/portal/reseller/approval-requests

    Access model

    Access model
    SparkGlim session and member permissions
    Required scope
    oversight:escalate
    Documented availability
    Implemented in source

    Availability is verified from source, not a live production guarantee.

    Use the creator-team member workflow. Reseller access never grants unrestricted database or administrator access.

    Headers

    NameTypeValidation
    AuthorizationRequired

    Existing SparkGlim bearer session; server account membership and assigned capabilities still authorize each operation.

    		stringValidation: Bearer existing authenticated session token.

    Request

    NameTypeValidation
    entityTypeRequired

    Review-resource classification or supporting evidence retained for the account approval and oversight process.

    		enumValidation: member | campaign | withdrawal | payout | payment_method | ussd | provider | setting.
    entityIdOptional

    Existing account-scoped relationship or review record; ownership and required capabilities are checked on the server.

    		string|nullValidation: <=160.
    sparkglimReviewRequiredOptional

    Review-resource classification or supporting evidence retained for the account approval and oversight process.

    		booleanValidation: default false.
    riskScoreOptional

    Review-resource classification or supporting evidence retained for the account approval and oversight process.

    		integerValidation: 0–100.
    reasonOptional

    Explanation retained with the account’s approval or review record.

    		string|nullValidation: <=2000.
    requestPayloadOptional

    Review-resource classification or supporting evidence retained for the account approval and oversight process.

    		objectValidation: JSON object.
    metadataOptional

    Additional JSON metadata accepted by the documented schema; it never overrides authorization, prices or account ownership.

    		objectValidation: JSON object.

    Request

    Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

    POST /api/white-label/portal/reseller/approval-requests
    http
    POST /api/white-label/portal/reseller/approval-requests HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "entityType": "campaign",
  "reason": "Example approval request",
  "requestPayload": {}
}

    Response

    Success response · HTTP 201
    json
    {
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  }
}
    Error response · HTTP 400
    json
    {
  "success": false,
  "error": "<ERROR_MESSAGE>"
}

    Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

    Limits & retries

    Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

    Source compatibility

    Authorized operations require account-specific testing.

    • server/src/api/router.ts
    • server/src/api/routes/white-label.ts
    • server/src/white-label/reseller-service.ts
    • server/src/white-label/schemas.ts

    Continue building