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

    Update member relationship

    Updates the reseller relationship and synchronizes the linked authorized creator-team member where present.

    PATCHhttps://api.sparkglim.net/api/white-label/portal/reseller/members/:memberId

    Access model

    Access model
    SparkGlim session and member permissions
    Required scope
    members:write
    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.

    Parameters

    NameTypeValidation
    memberIdRequired

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

    		stringValidation: UUID or documented resource identifier.

    Request

    NameTypeValidation
    userIdOptional

    Optional existing user association; this operation does not create an unrestricted creator account.

    		string|nullValidation: UUID existing user only.
    creatorIdOptional

    Authorized creator-team owner for the reseller relationship; defaults to the reseller owner where configured.

    		string|nullValidation: UUID authorized owner; defaults reseller creator.
    memberTypeOptional

    Reseller relationship role; assigned capabilities and creator-team permissions remain separately enforced.

    		enumValidation: owner | operator | finance | support | sub_creator.
    statusOptional

    Requested supported lifecycle state; account and campaign approval rules still control publication and access.

    		enumValidation: invited | pending | active | suspended | revoked.
    displayNameOptional

    Public display label for the member or contributor; it does not change account ownership.

    		string|nullValidation: 2–160.
    emailOptional

    Contact email used by the configured campaign or account workflow; never a credential granting access by itself.

    		string|nullValidation: email.
    phoneOptional

    Member or applicant contact phone used by the existing account workflow.

    		string|nullValidation: 8–40.
    rolesOptional

    Reseller role assignments accepted by the member schema, separately limited by server permissions.

    		string[]Validation: supported reseller roles.
    permissionsOptional

    Requested supported capabilities, limited by the account policy and caller’s authorization.

    		string[]Validation: supported reseller capabilities.
    otpRequiredOptional

    Controls the supported verification requirement for the resource; it does not bypass server eligibility checks.

    		booleanValidation: default true.
    kycStatusOptional

    Account review state recorded for this reseller relationship; it does not independently authorize payments.

    		enumValidation: not_required | pending | verified | rejected.
    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.

    PATCH /api/white-label/portal/reseller/members/:memberId
    http
    PATCH /api/white-label/portal/reseller/members/11111111-1111-4111-8111-111111111111 HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "displayName": "Example member"
}

    Response

    Success response · HTTP 200
    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