Skip to content
Tinbox
Sign in

Reference

SDK

The TypeScript SDK is a thin, typed client over your deployment's REST API — send transactional mail, manage suppressions, capture form submissions, and grow audiences. Install it with npm install tinbox and import from tinbox/sdk.

72 methods

Quick start

Construct a Tinbox client with an API key (tbx_…) and your deployment's base URL, then call any namespaced method.

ts
import { Tinbox } from "tinbox/sdk";

// baseUrl is your deployment host — the SDK derives /api/send and /api/trpc.
const tinbox = new Tinbox({
  apiKey: "tbx_…",
  baseUrl: "https://acme.com",
});

// Resend-style sending:
await tinbox.emails.send({
  from: "Ada <ada@acme.dev>",
  to: "user@example.com",
  subject: "Welcome",
  html: "<p>Hello!</p>",
});

// …or the full typed API (every procedure, fully typed):
const threads = await tinbox.api.threads.list.query({ inboxId: "ibx_…" });
const hits = await tinbox.api.emails.search.query({ q: "invoice" });

Methods

tools

tools.activateJourney

Activate journey. Convenience alias for activate_journey, forwarding to tinbox.api.journeys.activate.mutate.

tools.addContacts

Bulk-add contacts. Convenience alias for add_contacts, forwarding to tinbox.api.contacts.batchUpsert.mutate.

tools.addForwardingRule

Add a forwarding rule. Convenience alias for add_forwarding_rule, forwarding to tinbox.api.forwarding.add.mutate.

tools.addSubscriberChannel

Add a subscriber notification channel. Convenience alias for add_subscriber_channel, forwarding to tinbox.api.notifications.addChannel.mutate.

tools.approvePersonalized

Approve personalized bodies. Convenience alias for approve_personalized, forwarding to tinbox.api.campaigns.approvePersonalized.mutate.

tools.approveProspects

Approve prospects to send. Convenience alias for approve_prospects, forwarding to tinbox.api.outreach.approveProspects.mutate.

tools.askOperator

Ask the operator. Convenience alias for ask_operator, forwarding to tinbox.api.review.createCheckIn.mutate.

tools.burnDisposableMailbox

Burn a disposable mailbox. Convenience alias for burn_disposable_mailbox, forwarding to tinbox.api.disposable.burn.mutate.

tools.cancelThreadDirective

Cancel a thread directive. Convenience alias for cancel_thread_directive, forwarding to tinbox.api.directives.cancel.mutate.

tools.checkSendingDomain

Check a sending domain. Convenience alias for check_sending_domain, forwarding to tinbox.api.domains.checkDns.query.

tools.createAudience

Create audience. Convenience alias for create_audience, forwarding to tinbox.api.audiences.create.mutate.

tools.createDraft

Create a draft. Convenience alias for create_draft, forwarding to tinbox.api.drafts.create.mutate.

tools.createInbox

Create an inbox. Convenience alias for create_inbox, forwarding to tinbox.api.inboxes.create.mutate.

tools.createOutreachCampaign

Create outreach campaign. Convenience alias for create_outreach_campaign, forwarding to tinbox.api.outreach.create.mutate.

tools.createSegment

Create a segment. Convenience alias for create_segment, forwarding to tinbox.api.segments.create.mutate.

tools.createTemplate

Create template. Convenience alias for create_template, forwarding to tinbox.api.templates.create.mutate.

tools.denyProspects

Deny prospects. Convenience alias for deny_prospects, forwarding to tinbox.api.outreach.denyProspects.mutate.

tools.draftAllPending

Draft all pending bodies. Convenience alias for draft_all_pending, forwarding to tinbox.api.outreach.draftAllPending.mutate.

tools.draftOutreachBody

Draft one outreach body. Convenience alias for draft_outreach_body, forwarding to tinbox.api.outreach.draftProspect.mutate.

tools.dropDisposableMailbox

Stop receiving at a disposable mailbox. Convenience alias for drop_disposable_mailbox, forwarding to tinbox.api.disposable.drop.mutate.

tools.enrollInJourney

Enroll contact in journey. Convenience alias for enroll_in_journey, forwarding to tinbox.api.journeys.trigger.mutate.

tools.getAudience

Get audience details. Convenience alias for get_audience, forwarding to tinbox.api.audiences.get.query.

tools.getCampaign

Get campaign details. Convenience alias for get_campaign, forwarding to tinbox.api.campaigns.get.query.

tools.getCampaignReport

Get campaign report. Convenience alias for get_campaign_report, forwarding to tinbox.api.campaigns.report.query.

tools.getDeliveryStatus

Check delivery status. Convenience alias for get_delivery_status, forwarding to tinbox.api.sending.logDetail.query.

tools.getJourney

Get journey details. Convenience alias for get_journey, forwarding to tinbox.api.journeys.get.query.

tools.getOutreachCampaign

