API documentation

import { ECODrIxAPI } from "@ecodrix/erix-api";

const ecod = new ECODrIxAPI({
  apiKey: process.env.ECOD_API_KEY,         // server-side only
  clientCode: process.env.ECOD_CLIENT_CODE, // e.g. ERIX_CLNT_XXXXXX
});

// 1. Save an enquiry as a lead
const { data: lead } = await ecod.product.erix.leads.create({
  firstName: "Asha",
  phone: "+91XXXXXXXXXX",
  source: "website",
});

// 2. Fire your own event
await ecod.product.erix.events.trigger({
  trigger: "enquiry_received",
  phone: "+91XXXXXXXXXX",
  variables: { product: "Annual plan" },
});

curl -X POST https://api.ecodrix.com/v1/api/product/erix/crm/leads \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Asha","phone":"+91XXXXXXXXXX","source":"website"}'

import { APIError, RateLimitError } from "@ecodrix/erix-api";

try {
  await ecod.product.erix.leads.create({ firstName: "Asha", phone: "+91XXXXXXXXXX" });
} catch (err) {
  if (err instanceof RateLimitError) {
    // back off, then retry
  } else if (err instanceof APIError) {
    console.error(err.status, err.code, err.message);
  }
}

curl -i https://api.ecodrix.com/v1/api/product/erix/crm/leads \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"
# -i prints the status line and RateLimit headers

const { data: lead } = await ecod.product.erix.leads.upsert({
  leadData: { firstName: "Asha", phone: "+91XXXXXXXXXX" },
  refs: { orderId: "ORD-1001" },
});

const { data: page } = await ecod.product.erix.leads.list({
  search: "Asha",
  limit: 20,
});

await ecod.product.erix.leads.move(lead.id, "STAGE_ID");
await ecod.product.erix.leads.tags(lead.id, { add: ["vip"] });

curl -X POST https://api.ecodrix.com/v1/api/product/erix/crm/leads/upsert \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"leadData":{"firstName":"Asha","phone":"+91XXXXXXXXXX"},"refs":{"orderId":"ORD-1001"}}'

curl "https://api.ecodrix.com/v1/api/product/erix/crm/leads?search=Asha&limit=20" \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

const { data: pipelines } = await ecod.product.erix.pipelines.list();

await ecod.product.erix.pipelines.create({
  name: "Sales",
  stages: ["New", "Quoted", "Won"],
});

curl https://api.ecodrix.com/v1/api/product/erix/crm/pipelines \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

await ecod.product.erix.activities.notes.create(leadId, {
  content: "Asked for a quote",
});

const { data: timeline } = await ecod.product.erix.activities.timeline(leadId);

curl -X POST https://api.ecodrix.com/v1/api/product/erix/crm/leads/LEAD_ID/notes \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"content":"Asked for a quote"}'

const { data: config } = await ecod.product.erix.scoring.getConfig();
await ecod.product.erix.scoring.recalculate(leadId);

curl -X POST https://api.ecodrix.com/v1/api/product/erix/crm/scoring/LEAD_ID/recalculate \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

const { data: overview } = await ecod.product.erix.analytics.overview();
const { data: funnel } = await ecod.product.erix.analytics.funnel(pipelineId);

curl https://api.ecodrix.com/v1/api/product/erix/crm/analytics/overview \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

await ecod.product.erix.events.trigger({
  trigger: "order_placed",
  phone: "+91XXXXXXXXXX",
  variables: { orderId: "ORD-1001", amount: "4999" },
  idempotencyKey: "ORD-1001",
});

curl -X POST https://api.ecodrix.com/v1/api/product/erix/events/trigger \
  -H "Authorization: Bearer erix_flow_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"trigger":"order_placed","phone":"+91XXXXXXXXXX","variables":{"orderId":"ORD-1001"}}'

await ecod.product.erix.events.createCustomEvent({
  name: "order_placed",
  displayName: "Order placed",
});

