SalesBlink Public REST API v1.0.0#

When to use this skill#

Use this skill when the user wants to:

• Create, update, or manage email lists, sequences, templates, or senders
• Add, update, move, or remove contacts/leads
• Send or reply to emails via the inbox
• Check campaign analytics (opens, clicks, replies, sent)
• Set up outreach campaigns end-to-end
• Manage workspaces, users, folders, or deliverability tests
• Make any HTTP request to run.salesblink.io/api/public/v1.0.0

Safety & Compliance Guardrails#

Before performing any high-risk action, pause and obtain explicit user confirmation. Document the confirmation in your reasoning.

Sequence launches (ASI02)#

• Always create sequences with paused: true first.

• Before launching (setting paused: false or launchTimingMode: "now"), show the user:

  • Final recipient list(s) and estimated lead count
  • Sender account(s) that will send the emails
  • Template subject lines and content for every step
  • Schedule / timezone / sending hours
  • Pause state and stop conditions (e.g., stopWhenReplyRecieved)

• Only launch after the user explicitly confirms. Do not auto-launch.

• Prefer paused: true and let the user resume manually when ready.

DFY orders and billing (ASI02)#

• Treat all DFY domain/mailbox orders and billing actions as payment-sensitive.
• Before placing any order, confirm with the user:
  • Exact domain name(s) to purchase or connect
  • Mailbox count, provider (Google / Outlook / Azure), and price
  • Cancellation limits and recurring cost implications
• Do not place DFY orders or manage payment methods unless explicitly requested.

API key management (ASI03)#

• Only use /keys endpoints for explicit credential-administration requests.
• Before refreshing or deleting a key, confirm:
  • The exact key name / ID
  • Impact on existing integrations
  • That the user has updated any dependent systems if rotating

Sender credentials (ASI03)#

• Use dedicated outreach mailboxes wherever possible. Avoid connecting primary personal or company mailboxes.
• Never store or log SMTP/IMAP passwords in chat history.
• Remind the user to review OAuth/provider permissions before authorizing Gmail or Outlook connections.

Lead data privacy (ASI07)#

• Upload only leads and files the user has explicitly approved for SalesBlink.
• Do not include unrelated private data in CSVs, templates, or attachments.
• Review CSV contents before bulk import to ensure no sensitive PII is unintentionally included.

Persistent campaigns (ASI10)#

• Document the stop condition for every active or evergreen sequence.
• Periodically remind the user to audit active, evergreen, and recurring items in their SalesBlink account.
• When creating sequences, default to non-evergreen ( evergreen: false) unless the user explicitly requests continuous running.

Gotchas#

• ID types matter: Templates and contact archive use MongoDB ObjectId (24-char hex). All other entities use UUID v4.
• messageId is the RFC822 Message-ID (e.g. <id@domain.com>) or Microsoft Graph ID. Crucial: Always URL-encode this ID when using it as a path parameter (e.g. in /inbox/:messageId/thread). This is distinct from the internal UUID id.
• senders is a comma-separated string, not an array. It can mix sender IDs and folder IDs — the server auto-detects each.
• Sequence steps fully replace on PATCH. Send the complete desired array.
• Verification flags are IRREVERSIBLE: verification, archive_invalid, archive_risky on lists can only be turned ON, never OFF.
• Sequences default to paused: If paused is omitted on create, it defaults to true.
• launchTimingMode: "now" starts in 5 minutes, not instantly.
• Template attachments use FormData field attachment (not attachments). Max 3 per template.
• Remove template attachments via remove_attachments array of file names.
• Adding SMTP sender requires from_email, not email.
• If an endpoint for a specific task is not mentioned then tell the user that the endpoint is not available
• If user does not have a list, ask them for a CSV file, or list of lead emails with data.
• If email sender is not connected, help them connect one using APIs.
• When asked to create a sequence or campaign for cold email outreach, first ask them about their ICP, Offer, and other details.

Base URL#

https://run.salesblink.io/api/public/v1.0.0

Authentication#

Ask the user for their SALESBLINK_API_KEY: https://run.salesblink.io/account/integration/api

Pass it in every request as the Authorization header (no "Bearer" prefix):

Header: Authorization: key-****

Rate Limits#

MethodLimitWindowGET30per minutePOST / PATCH15per minutePUT (archive)10per minute

On 429 Too Many Requests: wait at least 60 seconds before retrying. For batch operations, insert a 4-second delay between requests.

Public Signup#

POST /signup

Create a new SalesBlink account. This is a public endpoint and does not require an API key. Successful signup returns an API key, allowing you to proceed with authenticated requests immediately.

Request Body:

json

{
  "email": "user@example.com",
  "password": "SecurePassword123",
  "name": "John Doe"
}

Response Body:

json

