Ver .md

proposals.template_create

Criar modelo de proposta. Cria um modelo em rascunho (slide deck ou documento). O conteúdo é montado no editor visual, que ainda não existe no Atomiks: até lá o modelo guarda só nome, descrição e tipo. Sem a migration do banco responde migration_pendente.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/proposals.template_create (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: proposals_template_create
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId proposals.template_create)

Entrada

CampoTipoObrigatórioNota
namestringsim
kind"slide_deck" | "document"nãopadrão "slide_deck"
descriptionstring | nullnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "kind": {
      "default": "slide_deck",
      "type": "string",
      "enum": [
        "slide_deck",
        "document"
      ]
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/proposals.template_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Proposta comercial","kind":"document"}'

CLI:

node cli/atomiks.mjs proposals.template_create --json '{"name":"Proposta comercial","kind":"document"}'

MCP: ferramenta proposals_template_create com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "kind": {
      "type": "string",
      "enum": [
        "slide_deck",
        "document",
        "pdf"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "active",
        "archived"
      ]
    },
    "coverHtml": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "kind",
    "status",
    "coverHtml",
    "createdAt",
    "updatedAt"
  ],
  "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).