Business process overview
How campaign setup, connect notes, and message generation flow between your systems and Upscale.
End-to-end flow
The diagram below shows the main steps for running a campaign with the API. Steps in navy are performed by Upscale; steps in dark mint are performed by you (the external API customer).
UpscaleExternal API customer (you)
Campaign setup
Add leads, create campaign
GET pre-set sequences
Provide sequences
Design campaign (pre-set or custom), launch / pause
Connect notes
POST request connect notes for leads
Generate connect notes
Webhook notification
GET messages & update leads → send connects
Messages
POST request messages (per accepted connect)
Generate messages
Webhook notification
GET messages & update leads → send messages
Summary
- Campaign setup: You add leads, get pre-set sequences (GET), design the campaign (pre-set or custom), and launch or pause it.
- Connect notes: You POST to request connect notes for all leads; Upscale generates them and sends a webhook when done. You then GET messages, update leads, and send connects.
- Optional: You can GET messages and update leads without having requested connect notes first, if your flow allows it.
- Messages: For each accepted connect you POST to request messages; Upscale generates them and sends a webhook. You GET messages, update leads, and send messages.
For details on each API and webhooks, use the sidebar to open the relevant docs (e.g. Get Sequences, Request Message Generation, Retrieve Messages, Webhooks).