Developer Compliance1.0.0-beta.1

Schedule or queue supplier questionnaire delivery

Confirms a plan, queues a send for an active Manual plan, or reopens a versioned case. Email targets the saved supplier contact and uses the existing asynchronous dispatcher. Recurrence and reminders require Business or Enterprise. The API returns a receipt for scheduling or queue acceptance.

POST/api/v1/compliance/suppliers/{supplierId}/delivery/send

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 compliance:supplier-delivery:send. Scopes are independent.

This operation uses 10 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The supplier delivery group shares 10 requests per token and 30 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.

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

supplierIdstringRequired: Stable supplier record ID in the token’s Space, up to 200 characters. Encode it as one path segment.
Example"supplier-001"

Query parameters

None documented.

Header parameters

Idempotency-KeystringRequired: Use 16 to 128 ASCII letters, digits, underscores or hyphens. Reuse the same key for the same supplier and action when retrying.
Example"61d9263e-143b-4407-90fd-e3b54df67c96"

Request body

application/json · Required

Send one action as an application/json body of up to 32 KiB.

Confirm or schedule a plan

Send from an active Manual plan

Reopen a case and queue a new link

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/compliance/suppliers/{supplierId}/delivery/send' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $DASHIO_IDEMPOTENCY_KEY" \
  --data '{
  "action": "confirm",
  "sourceCaseId": "questionnaire-001",
  "timeZone": "Europe/Berlin",
  "mode": "Manual",
  "firstSendDate": "",
  "intervalMonths": null,
  "responseWindowDays": 14,
  "reminderDays": []
}'

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

Schema-generated example; not a captured response.

{
  "action": "confirm",
  "planId": "d40beec9-3477-45cb-92e4-152f5b9d0686",
  "state": "active",
  "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

A committed action or an exact seven-day receipt replay.

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: Present as true for an exact retry. Required value: "true".

application/json

Plan acknowledgement

Case acknowledgement

400

Invalid identifier, query, action or body.

application/json

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

401

Developer token is missing or invalid.