crm.stage_upsert

Criar ou mover etapa aberta. Sem id cria etapa aberta; com id renomeia e/ou reposiciona. position é o índice (0 = primeira) entre as etapas abertas; Ganho e Perdido ficam sempre no fim e não podem ser editadas.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "pipelineId": {
      "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)$"
    },
    "id": {
      "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)$"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "position": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    }
  },
  "required": [
    "pipelineId",
    "name",
    "position"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.stage_upsert \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pipelineId":"00000000-0000-0000-0000-000000000000","name":"Proposta","position":1}'

CLI:

node cli/atomiks.mjs crm.stage_upsert --json '{"pipelineId":"00000000-0000-0000-0000-000000000000","name":"Proposta","position":1}'

MCP: ferramenta crm_stage_upsert 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"
    },
    "kind": {
      "type": "string",
      "enum": [
        "open",
        "won",
        "lost"
      ]
    },
    "position": {
      "type": "number"
    },
    "capiEvent": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "kind",
    "position",
    "capiEvent"
  ],
  "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).