Developer Marketing1.0.0-beta.1

Generate a Marketing QR code

Encodes an absolute HTTP(S) URL with the selected design and charges the token Space’s QR allowance. Optional logos must be supported inline raster data. Encoding makes no network request to the destination.

POST/api/v1/marketing/qr

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is marketing:qr:generate. Scopes are independent.

This operation uses 8 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The rendering group shares 30 requests per token and 80 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

requestIdstring (uuid)Required: Client request nonce used to discard stale responses.
payloadstringRequired: Exact absolute HTTP(S) URL, at most 1200 characters, including its original query and fragment. Maximum length: 1200.
designobjectRequired: No field description supplied.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request POST 'https://app.dashio.net/api/v1/marketing/qr' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "requestId": "4e9168d6-d26b-48a2-88d9-671772297afb",
  "payload": "https://example.com/launch?utm_source=poster",
  "design": {
    "foreground": "#172036",
    "background": "#ffffff",
    "transparentBackground": false,
    "moduleStyle": "square",
    "eyeStyle": "square",
    "errorCorrection": "M",
    "quietZone": 4,
    "logoDataUrl": null,
    "logoScale": 0.2,
    "logoBackdrop": false
  }
}'

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

Schema-generated example; not a captured response.

{
  "requestId": "d40beec9-3477-45cb-92e4-152f5b9d0686",
  "payload": "<payload>",
  "svg": "<svg>",
  "version": 1,
  "moduleCount": 0,
  "issues": [
    {
      "id": "<id>",
      "level": "error",
      "title": "<title>",
      "message": "<message>"
    }
  ]
}

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

Generated SVG markup, exact payload, request nonce and readability guidance.

Response headers

RateLimit-LimitintegerOptional: Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptional: Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptional: Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

requestIdstring (uuid)Required: No field description supplied.
payloadstringRequired: No field description supplied.
svgstringRequired: Server-generated SVG markup.
versionintegerRequired: Minimum: 1. Maximum: 40.
moduleCountintegerRequired: No field description supplied.
issuesarray of objectRequired: No field description supplied.

400

Unsupported parameters or invalid request data.

application/json

statusCodeintegerRequired: Minimum: 400. Maximum: 599.
statusMessagestringOptional: A safe explanation suitable for display.
dataobjectRequired: No field description supplied.

401

A valid developer token is required.