MOmonaco
Campaigns

Update a Campaign

Changed on

Updates a campaign's content fields and/or transitions its lifecycle via status. Returns the refreshed campaign.

To attach or detach audiences, use add_audiences_to_campaign / remove_audiences_from_campaign.

patch/v1/campaigns/{campaign_id}

Request

  • Base URL
    https://api.monaco.com
  • URL
    https://api.monaco.com/v1/campaigns/{campaign_id}
  • Auth
    none declared

Path parameters

campaign_idstring uuid required

Request body

namestring nullable

New name for the campaign; must be unique within the organization

end_datestring date nullable

New end date; must not be in the past

audience_idsstring[] nullable

Deprecated — use add_audiences_to_campaign / remove_audiences_from_campaign instead. The complete set of audiences for this campaign; REPLACES the current set, and any audience you omit is detached (tearing down in-flight sequences for its contacts).

prioritizedboolean nullable

Whether this campaign moves to the front of the organization's send queue, ahead of every non-prioritized campaign. Applies to sends already waiting in the queue as well as future ones. Reserve it for time-sensitive sends, such as an upcoming conference. Prioritizing many campaigns at once dilutes the effect.

status'active' | 'paused' | 'completed' | 'archived'

Lifecycle statuses settable via the public API's update-campaign endpoint.

Subset of campaigns.models._campaign_enums.CampaignStatus — excludes draft (internal-only authoring state).

Example request

{
  "name": "Q3 Enterprise Outbound (revised)",
  "end_date": "2026-12-31",
  "audience_ids": [
    "550e8400-e29b-41d4-a716-446655440010"
  ],
  "distribution": {
    "mode": "percentage",
    "sender_ids": [
      "550e8400-e29b-41d4-a716-446655440001"
    ],
    "percentages": [
      {
        "sender_id": "550e8400-e29b-41d4-a716-446655440001",
        "percentage": 50
      }
    ]
  },
  "rules_of_engagement": {
    "do_not_contact": {
      "enabled": true
    },
    "allow_sequence_stop_on_meeting_booked": {
      "enabled": true
    },
    "contact_cooldown": {
      "enabled": true,
      "days": 90
    },
    "account_cooldown": {
      "enabled": true,
      "days": 90
    },
    "max_contacts_in_sequence": {
      "enabled": true,
      "max_contacts": 3
    },
    "allow_non_account_owner_campaigns": {
      "enabled": true
    },
    "allow_stop_and_dismiss_on_account_status": {
      "enabled": true,
      "statuses": [
        "OPPORTUNITY",
        "CUSTOMER"
      ]
    },
    "exclude_sequences_on_account_status": {
      "enabled": true,
      "statuses": [
        "OPPORTUNITY",
        "CUSTOMER"
      ]
    }
  },
  "autopilot_settings": {
    "sender_rates": [
      {
        "sender_id": "550e8400-e29b-41d4-a716-446655440001",
        "daily_rate_target": 25
      }
    ]
  },
  "prioritized": true
}

Response

Successful Response

Example response

{
  "data": {
    "id": "cmp_abc123",
    "name": "Q3 Enterprise Outbound",
    "end_date": "2026-12-31",
    "template_id": "seqt_789ghi",
    "template_name": "Enterprise Onboarding",
    "audiences": [
      {
        "id": "aud_abc123",
        "name": "Enterprise West"
      }
    ],
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-05-10T14:22:00Z",
    "distribution": {
      "mode": "percentage",
      "sender_ids": [
        "550e8400-e29b-41d4-a716-446655440001"
      ],
      "percentages": [
        {
          "sender_id": "550e8400-e29b-41d4-a716-446655440001",
          "percentage": 50
        }
      ]
    },
    "rules_of_engagement": {
      "do_not_contact": {
        "enabled": true
      },
      "allow_sequence_stop_on_meeting_booked": {
        "enabled": true
      },
      "contact_cooldown": {
        "enabled": true,
        "days": 90
      },
      "account_cooldown": {
        "enabled": true,
        "days": 90
      },
      "max_contacts_in_sequence": {
        "enabled": true,
        "max_contacts": 3
      },
      "allow_non_account_owner_campaigns": {
        "enabled": true
      },
      "allow_stop_and_dismiss_on_account_status": {
        "enabled": true,
        "statuses": [
          "OPPORTUNITY",
          "CUSTOMER"
        ]
      },
      "exclude_sequences_on_account_status": {
        "enabled": true,
        "statuses": [
          "OPPORTUNITY",
          "CUSTOMER"
        ]
      }
    },
    "autopilot_settings": {
      "sender_rates": [
        {
          "sender_id": "550e8400-e29b-41d4-a716-446655440001",
          "daily_rate_target": 25
        }
      ]
    }
  }
}

Changes