Developer Marketing1.0.0-beta.1

Save, default or delete a Brand Kit profile

Creates a profile when saveProfile has no ID. Replaces profile fields when it has an ID. Use setDefault to switch defaults and deleteProfile after its logos have been removed. A successful write returns the record ID only.

POST/api/v1/marketing/brand-kit

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:brand:write. Scopes are independent.

This operation uses 3 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute.

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.

Set DASHIO_IDEMPOTENCY_KEY to the persisted key for this logical write. Reuse it only for an identical retry.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

Idempotency-KeystringRequired: Use one unique key per request. Reuse it with the same input for seven days to recover a committed receipt. Minimum length: 16. Maximum length: 128. Pattern: ^[A-Za-z0-9_-]+$.

Request body

application/json · Required

action = "saveProfile"

action = "setDefault"

action = "deleteProfile"

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"
: "${DASHIO_IDEMPOTENCY_KEY:?Set DASHIO_IDEMPOTENCY_KEY 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/brand-kit' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $DASHIO_IDEMPOTENCY_KEY" \
  --data '{
  "action": "saveProfile",
  "profile": {
    "name": "Primary Brand",
    "description": "Core brand for customer communications.",
    "guidelines": "Use the primary blue on light backgrounds.",
    "isDefault": true,
    "colors": {
      "primary": "#2563eb",
      "secondary": "#171717",
      "accent": "#10b981"
    },
    "typography": {
      "headingFamily": "Inter",
      "bodyFamily": "Inter",
      "headingWeight": 700,
      "bodyWeight": 400,
      "notes": ""
    },
    "additionalColors": []
  }
}'

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

Schema-generated example; not a captured response.

{
  "recordId": "d40beec9-3477-45cb-92e4-152f5b9d0686",
  "replayed": false
}

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

The committed Brand Kit profile receipt.

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.
Idempotency-ReplayedstringOptional: Set to true when this response reuses a committed receipt. Required value: "true".

application/json

recordIdstring (uuid)Required: No field description supplied.
replayedbooleanRequired: 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.