const { data } = await ecod.product.erix.events.listCustomEvents();

curl -X POST https://api.ecodrix.com/v1/api/product/flow/config/triggers \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"name":"order_placed","displayName":"Order placed"}'

const { data: flows } = await ecod.request("GET", "/product/flow/workflows");
const { data: run } = await ecod.request("GET", `/product/flow/runs/${runId}`);

curl https://api.ecodrix.com/v1/api/product/flow/runs \
  -H "Authorization: Bearer erix_flow_YOUR_SECRET"

const { data: threads } = await ecod.product.erix.chat.conversations.list({
  status: "open",
  limit: 20,
});

await ecod.product.erix.chat.messages.send({
  conversationId: threads[0].id,
  text: "Thanks! Your quote is on the way.",
});

await ecod.product.erix.chat.conversations.linkLead(conversationId, leadId);

curl -X POST https://api.ecodrix.com/v1/api/platform/inbox/conversations/CONVERSATION_ID/messages \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Thanks! Your quote is on the way."}'

// WhatsApp template
await ecod.product.erix.chat.messages.sendTemplate({
  to: "+91XXXXXXXXXX",
  templateName: "order_update",
  language: "en",
  variables: ["Asha", "ORD-1001"],
});

// Email: no typed method yet, so use the raw request
await ecod.request("POST", "/infra/connect/send/email", {
  to: "customer@example.com",
  subject: "Your invoice",
  html: "<p>Thanks for your order.</p>",
});

curl -X POST https://api.ecodrix.com/v1/api/infra/connect/send/whatsapp \
  -H "Authorization: Bearer erix_connect_whatsapp_YOUR_SECRET" \
  -H "Idempotency-Key: ORD-1001-update" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+91XXXXXXXXXX","templateName":"order_update","language":"en","variables":["Asha","ORD-1001"]}'

const { data: templates } = await ecod.infra.connect.whatsapp.templates.list();
await ecod.infra.connect.whatsapp.templates.sync();

curl https://api.ecodrix.com/v1/api/infra/connect/whatsapp/templates \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

const meeting = await ecod.infra.connect.meet.create({
  leadId,
  participantName: "Asha",
  participantPhone: "+91XXXXXXXXXX",
  startTime: "2026-11-02T10:00:00+05:30",
  endTime: "2026-11-02T10:30:00+05:30",
  meetingMode: "online",
});

await ecod.infra.connect.meet.reschedule(meetingId, { startTime, endTime });
await ecod.infra.connect.meet.delete(meetingId); // sets status "cancelled"

curl -X PATCH https://api.ecodrix.com/v1/api/infra/connect/meet/MEETING_ID \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -H "Content-Type: application/json" \
  -d '{"status":"cancelled"}'

// Presign, upload straight to storage, and confirm in one call
const { data: file } = await ecod.infra.storage.media.upload(buffer, {
  folder: "invoices",
  filename: "INV-1001.pdf",
  contentType: "application/pdf",
});

curl -X POST https://api.ecodrix.com/v1/api/infra/storage/media \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE" \
  -F "folder=documents" -F "file=@./brochure.pdf"

const { data: invoice } = await ecod.product.erix.invoices.create({
  clientName: "Asha",
  leadId,
  currency: "INR",
  taxRate: 18,
  items: [{ description: "Annual plan", quantity: 1, rate: 4999 }],
});

await ecod.request("POST", `/product/erix/commerce/invoices/${invoice.id}/payment-link`);
await ecod.product.erix.invoices.sendViaWhatsApp(invoice.id);

curl -X POST https://api.ecodrix.com/v1/api/product/erix/commerce/invoices/INVOICE_ID/payment-link \
  -H "x-api-key: $ECOD_API_KEY" -H "x-client-code: $ECOD_CLIENT_CODE"

const status = await ecod.platform.health.system();

curl https://api.ecodrix.com/v1/api/health