Ver .md

playbooks.attachment_upload

Enviar anexo de apoio do playbook. Guarda um arquivo (até 10 MB) para ser anexo de um playbook e devolve o item pronto para a lista attachments de playbooks.create/playbooks.update ({id, name, url, mimeType, size}). content é o arquivo em base64; mimeType aceita PDF, imagens (PNG, JPEG, WebP, GIF), TXT, CSV e documentos do Office. O url é /api/v1/playbook-files/<id> (GET com sessão ou chave crm:read, responde 302 para um link assinado de 60 s). Enviar não anexa: o arquivo só passa a fazer parte do playbook quando o item entra em attachments e o playbook é salvo.

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

Entrada

CampoTipoObrigatórioNota
namestringsim
mimeTypestringsim
contentstringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "mimeType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "content": {
      "type": "string",
      "minLength": 1,
      "maxLength": 14000000
    }
  },
  "required": [
    "name",
    "mimeType",
    "content"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/playbooks.attachment_upload \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"precos.pdf","mimeType":"application/pdf","content":"JVBERi0xLjQK"}'

CLI:

node cli/atomiks.mjs playbooks.attachment_upload --json '{"name":"precos.pdf","mimeType":"application/pdf","content":"JVBERi0xLjQK"}'

MCP: ferramenta playbooks_attachment_upload 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"
    },
    "url": {
      "type": "string"
    },
    "mimeType": {
      "type": "string"
    },
    "size": {
      "type": "number"
    }
  },
  "required": [
    "id",
    "name",
    "url",
    "mimeType",
    "size"
  ],
  "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).