sender
Conditional — shown in describe() responses only while the account has no senders connected
⚠️ No senders are connected yet — sender operations will return empty lists, and nothing can send. One can be created via sender/post once the user supplies working SMTP/IMAP credentials (e.g. a Gmail app password). Ask your user whether they'd like guided onboarding; if yes, read onboarding.
Senders are email accounts used to send campaign emails. Create one with sender/post — it takes the mailbox's SMTP/IMAP credentials (host, port, username, password; for Gmail, a 16-character app password) — and configure everything else (daily limit, ramp-up, warmup, tracking domain, identity) on the same call or later via sender/patch_by_id. The one connect method with no operation here is the web app's 1-click OAuth connect (Google Workspace / Microsoft 365); the SMTP/IMAP route reaches the same outcome. Creation succeeds even with wrong credentials — failures surface later as sender disconnection, so after creating, verify with sender/get_by_id and sender/errors_by_id before relying on the sender. Guided first-time setup: onboarding. Full field reference: schemas/sender.
Operations
Read
- sender/get — List senders
- sender/get_by_id — Get sender by ID
- sender/errors_by_id — Get send-time errors
Create
- sender/post — Create sender
- sender/post_tags_by_id — Add tag to sender
Update
- sender/patch_by_id — Update sender
Delete
- sender/delete_by_id — Delete sender
- sender/delete_by_id_tags_by_tagId — Remove tag from sender