Get a Campaign via the API

Retrieve an AhaSend marketing campaign by ID with its status, sender, lists and design, and for a draft, the issues that stop it from being sent.

GET /v2/accounts/{account_id}/campaigns/{campaign_id}

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"
  "os"

  "github.com/AhaSend/ahasend-go/api"
  "github.com/google/uuid"
)

func main() {
  client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY")))
  accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID"))
  ctx := context.Background()

  campaignID := uuid.MustParse("11111111-1111-4111-8111-111111111111")

  response, _, err := client.CampaignsAPI.GetCampaign(ctx, accountID, campaignID)
  if err != nil {
    log.Fatalf("Error getting campaign: %v", err)
  }
  fmt.Printf("%s is %s, sending to %d lists\n", response.Name, response.Status, len(response.ListIDs))
  // A draft lists what keeps it from being sent.
  for _, issue := range response.Issues {
    fmt.Printf("%s: %s\n", issue.Code, issue.Message)
  }
}

200

{
  "object": "campaign",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "subject": "<string>",
  "preheader": "<string>",
  "from": {
    "email": "[e-mail]",
    "name": "Example Corp"
  },
  "reply_to": "[e-mail]",
  "status": "draft",
  "status_reason": "<string>",
  "send_at": "2023-11-07T05:31:56Z",
  "send_resumes_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "list_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "editor": "advanced",
  "content": {
    "text_is_custom": true,
    "mjml": "<string>",
    "html": "<string>",
    "text": "<string>"
  },
  "ready": true,
  "issues": [
    {
      "code": "sender_missing",
      "message": "<string>"
    }
  ]
}

The AhaSend API returns a campaign with its lists, its design and its status. Access requires campaigns:read.

• ready and issues apply to a draft. ready is true when the draft has no issues. issues lists what to fix, each with a code and a message. For a campaign that is not a draft, both are null. See Issues.
• status and status_reason show where the campaign is after a send. See Campaign status.
• list_ids holds the lists of the campaign in the order they were saved. A list that was deleted is left out.
• from is null until the campaign has a complete sender, and when the domain of the sender was deleted. When the sender has no name, from.name is an empty string, so you can send the object back as it is.
• editor is null while the campaign has no design.
• content is null while the campaign has no design, and while its design has no HTML and no text. For example, after a create with editor alone, editor is set and content is null.

Related Guides

• API authentication, Permission scopes, Update Campaign.
• API errors, API rate limits.

Authorizations

Authorization · string · header · required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Path Parameters

account_id · string<uuid> · required

Account ID

campaign_id · string<uuid> · required

Campaign ID

Response

200

application/json

Campaign

A campaign as List Campaigns returns it, without its lists, content and issues.

object · enum<string> · required

Object type identifier

Available options: campaign

id · string<uuid> · required

Campaign ID

created_at · string<date-time> · required

When the campaign was created

updated_at · string<date-time> · required

When the campaign's own fields last changed

name · string · required

Campaign name, as it appears in the dashboard. Recipients do not see it.

subject · string | null · required

The subject line. Null until one is set.

preheader · string | null · required

The preview text, which most inboxes show after the subject. Null until one is set.

from · object | null · required

The sender. Null until a complete sender is set, and when its domain was deleted. name is an empty string when the campaign has no sender name, so the object can be sent back as it is.

Show child attributes

Example:

{
  "email": "[e-mail]",
  "name": "Example Corp"
}

reply_to · string<email> | null · required

The reply-to address. Null when none is set.

status · enum<string> · required

Where the campaign is in its life. Only a draft can be changed or deleted.

• draft: being prepared.
• validating: scheduled, and its lists are being checked.
• waiting_for_review: held for a review before it sends.
• scheduled: accepted, waiting for its send time.
• sending: sending now.
• paused: sending stopped for now; status_reason says why.
• sent: every message was sent.
• canceled: stopped before it finished; status_reason says why.
• failed: could not be sent; status_reason says why.

Available options: draft, validating, waiting_for_review, scheduled, sending, paused, sent, canceled, failed

status_reason · string | null · required

Why the campaign is in its status, when there is a reason to give. Null otherwise.

send_at · string<date-time> | null · required

When the campaign sends or sent, in UTC. Null until it is scheduled.

send_resumes_at · string<date-time> | null · required

When a send that reached the account's daily marketing limit continues, in UTC. Null otherwise.

finished_at · string<date-time> | null · required

When the send ended, in UTC. Null until then.

list_ids · string<uuid>[] · required

The lists the campaign sends to, in the order they were saved. A list that was deleted is left out.

editor · enum<string> | null · required

The editor of the campaign's design. Null while the campaign has no design.

Available options: advanced, simple, html

content · object | null · required

The content of the campaign's design. Null while it has no design, or its design has neither HTML nor text.

Show child attributes

ready · boolean | null · required

Whether the draft has no issue, so it can be sent. Null unless the campaign is a draft.

issues · object[] | null · required

The reasons the draft cannot be sent yet, in a fixed order; empty when it is ready. Null unless the campaign is a draft.

Show child attributes