Ver .md

pipelines.opportunity_extra_set

Editar "indicado por" da oportunidade. Define (ou limpa com null) o campo "Indicado por" do card. Os demais campos (título, valor, prioridade, previsão, probabilidade, origem) saem por crm.opportunity_update.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
referredBystring | nullsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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)$"
    },
    "referredBy": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "referredBy"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/pipelines.opportunity_extra_set \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","referredBy":"Ana"}'

CLI:

node cli/atomiks.mjs pipelines.opportunity_extra_set --json '{"id":"00000000-0000-0000-0000-000000000000","referredBy":"Ana"}'

MCP: ferramenta pipelines_opportunity_extra_set 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"
    },
    "referredBy": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "referredBy"
  ],
  "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).