Ver .md

onboarding.dismiss

Pular ou retomar meus primeiros passos. dismissed: true esconde o checklist "Primeiros passos" para o próprio usuário na conta atual; false mostra de novo.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/onboarding.dismiss (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: nenhum (qualquer chave serve)
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: onboarding_dismiss
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId onboarding.dismiss)

Entrada

CampoTipoObrigatórioNota
dismissedbooleansim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dismissed": {
      "type": "boolean"
    }
  },
  "required": [
    "dismissed"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/onboarding.dismiss \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dismissed":true}'

CLI:

node cli/atomiks.mjs onboarding.dismiss --json '{"dismissed":true}'

MCP: ferramenta onboarding_dismiss com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dismissed": {
      "type": "boolean"
    }
  },
  "required": [
    "dismissed"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).