Outreach2day
  1. Campaigns
Outreach2day
  • Getting Started with Outreach2day API
  • Use Case 1: Mailboxes & Domains
  • Use Case 2: Unified Inbox (Unibox)
  • Use Case 3: Campaigns
  • Mailboxes
    • List Mailboxes
    • Delete Mailboxes
    • Create Mailboxes
    • Update Mailboxes Handler
  • Domains
    • List Domains
    • Update Domains Redirects
    • Get Dns Records
    • Update Dns Records
    • Check Domains
    • Purchase Domains
    • Start Cloudflare domain transfer flow
    • Start Cloudflare domain transfer flow
    • Get Cloudflare transfer status for workspace domains
    • Get Cloudflare transfer status for workspace domains
  • Unibox
    • Public Get Threads Debug
    • Public Get Threads Capabilities
    • Public Get Threads
    • Public Get Thread Messages
    • Public Reply To Thread
    • Public Send New Message
    • Public Get Outbound Operation Status
  • Campaigns
    • Public List Campaigns
      GET
    • Public Create Campaign
      POST
    • List campaign lifecycle statuses and transitions
      GET
    • Get campaign API capability contract for workspace
      GET
    • Public Get Campaign
      GET
    • Public Update Campaign
      PATCH
    • Public Delete Campaign
      DELETE
    • Public Update Campaign Schedule
      PUT
    • Public Update Campaign Stop Rules
      PUT
    • Public List Campaign Steps
      GET
    • Public Create Campaign Step
      POST
    • Public Update Campaign Step
      PATCH
    • Public Delete Campaign Step
      DELETE
    • Public List Campaign Mailboxes
      GET
    • Public Add Campaign Mailbox
      POST
    • Public Update Campaign Mailbox
      PATCH
    • Public Remove Campaign Mailbox
      DELETE
    • Public Import Campaign Contacts Csv
      POST
    • Public Create Import Job
      POST
    • Public Submit Import Job With Mapping V3
      POST
    • Public Get Import Status
      GET
    • Public Get Import Status Alias
      GET
    • Public Get Import Mapping Preview
      GET
    • Public Confirm Import Mapping
      POST
    • Public Replay Import Dead Letter
      POST
    • Public Cancel Import
      POST
    • Public Get Import Runbook Summary
      GET
    • Public List Campaign Contacts
      GET
    • Public List Campaign Contacts Changes
      GET
    • Public Launch Campaign
      POST
    • Public Get Campaign Launch Job
      GET
    • Public Get Campaign Stats
      GET
    • Public List Campaign Sends
      GET
    • Run campaign preflight checks
      GET
    • Run campaign mailbox auth preflight checks
      GET
    • Execute campaign lifecycle action
      POST
    • Duplicate campaign with steps and mailboxes
      POST
    • Get shareable campaign URL
      GET
    • Export campaign analytics CSV payload
      GET
    • List campaign subsequences
      GET
    • Create campaign subsequence
      POST
    • Get campaign subsequence
      GET
    • Update campaign subsequence
      PATCH
    • Delete campaign subsequence
      DELETE
    • Sync leads into subsequence
      POST
    • Get subsequence routing policy
      GET
    • Update subsequence routing policy
      PATCH
  • Workspaces
    • List Workspaces
    • Create New Workspace
    • Get Workspace Info Handler
    • Upgrade Workspace Subscription
  • Warmup
    • Public Create Warmup Operation
    • Public Get Warmup Operation
    • Public List Warmup Mailboxes
  • Sequencers
    • Public List Sequencer Providers
    • Public List Sequencers
    • Public Create Sequencer
    • Public Validate Sequencer
    • Public Update Sequencer
    • Public Delete Sequencer
    • Public Get Sequencer Readiness
    • Public Export Mailboxes
    • Public Reconnect Mailboxes
    • Public List Exports
  • Payment
    • Get Payment Method
    • Setup Payment Method
  • Campaign Suppression
    • Upsert campaign suppression entries
    • List suppression entries
    • Delete suppression entry
    • Get suppression status for one email
  • 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
  1. Campaigns

Public Update Campaign Mailbox

PATCH
/campaigns/{campaign_id}/mailboxes/{mailbox_id}
Campaigns endpoint for PATCH /campaigns/{campaign_id}/mailboxes/{mailbox_id}.

Request

Path Params

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Successful Response
Body

🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://public.outreach2day.com/campaigns//mailboxes/?workspaceId' \
--header 'authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "weight": 1,
    "dailyLimit": 1,
    "gapBaseSeconds": 0,
    "gapJitterSeconds": 0,
    "state": "string",
    "property1": "string",
    "property2": "string"
}'
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
Previous
Public Add Campaign Mailbox
Next
Public Remove Campaign Mailbox
Built with