Update a campaign's settings
Updates the campaign's shared settings block - name, start date, timezone and sending days, source and exclusion lists, enrollment exclusions, tracking, delegates and the {CTA Link} URL - and returns the campaign as stored. Every field is optional but at least one must be present. Changing listIds rewrites the source-list set; it does not by itself enroll a newly added list's contacts into a running campaign. Changing campaignStartDate reschedules the first step's still-pending sends, and changing ctaLink rewrites queued sends that carry the old link. Only the token owner's own campaigns can be updated: a campaign delegated to you, one shared by your team's visibility settings, and a deleted one all answer 404. Rate limit: 30 requests/minute and 1,000/day per token owner, shared by every campaign, scheduled-send, campaign-template and knowledge-hub endpoint.
Errors:
- 404 CAMPAIGN_NOT_FOUND — No campaign with this id exists, it belongs to another account (including a campaign delegated to you or shared by your team's visibility settings), or it has been deleted.
- 409 CAMPAIGN_INITIALIZING — listIds was sent while an ai-generated campaign's background initialization is still running, so its channels are not settled yet; poll GET /business/campaigns/{campaignId} until initializationStatus is completed or failed, then retry.
- 422 LIST_INCOMPATIBLE_WITH_CHANNELS — The listIds together have no contact usable by the campaign's steps: they are empty, or no contact carries an email address (email/inmail step) or a LinkedIn URL (LinkedIn step).
- 409 CAMPAIGN_INITIALIZING — listIds was sent while an ai-generated campaign's background initialization is still running, so its channels are not settled yet; poll GET /business/campaigns/{campaignId} until initializationStatus is completed or failed, then retry.
- 422 LIST_INCOMPATIBLE_WITH_CHANNELS — The listIds together have no contact usable by the campaign's steps: they are empty, or no contact carries an email address (email/inmail step) or a LinkedIn URL (LinkedIn step).
- 422 EXCLUDE_COMPANY_LISTS_INVALID — An excludeCompanyLists entry is not a non-archived company or people list owned by your team.
- 422 VALIDATION_FAILED — Empty body, unknown key, an unrecognised timezone, a non-http(s) ctaLink, or a value out of range; param names the field.
- 429 RATE_LIMITED — More than 30 campaign requests in a minute, or 1,000 in a day, for this token owner (the bucket is shared by every /business/campaigns, /business/scheduled-sends, /business/campaign-templates and /business/knowledge-hubs call).
- 500 UNEXPECTED_ERROR — An unhandled failure; the detail stays in our logs and is never returned.
Requires one of the following token scopes: campaigns.
Request
- Base URL: https://api.tryfuse.ai/api/v1
- URL: https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}
- Auth: HTTP basic
Path parameters
The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.