Campaigns

Approve (activate) a draft campaign

Approves (activates) a draft campaign so the scheduler starts sending. Validation is synchronous - the campaign must have a source list, and every step must carry the content its type needs - and activation itself then runs in the background, which is why this answers 202. Re-approving a stopped campaign resumes it with its parked rows intact. This is the only endpoint in the family that causes messages to be sent. Ownership is required: a campaign delegated to you, one shared by your team's visibility settings, and a deleted one all answer 404 without approving anything. 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_NOT_APPROVABLE — The campaign is not in a state that can be activated (for example it is already active).
  • 409 CAMPAIGN_BUSY — Another approve or stop is holding this campaign's activation lock. Retry in a few seconds.
  • 422 CAMPAIGN_NOT_READY — The campaign is missing something activation requires: no source list, an ai-generated campaign with no ctaLink, a step with no content, a missing subject/body or topic, or no connected email / LinkedIn account for one of its channels.
  • 422 VALIDATION_FAILED — campaignId is not a 24-character hex id.
  • 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.

post/business/campaigns/{campaignId}/approve

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/approve
  • Auth: HTTP basic

Path parameters

campaignIdstring required

The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.

Response

Success

campaignIdstring required
statusstring required

The campaign's status once activation was accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.