Campaigns

Update Campaign

Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns

put/campaigns/{name}

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/campaigns/{name}
  • Auth
    API key in header X-ElasticEmail-ApiKey

Path parameters

namestring string required

string

Name of Campaign to update

Request body

Namestring string required

Campaign name

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

Example request

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

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"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.