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

    Create ticket type

    Creates a validated ticket type for an organization-owned campaign; price, capacity and attendee fields remain server-controlled records.

    POSThttps://api.sparkglim.net/api/white-label/v1/ticket-types

    Access model

    Access model
    Server-side Organization HMAC
    Required scope
    tickets:write
    Documented availability
    Implemented in source

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

    Private signing stays on your server. API Version 1 uses signature format v2; it is not API v2.

    Headers

    NameTypeValidation
    x-white-label-domainRequired

    Verified website hostname used to resolve the approved organization account and bind this request.

    		stringValidation: verified HTTPS hostname.
    x-white-label-key-idRequired

    Identifier extracted from the single issued Private Key value; never send its secret in this header.

    		stringValidation: issued private key internal identifier.
    x-white-label-signature-versionRequired

    Selects the domain-bound signing format; API routes remain Version 1.

    		stringValidation: 2.
    x-white-label-timestampRequired

    Request signing time in milliseconds, checked against the server clock to reject stale requests.

    		stringValidation: 13 digit milliseconds; within five minutes.
    x-white-label-nonceRequired

    Fresh random signing value recorded by the server to reject replay of a signed request.

    		stringValidation: fresh 16–128 [A-Za-z0-9_-].
    x-white-label-signatureRequired

    HMAC-SHA256 of the canonical domain, idempotency key, campaign credential, timestamp, nonce, method, path, sorted query and exact body hash.

    		stringValidation: lowercase hexadecimal HMAC-SHA256.
    x-white-label-campaign-keyOptional

    Optional complete Campaign Key that narrows a private request to the same authorized campaign.

    		stringValidation: complete optional scoped keyId:secret.

    Request

    NameTypeValidation
    campaignIdRequired

    Existing campaign record within the caller’s account and any narrower campaign credential.

    		stringValidation: UUID.
    nameRequired

    Display name of the ticket type or participant managed by this operation.

    		stringValidation: 2–120.
    priceRequired

    Ticket price stored and validated by the server in the campaign currency.

    		numberValidation: >=0.
    quantity_availableRequired

    Configured ticket inventory; selling and concurrent purchase checks remain on SparkGlim Server.

    		integerValidation: >=0.
    descriptionOptional

    Organizer-provided description explaining this campaign or ticket type.

    		string|nullValidation: <=1000.
    ticket_typeOptional

    Configured admission tier, including paid, free or group ticket definitions.

    		enumValidation: paid | free | early_bird | vip | student | group.
    statusOptional

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

    		enumValidation: active | inactive | sold_out.
    is_freeOptional

    Marks a supported free ticket; free fulfillment remains a server-controlled flow.

    		booleanValidation: default false.
    max_per_personOptional

    Maximum configured ticket quantity per buyer, enforced during purchase.

    		integerValidation: >0.
    image_urlOptional

    URL of the resource’s supplied image; use authorized public media.

    		string|nullValidation: URL.
    required_attendee_fieldsOptional

    Existing attendee-field configuration required for this ticket type.

    		object[]Validation: configured attendee fields.

    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/v1/ticket-types
    http
    POST /api/white-label/v1/ticket-types HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
Content-Type: application/json

{
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "name": "Example ticket",
  "price": 10,
  "quantity_available": 100
}

    Response

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

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

    Limits & retries

    Organization limiter: 120 requests per key and 300 per IP per window; honor Retry-After and X-RateLimit headers.

    Source compatibility

    Authorized operations require account-specific testing.

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

    Continue building