- Getting Started with Outreach2day API
- Use Case 1: Mailboxes & Domains
- Use Case 2: Unified Inbox (Unibox)
- Use Case 3: Campaigns
- Mailboxes
- Domains
- Unibox
- Campaigns
- Public List CampaignsGET
- Public Create CampaignPOST
- List campaign lifecycle statuses and transitionsGET
- Get campaign API capability contract for workspaceGET
- Public Get CampaignGET
- Public Update CampaignPATCH
- Public Delete CampaignDELETE
- Public Update Campaign SchedulePUT
- Public Update Campaign Stop RulesPUT
- Public List Campaign StepsGET
- Public Create Campaign StepPOST
- Public Update Campaign StepPATCH
- Public Delete Campaign StepDELETE
- Public List Campaign MailboxesGET
- Public Add Campaign MailboxPOST
- Public Update Campaign MailboxPATCH
- Public Remove Campaign MailboxDELETE
- Public Import Campaign Contacts CsvPOST
- Public Create Import JobPOST
- Public Submit Import Job With Mapping V3POST
- Public Get Import StatusGET
- Public Get Import Status AliasGET
- Public Get Import Mapping PreviewGET
- Public Confirm Import MappingPOST
- Public Replay Import Dead LetterPOST
- Public Cancel ImportPOST
- Public Get Import Runbook SummaryGET
- Public List Campaign ContactsGET
- Public List Campaign Contacts ChangesGET
- Public Launch CampaignPOST
- Public Get Campaign Launch JobGET
- Public Get Campaign StatsGET
- Public List Campaign SendsGET
- Run campaign preflight checksGET
- Run campaign mailbox auth preflight checksGET
- Execute campaign lifecycle actionPOST
- Duplicate campaign with steps and mailboxesPOST
- Get shareable campaign URLGET
- Export campaign analytics CSV payloadGET
- List campaign subsequencesGET
- Create campaign subsequencePOST
- Get campaign subsequenceGET
- Update campaign subsequencePATCH
- Delete campaign subsequenceDELETE
- Sync leads into subsequencePOST
- Get subsequence routing policyGET
- Update subsequence routing policyPATCH
- Public List Campaigns
- Workspaces
- Warmup
- Sequencers
- Payment
- Campaign Suppression
- Campaign Webhooks
- List supported campaign webhook event types
- Create campaign webhook subscription
- List campaign webhook subscriptions
- Get campaign webhook subscription by id
- Update campaign webhook subscription
- Delete campaign webhook subscription
- Pause campaign webhook subscription
- Resume campaign webhook subscription
- Rotate campaign webhook subscription secret
- Enqueue test campaign webhook event
- List deliveries for campaign webhook subscription
- List emitted campaign webhook events
- Get emitted campaign webhook event by id
- Get campaign webhook delivery summary
- Requeue failed campaign webhook deliveries
- Requeue one campaign webhook delivery
- Classify campaign reply and emit webhook events
- List campaign contact outcomes
- Override campaign contact reply intent via EVA
- Dispatch queued campaign webhook deliveries
- Schemas
- Body_public_create_import_job_imports_post
- Body_public_export_mailboxes_sequencers__connection_id__export_post
- Body_public_import_campaign_contacts_csv_campaigns__campaign_id__contacts_import_post
- Body_public_rotate_campaign_webhook_subscription_secret_campaigns_webhooks_subscriptions__subscription_id__rotate_secret_post
- Body_public_submit_import_job_with_mapping_v3_imports_v3_submit_post
- CampaignAdmissionOut
- CampaignContactOut
- CampaignContactOutcomeOut
- CampaignContactOutcomesPageOut
- CampaignContactsChangesPageOut
- CampaignContactsImportOut
- CampaignCreateIn
- CampaignDecisionOut
- CampaignDeleteOut
- CampaignDuplicateCopiedOut
- CampaignDuplicateOut
- CampaignExportOut
- CampaignImportConfirmOut
- CampaignImportEnvelopeOut
- CampaignImportJobOut
- CampaignImportMappingEnvelopeOut
- CampaignImportMappingOut
- CampaignImportStatusOut
- CampaignLaunchJobOut
- CampaignLaunchOut
- CampaignLifecycleOut
- CampaignMailboxAttachIn
- CampaignMailboxOut
- CampaignMailboxPolicyUpdateIn
- CampaignOut
- CampaignPreflightCheckOut
- CampaignPreflightOut
- CampaignPreflightSummaryOut
- CampaignReplyClassificationOut
- CampaignScheduleIn
- CampaignScheduleWindowIn
- CampaignSendContactOut
- CampaignSendOut
- CampaignSendStepOut
- CampaignSendsPageOut
- CampaignShareOut
- CampaignStatsCampaignOut
- CampaignStatsOut
- CampaignStatsSendsOut
- CampaignStatusEnumsOut
- CampaignStepCreateIn
- CampaignStepOut
- CampaignStepUpdateIn
- CampaignStepVariantIn
- CampaignStopRulesIn
- CampaignSubsequenceDeleteOut
- CampaignSubsequenceEnvelopeOut
- CampaignSubsequenceListOut
- CampaignSubsequenceOut
- CampaignSubsequenceRoutingOut
- CampaignSubsequenceRoutingPatchOut
- CampaignSubsequenceSyncOut
- CampaignSuppressionDeleteOut
- CampaignSuppressionOut
- CampaignSuppressionStatusEnvelopeOut
- CampaignSuppressionStatusOut
- CampaignSuppressionUpsertIn
- CampaignSuppressionUpsertOut
- CampaignSuppressionsPageOut
- CampaignUpdateIn
- CampaignWebhookActionOut
- CampaignWebhookDeliveriesPageOut
- CampaignWebhookDeliveryEnvelopeOut
- CampaignWebhookDeliveryOut
- CampaignWebhookDispatchOut
- CampaignWebhookEventEnvelopeOut
- CampaignWebhookEventOut
- CampaignWebhookEventTypeOut
- CampaignWebhookEventTypesOut
- CampaignWebhookEventsPageOut
- CampaignWebhookRetriggerOut
- CampaignWebhookSubscriptionEnvelopeOut
- CampaignWebhookSubscriptionOut
- CampaignWebhookSubscriptionsOut
- CampaignWebhookSummaryOut
- CheckDomainsIn
- CheckDomainsOut
- CreateMailboxRequest
- CreateWorkspaceRequest
- DNSRecord
- DomainAvailability
- DomainAvailabilityStatus
- DomainInfo
- DomainPurchaseContactInfo
- DomainPurchaseRequest
- DomainPurchaseResponse
- HTTPValidationError
- MailboxInfo
- PublicCampaignDuplicateIn
- PublicCampaignImportMappingConfirmIn
- PublicCampaignLifecycleIn
- PublicCampaignOutcomeOverrideIn
- PublicCampaignReplyClassificationIn
- PublicCampaignSubsequenceCreateIn
- PublicCampaignSubsequenceRoutingPatchIn
- PublicCampaignSubsequenceSyncIn
- PublicCampaignSubsequenceUpdateIn
- PublicCampaignWebhookRetriggerIn
- PublicCreateCampaignWebhookSubscriptionIn
- PublicCreateSequencerIn
- PublicDomainRedirectsUpdateIn
- PublicReplyToThreadIn
- PublicSendNewMessageIn
- PublicUpdateCampaignWebhookSubscriptionIn
- PublicUpdateSequencerIn
- PublicValidateSequencerIn
- SequencerConnectionEnvelopeOut
- SequencerConnectionOut
- SequencerConnectionsOut
- SequencerDeleteOut
- SequencerExportDetailOut
- SequencerExportOut
- SequencerExportsOut
- SequencerMailboxExportOut
- SequencerProviderCapabilitiesOut
- SequencerProviderOut
- SequencerProvidersOut
- SequencerReadinessOut
- SequencerReconnectErrorOut
- SequencerReconnectOut
- SequencerValidateOut
- TransferCheckoutRequest
- TransferCheckoutResponse
- TransferDomainStatus
- TransferStatusResponse
- UniboxDebugOut
- UniboxMessageOut
- UniboxReplyOut
- UniboxSchema
- UniboxSendOut
- UniboxThreadMessagesOut
- UniboxThreadOut
- UniboxThreadsOut
- UpdateDNSRecordRequest
- UpdateMailboxesIn
- ValidationError
- WarmupAction
- WarmupItemStatus
- WarmupMailboxStateOut
- WarmupOperationCreateIn
- WarmupOperationItemOut
- WarmupOperationOut
- WarmupOperationStatus
- WarmupRejection
- WorkspaceInfo
Public Add Campaign Mailbox
POST
/campaigns/{campaign_id}/mailboxes
Request
Path Params
Query Params
Header Params
Body Params application/jsonRequired
Examples
Responses
🟢200
application/json
Body
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://public.outreach2day.com/campaigns//mailboxes?workspaceId' \
--header 'authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"dailyLimit": 25,
"gapBaseSeconds": 300,
"gapJitterSeconds": 120,
"mailboxAddress": "sender@example.com",
"state": "ACTIVE",
"weight": 2
}'Response Response Example
200 - Example 1
{
"id": "string",
"campaignId": "string",
"mailboxId": "string",
"weight": 0,
"state": "ACTIVE",
"stateRaw": "string",
"dailyLimit": 0,
"gapBaseSeconds": 0,
"gapJitterSeconds": 0,
"createdAt": "2019-08-24T14:15:22.123Z",
"property1": "string",
"property2": "string"
}Modified at 2026-03-10 01:59:11