AtomiksAPI
Ver .md

crm.sale_rules_list

Listar regras de venda automática. Regras que registram uma venda quando uma mensagem enviada pela conta casa com o modelo. Variáveis do modelo: {produto} e {valor}.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/crm.sale_rules_list (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: crm_sale_rules_list
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId crm.sale_rules_list)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.sale_rules_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs crm.sale_rules_list --json '{}'

MCP: ferramenta crm_sale_rules_list com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "template": {
            "type": "string"
          },
          "productId": {
            "type": [
              "string",
              "null"
            ]
          },
          "pipelineId": {
            "type": [
              "string",
              "null"
            ]
          },
          "active": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "template",
          "productId",
          "pipelineId",
          "active"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).