Ver .md

crm.pipeline_create

Criar pipeline. Cria a pipeline com as etapas abertas na ordem dada; o servidor acrescenta "Ganho" e "Perdido" no fim. A primeira pipeline da conta vira a padrão.

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

Entrada

CampoTipoObrigatórioNota
namestringsim
groupNamestring | nullnão
stagesstring[]sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "groupName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 80
        },
        {
          "type": "null"
        }
      ]
    },
    "stages": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60
      }
    }
  },
  "required": [
    "name",
    "stages"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.pipeline_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Vendas","stages":["Novo","Em negociação"]}'

CLI:

node cli/atomiks.mjs crm.pipeline_create --json '{"name":"Vendas","stages":["Novo","Em negociação"]}'

MCP: ferramenta crm_pipeline_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"
    },
    "groupName": {
      "type": [
        "string",
        "null"
      ]
    },
    "isDefault": {
      "type": "boolean"
    },
    "stages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "open",
              "won",
              "lost"
            ]
          },
          "position": {
            "type": "number"
          },
          "capiEvent": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "kind",
          "position",
          "capiEvent"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "name",
    "groupName",
    "isDefault",
    "stages"
  ],
  "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).