[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_473":-7,"_474":475,"_476":477,"_478":-5,"_479":480,"_481":482,"_483":484,"_485":486,"_357":487,"_488":489,"_369":-7,"_490":-7,"_371":-7,"_491":492,"_493":360,"_494":495,"_496":495,"_497":-7,"_498":499,"_500":501,"_502":503,"_504":505,"_376":377,"_506":-7,"_507":33,"_508":45},"routes/_docs/_index",{"_357":358,"_359":360,"_361":362,"_363":364,"_365":366,"_367":368,"_369":-7,"_370":-7,"_371":-7,"_38":39,"_372":-7,"_373":364,"_374":-7,"_375":45,"_376":377,"_378":379},"routes/_docs.$productname/_index",{"_51":52,"_53":54,"_55":-7,"_56":57,"_58":59,"_60":33},"routes/_docs.$productname.$/_index",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":-7,"_22":-7,"_23":24,"_25":26,"_27":-7,"_28":29,"_30":31,"_32":33,"_34":35},"type","html","content","

All Paubox Marketing customers have access to the Paubox Marketing API to automate various tasks.

Base URL

https://api.paubox.net/v1/orca/<USERNAME>

Replace <USERNAME> with your API endpoint username

Authorization

Use authorization header in request: authorization: Token token=<API_KEY>

Replace <API_KEY> with your API key

Create your <API_KEY> on the Paubox Marketing > Settings page (note: each API Key is displayed only once upon creation):

Example call

curl -X POST \\\nhttps://api.paubox.net/v1/orca/<USERNAME>/subscribers\\\n  -H 'authorization: Token token=<API_KEY>' \\\n  -H 'content-type: application/json' \\\n  -d '{\n    \"subscriber\": {\n        \"email\": \"test@example.com\",\n        \"first_name\": \"test\",\n        \"last_name\": \"example\"\n    }\n  }'

Date format

Dates are passed as ISO8601 strings with UTC timezone

Finding id parameters for subscription_list_id, campaign_mailing_id, etc.

Finding parameter values in the web dashboard

