{ "info": { "_postman_id": "8b5b2bc247e4fa6a077e8efbca50067f", "name": "Hifisys Hifisys CRM & Lead Automation Platform", "description": "Complete Zoho CRM-grade customer relationship platform and API suite. Unifies multi-channel lead capture, contact & account management, configurable visual sales pipelines, automated workflow triggers, multi-tenant REST APIs, and revenue analytics.\n\nOfficial REST API Postman Collection (v2.1.0) for Hifisys Enterprise Platform.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authentication & Health", "item": [ { "name": "Platform API Health Check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/health", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ] }, "description": "Verifies that the Hifisys REST API v1 gateway is operational (public health check)." }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Leads Management", "item": [ { "name": "Create / Upsert Lead", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads" ] }, "description": "Creates or merges a tenant-scoped CRM lead.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Aarav Mehta\",\n \"email\": \"aarav@enterprise-example.com\",\n \"phone\": \"+919876543210\",\n \"company_name\": \"Mehta FinTech\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Tenant Leads", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads" ] }, "description": "Returns paginated tenant leads.\n\nRequired Scope: `leads:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Export Leads CSV", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/export", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", "export" ] }, "description": "Streams tenant leads as CSV export.\n\nRequired Scope: `leads:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Bulk Import Leads JSON", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/import", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", "import" ] }, "description": "Bulk ingests leads array via CrmLeadService::ingestLead.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"leads\": [\n {\n \"name\": \"Lead One\",\n \"email\": \"lead1@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Bulk Lead Action (Assign / Status / Delete)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", "bulk" ] }, "description": "Executes bulk operations on tenant leads.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"action\": \"assign\",\n \"lead_codes\": [\n \"LEAD-2026-0001\"\n ],\n \"user_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Lead Details", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Retrieves a lead by lead_code.\n\nRequired Scope: `leads:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Lead", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Updates lead fields, status, or priority.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Lead", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Soft-deletes/archives a tenant lead.\n\nRequired Scope: `leads:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Assign Lead Owner", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode/assign", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode", "assign" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Assigns owner user ID to a lead.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"owner_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Qualify Lead", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode/qualify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode", "qualify" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Marks lead as qualified and logs qualification activity.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Convert Lead to Account/Contact/Deal", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/leads/:leadCode/convert", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "leads", ":leadCode", "convert" ], "variable": [ { "key": "leadCode", "value": "{{lead_code}}", "description": "Path parameter: leadCode" } ] }, "description": "Converts a qualified lead into CRM Account, Contact, and Deal.\n\nRequired Scope: `leads:write`", "body": { "mode": "raw", "raw": "{\n \"create_account\": true,\n \"create_deal\": true,\n \"deal_title\": \"Enterprise Suite Deal\",\n \"deal_amount\": 15000\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Public Lead Capture", "item": [ { "name": "Public WordPress/Form Lead Intake", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/leads", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "leads" ] }, "description": "Rate-limited public intake endpoint for external website & WordPress lead connectors.\n\nRequired Scope: `public`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Priya Sharma\",\n \"email\": \"priya@acme.in\",\n \"message\": \"Requesting CRM API demo\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Public Lead Intake (Rate-Limited)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/public/leads", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "leads" ] }, "description": "Write-only public landing page intake endpoint.\n\nRequired Scope: `public`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Priya Sharma\",\n \"email\": \"priya@acme.in\",\n \"message\": \"Requesting product walkthrough\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Contacts", "item": [ { "name": "List Contacts", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/contacts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "contacts" ] }, "description": "Lists paginated tenant CRM contacts.\n\nRequired Scope: `crm:contacts:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Contact", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/contacts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "contacts" ] }, "description": "Creates a tenant CRM contact.\n\nRequired Scope: `crm:contacts:write`", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ananya\",\n \"last_name\": \"Rao\",\n \"email\": \"ananya@acme.test\",\n \"account_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Contact", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/contacts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "contacts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves a tenant contact.\n\nRequired Scope: `crm:contacts:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Contact", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/contacts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "contacts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates contact attributes.\n\nRequired Scope: `crm:contacts:write`", "body": { "mode": "raw", "raw": "{\n \"job_title\": \"VP Engineering\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/contacts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "contacts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant contact.\n\nRequired Scope: `crm:contacts:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Accounts", "item": [ { "name": "List Accounts", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "accounts" ] }, "description": "Lists tenant CRM accounts.\n\nRequired Scope: `crm:accounts:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Account", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "accounts" ] }, "description": "Creates a company account.\n\nRequired Scope: `crm:accounts:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Technologies\",\n \"industry\": \"SaaS\",\n \"website\": \"https://acme.example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Account", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/accounts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "accounts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves a tenant account.\n\nRequired Scope: `crm:accounts:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Account", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/accounts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "accounts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates a tenant account.\n\nRequired Scope: `crm:accounts:write`", "body": { "mode": "raw", "raw": "{\n \"industry\": \"FinTech\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Account", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/accounts/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "accounts", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant account.\n\nRequired Scope: `crm:accounts:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Deals & Pipelines", "item": [ { "name": "List Deals", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals" ] }, "description": "Lists tenant sales deals.\n\nRequired Scope: `crm:deals:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Deal", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals" ] }, "description": "Creates a pipeline deal.\n\nRequired Scope: `crm:deals:write`", "body": { "mode": "raw", "raw": "{\n \"title\": \"Enterprise Platform Rollout\",\n \"amount\": 25000,\n \"pipeline_id\": 1,\n \"stage_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Deal", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves deal details.\n\nRequired Scope: `crm:deals:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Deal", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates deal amount or notes.\n\nRequired Scope: `crm:deals:write`", "body": { "mode": "raw", "raw": "{\n \"amount\": 30000\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Deal Stage", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals/:id/stage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals", ":id", "stage" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Moves a deal to target stage_id.\n\nRequired Scope: `crm:deals:write`", "body": { "mode": "raw", "raw": "{\n \"stage_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Deal", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/deals/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "deals", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant deal.\n\nRequired Scope: `crm:deals:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Pipelines & Stages", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/pipelines", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "pipelines" ] }, "description": "Lists configured CRM sales pipelines and stages.\n\nRequired Scope: `crm:deals:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Activities & Tasks", "item": [ { "name": "List Activities", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/activities", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "activities" ] }, "description": "Lists CRM calls, meetings, and tasks.\n\nRequired Scope: `crm:activities:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Activity", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/activities", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "activities" ] }, "description": "Logs or schedules an activity.\n\nRequired Scope: `crm:activities:write`", "body": { "mode": "raw", "raw": "{\n \"type\": \"call\",\n \"subject\": \"Discovery Call\",\n \"due_at\": \"2026-11-15 10:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Complete Activity", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/activities/:id/complete", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "activities", ":id", "complete" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Marks an activity completed.\n\nRequired Scope: `crm:activities:write`", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Open CRM Tasks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/tasks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "tasks" ] }, "description": "Lists open CRM task activities.\n\nRequired Scope: `crm:activities:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Notes & Timelines", "item": [ { "name": "Create Note", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/notes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "notes" ] }, "description": "Adds an internal note linked to a tenant lead or entity.\n\nRequired Scope: `crm:notes:write`", "body": { "mode": "raw", "raw": "{\n \"lead_id\": 1,\n \"note\": \"Customer requested custom SLA terms.\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Note", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/notes/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "notes", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant CRM note.\n\nRequired Scope: `crm:notes:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Entity Timeline", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/timeline/:module/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "timeline", ":module", ":id" ], "variable": [ { "key": "module", "value": "lead", "description": "Path parameter: module" }, { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves tenant-scoped activity timeline for lead, contact, account, or deal.\n\nRequired Scope: `crm:notes:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Settings, Search & Reports", "item": [ { "name": "List Tenant Owners & Teams", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/users-and-teams", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "users-and-teams" ] }, "description": "Lists authenticated tenant owner profile and teams.\n\nRequired Scope: `crm:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Custom Fields", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/custom-fields", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "custom-fields" ] }, "description": "Lists tenant custom field definitions.\n\nRequired Scope: `crm:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Custom Field", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/custom-fields", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "custom-fields" ] }, "description": "Creates a custom field on lead, contact, account, or deal.\n\nRequired Scope: `crm:admin`", "body": { "mode": "raw", "raw": "{\n \"module\": \"lead\",\n \"field_name\": \"erp_vendor\",\n \"field_label\": \"Current ERP Vendor\",\n \"field_type\": \"text\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Global Tenant CRM Search", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/search", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "search" ] }, "description": "Searches across tenant leads, contacts, accounts, and deals (?q=...).\n\nRequired Scope: `crm:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "CRM Pipeline Reports", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/reports", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "reports" ] }, "description": "Returns pipeline conversion and revenue analytics.\n\nRequired Scope: `crm:reports:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "CRM Executive Summary", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/summary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "summary" ] }, "description": "Returns headline KPI summary for the tenant.\n\nRequired Scope: `crm:reports:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Webhooks", "item": [ { "name": "List Outbound Webhooks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "webhooks" ] }, "description": "Lists tenant webhook subscriptions.\n\nRequired Scope: `webhooks:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Register Outbound Webhook", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "webhooks" ] }, "description": "Registers a signed outbound webhook receiver.\n\nRequired Scope: `webhooks:write`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Deal Won Hook\",\n \"target_url\": \"https://client.example.com/webhooks/crm\",\n \"events\": [\n \"deal.won\",\n \"lead.created\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Webhook", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Removes a tenant webhook subscription.\n\nRequired Scope: `webhooks:write`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Files", "item": [ { "name": "Upload CRM Attachment", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "files" ] }, "description": "Uploads a file attached to a tenant lead, contact, account, or deal (multipart/form-data).\n\nRequired Scope: `crm:files:write`", "body": { "mode": "formdata", "formdata": [ { "key": "subject_type", "value": "lead", "type": "text" }, { "key": "subject_id", "value": "1", "type": "text" }, { "key": "file", "type": "file", "src": "" } ] } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Download CRM Attachment", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/files/:id/download", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "files", ":id", "download" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Downloads a tenant-owned CRM attachment.\n\nRequired Scope: `crm:files:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Automations", "item": [ { "name": "List Automation Rules", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/automations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "automations" ] }, "description": "Lists tenant workflow automation rules.\n\nRequired Scope: `crm:admin`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Create Automation Rule", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/automations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "automations" ] }, "description": "Creates an event-driven CRM workflow rule.\n\nRequired Scope: `crm:admin`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Auto Assign Inbound\",\n \"trigger_event\": \"lead_created\",\n \"actions\": [\n {\n \"type\": \"assign_owner\",\n \"owner_id\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Get Automation Rule", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/automations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "automations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Retrieves a tenant automation rule.\n\nRequired Scope: `crm:admin`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Automation Rule", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/automations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "automations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates a tenant automation rule.\n\nRequired Scope: `crm:admin`", "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Auto Assign\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Delete Automation Rule", "request": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/automations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "automations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Deletes a tenant automation rule.\n\nRequired Scope: `crm:admin`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] }, { "name": "Enquiries & Quotes", "item": [ { "name": "List Contact Enquiries", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/enquiries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "enquiries" ] }, "description": "Lists contact enquiries scoped to tenant.\n\nRequired Scope: `crm:enquiries:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Contact Enquiry", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/enquiries/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "enquiries", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates enquiry status.\n\nRequired Scope: `crm:enquiries:write`", "body": { "mode": "raw", "raw": "{\n \"status\": \"reviewed\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "List Quote Requests", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/quotes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "quotes" ] }, "description": "Lists quote requests scoped to tenant.\n\nRequired Scope: `crm:quotes:read`" }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] }, { "name": "Update Quote Request", "request": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{api_key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/v1/crm/quotes/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "crm", "quotes", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "Updates quote request status.\n\nRequired Scope: `crm:quotes:write`", "body": { "mode": "raw", "raw": "{\n \"status\": \"approved\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200 or 201\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});", "pm.test(\"Response is valid JSON with success flag\", function () {", " var json = pm.response.json();", " pm.expect(json).to.be.an(\"object\");", " pm.expect(json).to.have.property(\"success\");", " pm.expect(json.success).to.be.true;", "});", "pm.test(\"Rate limit and Quota headers present\", function () {", " if (pm.response.headers.has(\"X-Quota-Monthly\")) {", " pm.expect(pm.response.headers.get(\"X-Quota-Monthly\")).to.not.be.empty;", " }", "});" ], "type": "text/javascript" } } ] } ] } ], "variable": [ { "key": "base_url", "value": "https://hifisys.com", "type": "string" }, { "key": "api_key", "value": "YOUR_API_KEY", "type": "string" }, { "key": "product_slug", "value": "crm-lead-automation-platform", "type": "string" }, { "key": "api_version", "value": "v1", "type": "string" } ] }