Ver .md

contacts.import_upload_url

Pedir URL para enviar um arquivo de importação. Para arquivos grandes (até 100 MB e 500 000 linhas). Devolve fileId e uma URL assinada (vale 2 horas): envie o CSV cru com PUT em signedUrl (corpo = o arquivo, Content-Type: text/csv). Depois chame contacts.import_create com fileId no lugar de rows. Só quem pediu a URL importa o arquivo. fileName termina em .csv, .tsv ou .txt.

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

Entrada

CampoTipoObrigatórioNota
fileNamestringsim
sizeintegersim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 104857600
    }
  },
  "required": [
    "fileName",
    "size"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/contacts.import_upload_url \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName":"clientes.csv","size":1048576}'

CLI:

node cli/atomiks.mjs contacts.import_upload_url --json '{"fileName":"clientes.csv","size":1048576}'

MCP: ferramenta contacts_import_upload_url com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fileId": {
      "type": "string"
    },
    "signedUrl": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "path": {
      "type": "string"
    }
  },
  "required": [
    "fileId",
    "signedUrl",
    "token",
    "path"
  ],
  "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).