Get the activation preflight

GET/v1/campaigns/{campaign_id}/preflight

Scope: campaigns:read

The readiness verdict that activating with Update a campaign enforces, without activating: the sequence and its step content, variables and lead data coverage, the assigned senders and whether they're connected, sender email authentication, account conflicts and limits, enrolled leads, and the subscription.

ok is true when nothing blocks. Each entry in checks carries an id, a label, a status of pass, warn or fail, and a detail; blocking_count and warning_count total them. issues lists each problem with a code, a severity, a message and a suggested fix.

Useful on a live campaign too: a failing check there says why it has stopped sending.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Response

200

campaign_idstringRequired
okbooleanRequired
True when nothing blocks activation
blocking_countinteger
Default 0
checksarray of objects
Every check: {id, label, status: pass|warn|fail, detail, tab, route}
issuesarray of objects
Machine-readable problems: {code, severity, message, fix}
successboolean
Default true
warning_countinteger
Default 0

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.