Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Campaigns

Load Campaign

Returns the specified campaign details. Required Access Level: ViewCampaigns

get/campaigns/{name}

Path parameters

namestring string required

string

Name of Campaign to get

Response

OK

Namestring string required

Campaign name

Status'Deleted' | 'Active' | 'Processing' | 'Sending' | 'Completed' | 'Paused' | 'Cancelled' | 'Draft'

Example response

{
  "Content": [
    {
      "Poolname": "My Custom Pool",
      "From": "John Doe <email@domain.com>",
      "ReplyTo": "John Doe <email@domain.com>",
      "Subject": "Hello!",
      "TemplateName": "Template01",
      "AttachFiles": [
        "preuploaded.jpg"
      ]
    }
  ]
}