API Getting Started

API Getting Started The {{productName}} REST API lets you build your own integration on top of your account. You can create and look up contacts, manage campaigns, FAQs, tasks and appointments, send messages, register webhooks, read analytics, and connect messaging channels — everything the dashboard does, driven by code. This is the hub page for the API documentation. If you are connecting {{productName}} to a tool that already has a built-in integration, you may not need the API at all. The API is for custom integrations and automation at scale. 📝 Note: These pages are written for developers. If you are not a developer, share this section with your technical team. Base URL Every request goes to the same base web address, and all paths in these docs are relative to it: https://api.relaytiv.com/v1 So the campaigns endpoint is https://api.relaytiv.com/v1/campaigns , the contacts endpoint is https://api.relaytiv.com/v1/contacts , and so on. All requests must use a secure connection (HTTPS). Plain HTTP requests are rejected. Getting an API key API access is a paid feature . If your plan does not include it, every request returns a 403 with this body: { "success": false, "error_code": 403, "error": "This action requires the \"api_access\" feature, which is not enabled for this account." } Once API access is enabled on your plan, generate a key from the dashboard. The full step-by-step is in API Access — in short, go to Settings → Webhooks , and use the API Key section to generat