Get outreach campaign. Convenience alias for get_outreach_campaign, forwarding to tinbox.api.outreach.get.query.

tools.getSendReadiness

Check send readiness. Convenience alias for get_send_readiness, forwarding to tinbox.api.readiness.status.query.

tools.getTemplate

Get template. Convenience alias for get_template, forwarding to tinbox.api.templates.get.query.

tools.importContacts

Import contacts. Convenience alias for import_contacts, forwarding to tinbox.api.members.importCsv.mutate.

tools.launchOutreach

Launch outreach campaign. Convenience alias for launch_outreach, forwarding to tinbox.api.outreach.approve.mutate.

tools.listCampaigns

List campaigns. Convenience alias for list_campaigns, forwarding to tinbox.api.campaigns.list.query.

tools.listJourneys

List journeys. Convenience alias for list_journeys, forwarding to tinbox.api.journeys.list.query.

tools.listPersonalizedReview

List personalized review queue. Convenience alias for list_personalized_review, forwarding to tinbox.api.campaigns.personalizedReview.query.

tools.listReviewQueue

List outreach review queue. Convenience alias for list_review_queue, forwarding to tinbox.api.outreach.reviewQueue.query.

tools.listSegments

List segments. Convenience alias for list_segments, forwarding to tinbox.api.segments.list.query.

tools.listSubscriberChannels

List subscriber notification channels. Convenience alias for list_subscriber_channels, forwarding to tinbox.api.notifications.channels.query.

tools.listSubscribers

List subscribers. Convenience alias for list_subscribers, forwarding to tinbox.api.members.list.query.

tools.listTemplates

List templates. Convenience alias for list_templates, forwarding to tinbox.api.templates.list.query.

tools.listThreadDirectives

List a thread's follow-up directives. Convenience alias for list_thread_directives, forwarding to tinbox.api.directives.list.query.

tools.listThreads

List threads. Convenience alias for list_threads, forwarding to tinbox.api.threads.list.query.

tools.outreachCampaignStatus

Outreach campaign status. Convenience alias for outreach_campaign_status, forwarding to tinbox.api.outreach.report.query.

tools.outreachRepliesDigest

Outreach replies digest. Convenience alias for outreach_replies_digest, forwarding to tinbox.api.outreach.report.query.

tools.pauseJourney

Pause journey. Convenience alias for pause_journey, forwarding to tinbox.api.journeys.pause.mutate.

tools.pauseOutreach

Pause outreach campaign. Convenience alias for pause_outreach, forwarding to tinbox.api.outreach.pause.mutate.

tools.personalizeCampaign

Personalize campaign. Convenience alias for personalize_campaign, forwarding to tinbox.api.campaigns.personalize.mutate.

tools.previewSegment

Preview segment reach. Convenience alias for preview_segment, forwarding to tinbox.api.segments.preview.query.

tools.previewTemplate

Preview template. Convenience alias for preview_template, forwarding to tinbox.api.templates.preview.query.

tools.removeSubscriber

Unsubscribe. Convenience alias for remove_subscriber, forwarding to tinbox.api.members.archive.mutate.

tools.scheduleCampaign

Schedule campaign. Convenience alias for schedule_campaign, forwarding to tinbox.api.campaigns.schedule.mutate.

tools.searchEmails

Search email. Convenience alias for search_emails, forwarding to tinbox.api.emails.search.query.

tools.searchImages

Search images. Convenience alias for search_images, forwarding to tinbox.api.images.search.query.

tools.sendCampaign

Send campaign now. Convenience alias for send_campaign, forwarding to tinbox.api.campaigns.send.mutate.

tools.sendEmail

Send an email. Convenience alias for send_email, forwarding to tinbox.api.messages.send.mutate.

tools.sendTestCampaign

Send test campaign. Convenience alias for send_test_campaign, forwarding to tinbox.api.campaigns.sendTest.mutate.

tools.setInboxNotificationLevel

Set inbox notification level. Convenience alias for set_inbox_notification_level, forwarding to tinbox.api.push.setPref.mutate.

tools.setNotificationSchedule

Set notification schedule. Convenience alias for set_notification_schedule, forwarding to tinbox.api.digests.setPreset.mutate.

tools.sourceProspects

Source prospects. Convenience alias for source_prospects, forwarding to tinbox.api.outreach.sourceProspects.mutate.

tools.updateAudience

Update audience. Convenience alias for update_audience, forwarding to tinbox.api.audiences.update.mutate.

tools.updateDraft

Edit a draft. Convenience alias for update_draft, forwarding to tinbox.api.drafts.update.mutate.

tools.updateTemplate

Update template. Convenience alias for update_template, forwarding to tinbox.api.templates.update.mutate.

tools.upsertContact

Add or update a contact. Convenience alias for upsert_contact, forwarding to tinbox.api.contacts.upsert.mutate.