Skip to content
upToolsupTools DocsDOCS
Documentation for: Echo
HUuptools.io
Markdown

Echo developer guide

The Echo API lets your own systems manage a workspace’s subscribers, groups, segments, fields, campaigns, automations and webhooks. Webhooks tell your systems when something happens in Echo.

This guide is for developers. The customer side (creating tokens and webhooks in the app) is in the Integrations chapter of the user guide.

Contents

  1. Quickstart: base URL, first request, request and response format, pagination, idempotency
  2. Authentication: API tokens, access levels, allowed IP addresses
  3. Subscribers: list, count, add or update, read, change, unsubscribe, delete, forget, activity
  4. Groups, segments and fields
  5. Import through the API: bulk import into a group and its progress
  6. Campaigns: drafts with Custom HTML content, test email, scheduling, results
  7. Automations: workflows, statistics, runs, activating, pausing, adding subscribers
  8. Webhooks: events, payloads, signature check, retries, target rules
  9. Batch requests: up to 50 requests in one call
  10. Errors and limits: error format, codes, rate limits, size limits

The machine-readable reference

The full OpenAPI 3.1 document is public, no token needed:

Terminal window
curl https://echo.uptools.io/public/v1/openapi.yaml

Every example in this guide was run against a working Echo installation with fictional demo data. IDs, addresses and times in the answers are examples: yours will differ.