Campaigns

Schedule a campaign run

Schedules an email campaign run at the absolute ISO-8601 instant in scheduledFor, or immediately when omitted. The optional idempotencyKey is scoped to the organization and replays return the original run. An email campaign must carry the brand footer: it is refused with CampaignFooterRequiredError when its footer is off and its template renders no BrandFooter, and with BrandAddressRequiredError when a brand that signs it off has no postal address.

post/v1/campaigns/{id}/runs

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/campaigns/{id}/runs
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

scheduledForstring nullable
idempotencyKeystring nullable

Response

Success

idstring required
campaignIdstring required
status'scheduled' | 'resolving' | 'dispatching' | 'paused' | 'completed' | 'cancelled' | 'failed' required
scheduledForstring required
idempotencyKeystring nullable required
startedAtstring nullable required
completedAtstring nullable required
totalRecipientsnumber required
dispatchedCountnumber required
failedCountnumber required
skippedCountnumber required
pendingCountnumber required
estimatedCompletionAtstring nullable required
failureReasonstring nullable required
holdReasonstring nullable required
holdDomainIdstring required
holdUntilstring nullable required
capacityWarningstring nullable required
lastContactIdstring nullable required
createdBystring nullable required
actorEmailstring required
memberRolestring required
createdAtstring required
updatedAtstring required

Changes

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