AtomiksAPI
Ver .md

custom_objects.records_import_upload_url

Pedir URL para enviar a planilha de importação. Primeiro passo da importação (equivale a records/import/upload do original). Devolve uploadId e uma URL assinada (vale 2 horas): envie o CSV cru com PUT em signedUrl (corpo = o arquivo, Content-Type: text/csv; até 100 MB). Depois chame custom_objects.records_import com uploadId. Só quem pediu a URL importa o arquivo. fileName termina em .csv, .tsv ou .txt (o original também não lê .xlsx).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.records_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: custom_objects_records_import_upload_url
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.records_import_upload_url)

Entrada

CampoTipoObrigatórioNota
objectIdstring (uuid)sim
fileNamestringsim
sizeintegersim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "objectId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 104857600
    }
  },
  "required": [
    "objectId",
    "fileName",
    "size"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.records_import_upload_url \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"objectId":"00000000-0000-0000-0000-000000000000","fileName":"imoveis.csv","size":1048576}'

CLI:

node cli/atomiks.mjs custom_objects.records_import_upload_url --json '{"objectId":"00000000-0000-0000-0000-000000000000","fileName":"imoveis.csv","size":1048576}'

MCP: ferramenta custom_objects_records_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": {
    "uploadId": {
      "type": "string"
    },
    "signedUrl": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "path": {
      "type": "string"
    }
  },
  "required": [
    "uploadId",
    "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).

custom_objects.records_import_upload_url · Atomiks API