crm.sale_rule_create

Criar regra de venda automática. Admin. O template precisa de {valor} ou de productId. Ex.: "Pagamento aprovado de {valor}".

• Endpoint: POST https://app.atomiks.com.br/api/v1/crm.sale_rule_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_sale_rule_create
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId crm.sale_rule_create)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "template": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "productId": {
      "anyOf": [
        {
          "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)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "pipelineId": {
      "anyOf": [
        {
          "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)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "template"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.sale_rule_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Pagamento aprovado","template":"Pagamento aprovado de {valor}"}'

CLI:

node cli/atomiks.mjs crm.sale_rule_create --json '{"name":"Pagamento aprovado","template":"Pagamento aprovado de {valor}"}'

MCP: ferramenta crm_sale_rule_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"
    },
    "template": {
      "type": "string"
    },
    "productId": {
      "type": [
        "string",
        "null"
      ]
    },
    "pipelineId": {
      "type": [
        "string",
        "null"
      ]
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "name",
    "template",
    "productId",
    "pipelineId",
    "active"
  ],
  "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).