This page documents the canonical HTTP contract for this endpoint.
Provider responses vary by account and provider version. The example is abridged and illustrative; omitted provider-specific fields are not a stable schema.
Campaign creation makes provider calls and may create/update provider resources. Activation is opt-in; creation alone leaves the campaign draft/inactive. A 409 can occur after the provider campaign exists and earlier setup steps have succeeded; inspect partial result details before retrying to avoid duplicate provider resources.
Path parameters
integrationrequiredstring
instantly or smartlead.
| Name | Type | Description |
|---|---|---|
| integrationrequired | string | instantly or smartlead. |
Body parameters
namerequiredstring
Campaign name.
schedule· optionalobject
Optional provider schedule object.
accountSelection· optionalstring
all_eligible or selected.
selectedAccounts· optionalarray<string>
Sending-account emails used with accountSelection=selected.
minHealthScore· optionalinteger
Optional threshold override; accounts with a known health score below it are excluded by this comparison.
steps· optionalarray<object>
Deterministic provider template steps with subject, body and waitDays.
activate· optionalboolean
If true, create and activate; provider activation admission may return 409 or 503.
| Name | Type | Description |
|---|---|---|
| namerequired | string | Campaign name. |
| schedule | object | Optional provider schedule object. |
| accountSelection | string | all_eligible or selected. |
| selectedAccounts | array<string> | Sending-account emails used with accountSelection=selected. |
| minHealthScore | integer | Optional threshold override; accounts with a known health score below it are excluded by this comparison. |
| steps | array<object> | Deterministic provider template steps with subject, body and waitDays. |
| activate | boolean | If true, create and activate; provider activation admission may return 409 or 503. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is missing or invalid. |
| 403 | The credential is invalid or lacks the required scope. |
| 400 | Provider is unsupported or organization context is missing. |
| 422 | The typed campaign request body is invalid. |
| 409 | Campaign setup is not ready or provider setup failed. |
| 503 | Provider-effect admission could not be confirmed when activation was requested. |