","contentUpdatedAt","Tue, 19 Aug 2025 19:58:32 GMT","path","docs/general-information","generatorLanguages","SHUBApiDetails","exploreUrl","https://explore.swaggerhub.com","currentToc",{"_13":14,"_46":47,"_40":48,"_19":20,"_49":50},"shubUrl","apiRenderer","TOGGLE","routingSettings",{"_42":43,"_44":45},"isTemplatePreview",false,"metaInfo",{"_36":37,"_38":39,"_40":41},"canonicalUrl","https://docs.paubox.com/paubox_marketing_api/docs/general-information","pageUrl","http://docs.paubox.com/paubox_marketing_api/docs/general-information","title","General information | Paubox Marketing API | Docs + Quickstarts | Paubox","routing","browser","credentialsEnabled",true,"tableOfContentsId","d1532750-ea97-486f-b6db-6c63221bd866","General information","children",[],"sections",{"_87":88,"_89":90},"currentProduct",{"_62":80,"_64":81,"_66":57,"_68":82,"_70":45,"_71":33,"_72":83,"_74":84,"_76":85,"_78":86},"currentProductRole","productSlug","paubox_marketing_api","products",[61,54],"isTemplate",{"_62":63,"_64":65,"_66":67,"_68":69,"_70":45,"_71":33,"_72":73,"_74":75,"_76":77,"_78":79},"id","cfc33eb3-be1b-4f28-9962-29675d867f4b","name","Paubox Email API","slug","paubox_email_api","description","Clear documentation to quickly send HIPAA compliant email via API. HITRUST certified since 2019.","canAccess","hidden","logoAttachmentId","8df2d227-2582-4146-a87a-d0a741f367d0","logoDarkModeAttachmentId","e2e751f0-f8b0-4d1b-886b-5617ec4a7759","logoImageHref","https://portal.swaggerhub.com/services/api/attachments/8df2d227-2582-4146-a87a-d0a741f367d0","logoImageDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/e2e751f0-f8b0-4d1b-886b-5617ec4a7759","9e53ae06-7014-4bc3-bc13-6bc9628fea47","Paubox Marketing API","The public API for the Paubox Marketing HIPAA compliant email marketing solution.","57cae665-9278-4dc3-a4e5-2752a9df7e38","d972249e-0b8f-45ee-9698-4e855580100a","https://portal.swaggerhub.com/services/api/attachments/57cae665-9278-4dc3-a4e5-2752a9df7e38","https://portal.swaggerhub.com/services/api/attachments/d972249e-0b8f-45ee-9698-4e855580100a","page",{"_351":352,"_353":354,"_355":352,"_356":352},"items",[91],{"_40":92,"_66":92,"_93":94},"docs","tableOfContents",[95,96,97],{"_13":14,"_46":47,"_40":48,"_19":20,"_49":350},{"_13":102,"_46":103,"_40":104,"_105":106,"_19":107,"_108":109,"_110":111,"_112":113,"_114":115,"_116":117},{"_13":14,"_46":98,"_40":99,"_19":100,"_49":101},"85729a7b-a153-4b9b-8a10-053b8b64c62a","Locating Parameter Values","docs/locating_parameter_values",[],"apiUrl","e8f4e5d1-5945-49aa-a7b8-e06e39ad3934","Paubox Marketing API v. 1.0.0","url","https://api.swaggerhub.com/apis/paubox/paubox_marketing/1.0.0/swagger.json","docs/paubox-marketing-api-v-1-0-0","apiSpec","openapi-3.0.3","operations",[240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265],"schemas",[118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178],"asyncApiMessages",[],"asyncApiServers",[],{"_64":239},{"_64":238},{"_64":237},{"_64":236},{"_64":235},{"_64":234},{"_64":233},{"_64":232},{"_64":231},{"_64":230},{"_64":229},{"_64":228},{"_64":227},{"_64":226},{"_64":225},{"_64":224},{"_64":223},{"_64":222},{"_64":221},{"_64":220},{"_64":219},{"_64":218},{"_64":217},{"_64":216},{"_64":215},{"_64":214},{"_64":213},{"_64":212},{"_64":211},{"_64":210},{"_64":209},{"_64":208},{"_64":207},{"_64":206},{"_64":205},{"_64":204},{"_64":203},{"_64":202},{"_64":201},{"_64":200},{"_64":199},{"_64":198},{"_64":197},{"_64":196},{"_64":195},{"_64":194},{"_64":193},{"_64":192},{"_64":191},{"_64":190},{"_64":189},{"_64":188},{"_64":187},{"_64":186},{"_64":185},{"_64":184},{"_64":183},{"_64":182},{"_64":181},{"_64":180},{"_64":179},"TrackingLinksDetailResponse_data","TrackingLinksDetailResponse_attributes","SubscriptionListsResponse_data","SubscriptionListsResponse_attributes","PauseDripCampaignResponse_data","StartDripCampaignResponse_data","UpdateDripCampaignRequest_drip_campaign","DripCampaignResponse_data","DripCampaignResponse_data_attributes","DripCampaignsResponse_data","DripCampaignsResponse_attributes","ScheduleCampaignMailingResponse_data","SendCampaignMailingRequest_campaign_mailing_send","CampaignMailingsResponse_data","CampaignMailingsResponse_attributes","CampaignDeliveriesTableResponse_data","SubscribersByTrackingLinkResponse_data","SubscribersByTrackingLinkResponse_attributes","SubscribersByTrackingLinkResponse_attributes_custom_fields","TrackingLinksResponse_data","CampaignTableResponse_data","CampaignAnalyticsResponse_data","BulkCreateResponse_data","BulkCreateSubscribersRequest_subscribers","UpdateSubscriberRequest_subscriber","CreateSubscriberRequest_subscriber","DetailedSubscriber_attributes","DetailedSubscriber_attributes_statistics","DetailedSubscriber_attributes_subscription_lists","DetailedSubscriber_attributes_custom_fields","Subscriber_attributes","inline_response_400","TrackingLinksDetailResponse","UpdateSubscriptionListRequest","CreateSubscriptionListRequest","SubscriptionListResponse","SubscriptionListsResponse","PauseDripCampaignResponse","StartDripCampaignResponse","UpdateDripCampaignRequest","DripCampaignResponse","DripCampaignsResponse","ScheduleCampaignMailingResponse","ScheduleCampaignMailingRequest","SendCampaignMailingRequest","CampaignMailingsResponse","CampaignDeliveriesTableResponse","SubscribersByTrackingLinkResponse","TrackingLinksResponse","CampaignTableResponse","CampaignAnalyticsResponse","Error","BulkCreateResponse","BulkCreateSubscribersRequest","UpdateSubscriberRequest","CreateSubscriberRequest","DetailedSubscriberResponse","SubscriberResponse","SubscribersResponse","DetailedSubscriber","Subscriber",{"_266":267,"_19":347,"_269":335,"_271":348,"_273":349},{"_266":267,"_19":344,"_269":335,"_271":345,"_273":346},{"_266":267,"_19":341,"_269":335,"_271":342,"_273":343},{"_266":267,"_19":338,"_269":335,"_271":339,"_273":340},{"_266":267,"_19":334,"_269":335,"_271":336,"_273":337},{"_266":267,"_19":331,"_269":325,"_271":332,"_273":333},{"_266":285,"_19":328,"_269":325,"_271":329,"_273":330},{"_266":285,"_19":324,"_269":325,"_271":326,"_273":327},{"_266":267,"_19":321,"_269":310,"_271":322,"_273":323},{"_266":267,"_19":316,"_269":310,"_271":319,"_273":320},{"_266":283,"_19":316,"_269":310,"_271":317,"_273":318},{"_266":285,"_19":313,"_269":310,"_271":314,"_273":315},{"_266":285,"_19":309,"_269":310,"_271":311,"_273":312},{"_266":267,"_19":304,"_269":292,"_271":307,"_273":308},{"_266":285,"_19":304,"_269":292,"_271":305,"_273":306},{"_266":267,"_19":298,"_269":292,"_271":302,"_273":303},{"_266":283,"_19":298,"_269":292,"_271":299,"_273":301},{"_266":275,"_19":298,"_269":292,"_271":299,"_273":300},{"_266":285,"_19":295,"_269":292,"_271":296,"_273":297},{"_266":280,"_19":291,"_269":292,"_271":293,"_273":294},{"_266":267,"_19":286,"_269":277,"_271":289,"_273":290},{"_266":285,"_19":286,"_269":277,"_271":287,"_273":288},{"_266":283,"_19":276,"_269":277,"_271":278,"_273":284},{"_266":280,"_19":276,"_269":277,"_271":281,"_273":282},{"_266":275,"_19":276,"_269":277,"_271":278,"_273":279},{"_266":267,"_19":268,"_269":270,"_271":272,"_273":274},"method","GET","/tracking_links","tag","tracking_links","summary","Fetch tracking links","operationId","getTrackingLinks","PATCH","/subscription_lists/{subscription_list_id}","subscription_lists","Update subscription list","updateSubscriptionListPatch","DELETE","Delete subscription list","deleteSubscriptionList","PUT","updateSubscriptionListPut","POST","/subscription_lists","Create subscription list","createSubscriptionList","Fetch subscription lists","getSubscriptionLists","/subscribers_bulk_delete","subscribers","Bulk delete subscribers","bulkDeleteSubscribers","/subscribers_bulk_create","Bulk create subscribers","bulkCreateSubscribers","/subscribers/{subscriber_id}","Update subscriber","updateSubscriberPatch","updateSubscriberPut","Fetch subscriber","getSubscriber","/subscribers","Create subscriber","createSubscriber","Fetch subscribers","getSubscribers","/drip_campaigns/{id}/pause","drip_campaigns","Pause a drip campaign","pauseDripCampaign","/drip_campaigns/{id}/start","Start a drip campaign","startDripCampaign","/drip_campaigns/{id}","Update drip campaign","updateDripCampaign","Fetch drip campaign","getDripCampaign","/drip_campaigns","Fetch drip campaigns","getDripCampaigns","/campaign_mailing_schedules","campaign_mailings","Schedule a new campaign mailing","scheduleCampaignMailing","/campaign_mailing_sends","Send campaign mailings","sendCampaignMailing","/campaign_mailings","Fetch campaign mailings","getCampaignMailings","/analytics/campaign_mailing_deliveries_table","analytics","Fetch campaign deliveries table","getCampaignDeliveriesTable","/analytics/subscribers_by_tracking_link","Fetch subscribers by tracking link","getSubscribersByTrackingLink","/analytics/tracking_links_by_unique_link","Fetch tracking links by unique link","getTrackingLinksByUniqueLink","/analytics/campaign_mailing_sends_table","Fetch campaign table","getCampaignTable","/analytics/campaign_mailing_send_totals","Fetch campaign analytics","getCampaignAnalytics",[],"number",1,"size",10,"totalElements","totalPages","user",{"_471":472},"portalName","Docs + Quickstarts | Paubox","portalCustomDomain","docs.paubox.com","portalSubdomain","paubox","gtmKey","GTM-5NKZSMP","landingPageData",{"_64":360,"_403":404,"_405":406,"_72":407,"_74":408,"_409":410,"_411":412,"_413":414,"_415":416,"_417":418,"_419":33,"_68":420,"_378":379,"_76":421,"_78":422,"_423":-7,"_424":-7,"_425":426,"_427":428,"_429":430,"_431":432},"organizationRole","highestRole","platformAdmin","previewMode","swaggerhubOrgName","templates","customDomainActive","swaggerhubOrgId","adfd628c-ccd9-4b69-b690-e198a3612882","footer",{"_380":45,"_381":382,"_383":384,"_385":-7,"_386":-7},"visible","links",[387,388,389,390,391],"text","© Paubox 2026","imageHref","imageDarkModeHref",{"_392":401,"_105":402},{"_392":399,"_105":400},{"_392":397,"_105":398},{"_392":395,"_105":396},{"_392":393,"_105":394},"label","Contact","https://www.paubox.com/contact-us","Customers","https://www.paubox.com/customer-stories","Security","https://www.paubox.com/security","Blog","https://www.paubox.com/blog","Pricing","https://www.paubox.com/pricing/paubox-email-api","faviconAttachmentId","414a6a9f-f202-40e4-8802-ccbdca8b173d","faviconDarkModeAttachmentId","2df91e18-4a1f-4775-809e-8d72083cbf28","fe656a9d-5328-4d86-8223-c1ebb9f33f94","82ff77bd-24a5-4600-b054-2014f4811605","illustrationImageAttachmentId","a69979ed-ab76-4074-b05b-84341fced146","illustrationImageDarkModeAttachmentId","c3fc8029-e4b2-4b5a-b1e4-88b1f7776eb9","fontName","Lato","accentColor","#0247dc","accentColorDarkMode","#ffffff","offline",[433,434,435,436],"https://portal.swaggerhub.com/services/api/attachments/fe656a9d-5328-4d86-8223-c1ebb9f33f94","https://portal.swaggerhub.com/services/api/attachments/82ff77bd-24a5-4600-b054-2014f4811605","heroImageHref","heroImageDarkModeHref","illustrationImageHref","https://portal.swaggerhub.com/services/api/attachments/a69979ed-ab76-4074-b05b-84341fced146","illustrationImageDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/c3fc8029-e4b2-4b5a-b1e4-88b1f7776eb9","faviconHref","https://portal.swaggerhub.com/services/api/attachments/414a6a9f-f202-40e4-8802-ccbdca8b173d","faviconDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/2df91e18-4a1f-4775-809e-8d72083cbf28",["SingleFetchClassInstance",460],["SingleFetchClassInstance",456],["SingleFetchClassInstance",452],["SingleFetchClassInstance",437],{"_438":439,"_64":440,"_441":442,"_49":443},"$$mdtype","Tag","p","attributes",{},[444],["SingleFetchClassInstance",445],{"_438":439,"_64":446,"_441":447,"_49":448},"Link",{"_450":451},[449],"Quickstart Guide","href","paubox_email_api/docs/quickstart/",{"_438":439,"_64":440,"_441":453,"_49":454},{},[455],"Get up and running in minutes with Paubox Email API.",{"_438":439,"_64":440,"_441":457,"_49":458},{},[459],"Learn how to send HIPAA compliant email on the Paubox platform.",{"_438":439,"_64":461,"_441":462,"_49":463},"Heading",{"_470":352},[464],["SingleFetchClassInstance",465],{"_438":439,"_64":466,"_441":467,"_49":468},"strong",{},[469],"Paubox Developer Docs","level","profile","https://profile.id.smartbear.com/","statusData","appMode","portal","locale","en","notification","bugsnagApiKey","15dbd45f0b623fe8ba7056c9f5a3165d","editorKey","eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE4MjcyNzM1OTksImp0aSI6IjRkMGE0Zjc3LTk0YTktNGRjNC1iZjdiLTNmYTM3MjcwYjUxYiIsImRpc3RyaWJ1dGlvbkNoYW5uZWwiOlsic2giLCJkcnVwYWwiXSwid2hpdGVMYWJlbCI6dHJ1ZSwiZmVhdHVyZXMiOlsiRFJVUCIsIkRPIiwiRlAiLCJTQyIsIlRPQyIsIlRQTCIsIlBPRSIsIkNDIiwiTUYiLCJTRUUiLCJCT1giLCJDTVQiLCJUQyIsIlJIIl0sInZjIjoiZDllZWYyZTgifQ.8pGGsuIWKK_0gvsKin0Qr4v6saiOpRVl1cp_xfPNPu7zh2Q4R2mGHr3WCjvk0VR1y7m3djHEIc2tNMx5poHrww","env","prod","flags",{"_553":45,"_554":45,"_555":33,"_556":45,"_557":33,"_558":33,"_559":45,"_560":45,"_561":45,"_562":45,"_563":33,"_564":352,"_565":45,"_566":33,"_567":568,"_569":45,"_570":45,"_571":45,"_572":33,"_573":33,"_574":33,"_575":45,"_576":33,"_577":33,"_578":45,"_579":45,"_580":33,"_581":45,"_582":33,"_583":33,"_584":33,"_585":45,"_586":33,"_587":33},{"_471":472,"_551":552},"layout","default","portalProductRole","amplitudeData",{"_547":548,"_549":550},"portalMetaName","mode","system","sessionMode","preferredColorScheme","license",{"_13":546},"apiHubPlan",{"_524":45,"_525":526,"_527":528,"_529":530},"appConfig",{"_509":510,"_511":24,"_512":513,"_514":515,"_516":517,"_518":519,"_520":521,"_522":523},"apiHubUrl","https://app.swaggerhub.com/hub/adfd628c-ccd9-4b69-b690-e198a3612882","cutoverDate","isExternalLoginEnabled","isCustomDomain","platformUiUrl","https://platform.smartbear.com","shubExploreUrl","pactflowAppUrl","https://app.pactflow.io","reflectAppUrl","https://auth.reflect.run/oauth2/authorize?response_type=code&client_id=7taop7pbojn2nlj536vshmmgn&redirect_uri=https%3A%2F%2Fapp.reflect.run%2Foauth%2Fsso&identity_provider=SmartBear","shubAppUrl","https://app.swaggerhub.com","portalRootUrl","https://{portalname}.portal.swaggerhub.com","portalAppUrl","","catalogAppUrl","https://catalog.swaggerhub.com","platformManaged","gates",{"_538":45,"_539":45,"_540":45,"_541":45,"_542":45,"_543":45,"_544":45,"_545":45},"productMeters",{"_531":532,"_533":535,"_536":537},"templateMeters",{"_531":532,"_533":534},"limit",2147483647,"currentUsage",0,6,"warningThreshold",1610612735,"sbFooterRemoved","subdomainEditingEnabled","customDomainEnabled","consumerSideOnline","requestAccessEnabled","attachmentManagerEnabled","privateAndHiddenProductsEnabled","collaborationEnabled","paid","amplitudeApiKey","79eb0fee7c605a4e0d80273236e85fa9","portalData",{},"proxyToken","516705b4-9708-4013-9088-136d2113dc79","api-hub-agent-force","api-hub-ai-based-standardization-rules-generation","api-hub-ai-diff-based-generation","api-hub-graph-ql-specification-support","api-hub-insight-hub-integration","api-hub-new-features-for-3-1-editor","api-hub-next-editor-for-2-0-and-3-0","api-hub-rollout-reflect-app-switcher","api-hub-rollout-reflect-landing-page","api-hub-spectral-js-evaluator","api-hub-standardization-page-redesign","api-hub-welcome-bar-message-index","catalog-access-control","catalog-recent-apis","catalog-trial-redirects","http://catalog.swaggerhub.com?orgId={orgId}","halo-ai-api-hub-api-design-diff","halo-ai-api-hub-mcp-server-generation","halo-ai-api-hub-open-api-design-generation","halo-ai-api-hub-open-api-generation-by-implementation","portal-auth-restructure","portal-custom-css","portal-permanent-markdown-editing-support","swagger-ai-agents-support","swagger-github-app-integration","swagger-new-panel-mechanism","swagger-products-rebrand","swagger-studio-async-3-domains","swagger-studio-elements-support","swagger-studio-idp-portal-consumer","swagger-studio-import-stoplight","swagger-studio-oas-3-1-domains","swagger-studio-oas-3-2-support","swagger-studio-replace-circular-references-in-specs","swagger-studio-signed-commits"]