{
  "success": true,
  "data": {
    "account_id": "...",
    "user_id": "...",
    "api_key": "key-..."
  }
}

Constraints:

• password: Min 8 characters, max 48 characters, at least one uppercase and one lowercase letter.
• Rate Limit: 2 signups per day.

Pagination#

Most list endpoints use limit (max 100) and skip. Activity endpoints ( /sent, /opens, /clicks, /replies) use per_page (max 100) and page (1-indexed).

Always paginate. Never assume a single request returns all data.

Endpoint Categories#

Read the relevant reference file before performing operations in that domain:

• Lists & contacts/leads → references/lists.md and references/contacts.md
  • Use these endpoints when the user wants to fetch or manage lists that contain leads/contacts. A list is a container for contacts/leads. Each contact/lead contains fields like Email, First_Name, Last_Name, Phone, Company, Title, and custom fields. Contacts are added to lists in batches (up to 500 per request), can be moved between lists, updated, or removed.
• Email templates → references/templates.md
  • Use these endpoints when the user wants to create or manage reusable email templates. A template has a name, subject_line, and HTML content that supports merge variables like {{first_name}} and {{company}}. Templates can have up to 3 attachments and are referenced by sequences when building outreach steps.
• Sequences & email campaigns → references/sequences.md
  • Use these endpoints when the user wants to create or manage automated email campaigns (sequences). A sequence connects lists (who to email), senders (which accounts send), and templates (what to send) into a timed step-by-step workflow. Steps alternate between email sends and delay periods. Sequences can be launched, paused, resumed, cloned, or archived.
• Senders, OAuth & warmup links → references/senders.md
  • Use these endpoints when the user wants to connect or manage email sending accounts. A sender is an email account (SMTP/IMAP or OAuth-connected Gmail/Outlook) that sends emails on behalf of sequences. Multiple senders can be assigned to a sequence. Senders can also be organized into folders. Warmup links are used in email warmup processes to improve deliverability.
• Inbox & replies → references/inbox.md
  • Use these endpoints when the user wants to view or interact with email conversations. The inbox contains reply threads, sent emails, scheduled emails, and drafts. Each thread has a messageId. The user can reply to a lead's email, mark messages as read/unread, or classify outcomes.
• Activity tracking → references/activity.md
  • Use these endpoints when the user wants to query engagement events. The system tracks four event types: sent (emails sent), opens (emails opened), clicks (links clicked), and replies (responses received). Events can be filtered by sequence, recipient email, and date range.
• Users & workspaces → references/organization.md
  • Use these endpoints when the user wants to manage team membership or workspaces. A workspace is an account boundary. Users have roles (client, user, admin, developer). Only owners and admins can invite users or create workspaces.
• Folders → references/folders.md
  • Use these endpoints when the user wants to organize resources into folders. Folders have a type (list, template, sequence, or email-sender) and group related resources together for easier management.
• Domains & signatures → references/account-config.md
  • Use these endpoints when the user wants to view account-level configuration. Custom tracking domains are used for click tracking in emails. Signatures are appended to outgoing emails.
• DFY domains & mailboxes → references/dfy.md
  • Use these endpoints when the user wants to purchase domains and provision mailboxes through the Done-For-You service. Start with /domains/search to find available domains, then place an order with Google Workspace, Outlook, or Azure mailboxes. Supports buying new domains or connecting existing ones.
• Billing & payment methods → references/billing.md
  • Use these endpoints when the user wants to add or remove a saved payment card. Returns magic login links to the billing page.
• API Key Management → references/api-keys.md
  • Use these endpoints when the user wants to manage API keys. Users can list all keys, create new keys, refresh an existing key (which generates a new one and revokes the old one), or delete a key.
• Reports → references/reports.md
  • Use these endpoints when the user wants to fetch aggregated activity reports over a date range. Reports combine data across campaigns into summary views.
• Inbox placement tests → references/inbox-placement.md
  • Use these endpoints when the user wants to test email deliverability. An inbox placement test sends a test email to seed email addresses across providers (Gmail, Outlook, etc.) and reports whether the email landed in inbox, spam, promotions, or other tabs. Tests can be one-time or recurring.
• End-to-end workflow examples → references/workflows.md
  • Use this reference when the user wants to set up a complete outreach campaign from scratch. It shows the full chain: create list → add contacts → create templates → fetch senders → create sequence → launch.

Error Handling#

Always check the success boolean in the response body. A 200 status can still return { success: false, message: "..." }.

StatusMeaningAction200SuccessCheck success field400Bad requestRe-check payload structure against the reference file401UnauthorizedVerify API key403ForbiddenInsufficient permissions (role too low)404Not foundVerify the ID / endpoint409ConflictResource already exists or connection failed429Rate limitedWait 60s, then retry500Server errorRetry once after 10s