Skip to main content
PUT
AhaSend Go SDK
The AhaSend API changes a draft campaign. Access requires campaigns:write. A campaign that is not a draft answers 409 with campaign is not a draft. To change a scheduled campaign, unschedule it first. See Changes only to drafts. Fields:
  • A field that you leave out does not change and is not checked. A request with no field is refused with 400.
  • null clears subject, preheader, from or reply_to. When you clear from, reply_to stays.
  • list_ids, segment_ids, exclude_list_ids and exclude_segment_ids each replace their own set when you send them, and leave it as it is when you leave them out. [] empties a set, so exclude_segment_ids: [] removes every segment exclusion. The result needs at least one list or segment to send to. See Audience.
  • A list or segment that does not exist is refused with 400. When a segment of the audience is being built again, the API answers 409 with The campaign's audience is being updated. Try again in a minute.
  • template_id is not accepted: only Create Campaign can copy a campaign template. A request with template_id is refused with 400 as an unknown field.
  • The fields follow the rules of Create Campaign.
Design:
  • You cannot change the editor of the design.
  • A campaign with no design yet needs content.mjml, content.html or content.markup, which sets its editor as in Create Campaign.
  • For a simple design, change the design in content.markup, as AhaML: you cannot change its content.html.
  • When you send a new content.mjml, content.html or content.markup and leave out content.text, a text written by hand stays, and a text made from the HTML is made again from the new HTML. Send content.text as null to make the text again from the new HTML, also when the text was written by hand.
  • A text written by hand that stays must still render. If it holds a {{, {% or {# that cannot be rendered, the request is refused with 400.
  • The content follows the content rules of Create Campaign.
Changes from the dashboard:
  • The API and the dashboard change the same campaign. The request waits for other changes to the same campaign to finish, and a send that starts after the request uses the change.
  • When a dashboard editor is open on the same campaign, the design that is saved last is kept.
This operation accepts an Idempotency-Key header. A refusal from this operation is stored for the key, so send a corrected request with a new key. See Idempotency and campaign retries.

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.

Headers

​
Idempotency-Key
string

Optional idempotency key for safe request retries. Must be a unique string for each logical request. An identical request with a completed stored outcome returns the original status and body. An in-progress execution returns 409, a changed method/path/body returns 422, and a released 5xx execution may run again. Keys for non-secret responses expire after 24 hours. API-key create responses include a one-time secret_key, so successful encrypted replay responses for those operations expire after 5 minutes.

Maximum string length: 255

Path Parameters

​
account_id
string<uuid>
required

Account ID

​
campaign_id
string<uuid>
required

Campaign ID

Body

application/json

Changes to a draft campaign. A field left out is neither changed nor checked. The design's editor never changes.

​
name
string

Campaign name. Spaces around it are dropped.

Required string length: 1 - 255
​
subject
string | null

The subject line, cleaned as on create. Null clears it.

​
preheader
string | null

The preview text, cleaned as on create. Null clears it.

​
from
object | null

The sender, as on create. Null clears the sender; reply_to stays as it is.

​
reply_to
string<email> | null

The reply-to address, as on create. Null clears it.

​
list_ids
string<uuid>[]

The lists to send to, which replace the campaign's lists, as on create. Each of the four audience fields replaces its own set when it is present and leaves it unchanged when it is left out; the result needs at least one list or segment to send to.

Maximum array length: 50
​
segment_ids
string<uuid>[]

The segments to send to, which replace the campaign's segments, as on create.

Maximum array length: 10
​
exclude_list_ids
string<uuid>[]

The excluded lists, which replace the campaign's, as on create. [] excludes none.

Maximum array length: 50
​
exclude_segment_ids
string<uuid>[]

The excluded segments, which replace the campaign's, as on create. [] excludes none.

Maximum array length: 10
​
content
object

The content of the design, by the rules of TemplateContentInput, in the design's editor. A simple design is written with markup. A campaign with no design yet needs markup, mjml or html, which sets its editor.

Response

Campaign updated

A campaign as List Campaigns returns it, without its audience, 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.

Example:
​
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 and segments 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.

​
segment_ids
string<uuid>[]
required

The segments the campaign sends to, by ID. A segment that was deleted is left out.

​
exclude_list_ids
string<uuid>[]
required

The lists whose contacts the campaign does not send to, by ID. A contact with any membership of one of them, whatever its status, is left out. A list that was deleted is left out.

​
exclude_segment_ids
string<uuid>[]
required

The segments whose members the campaign does not send to, by ID. A segment 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.

​
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.

​
markup_warnings
object[]

Warnings about the AhaML in content.markup, up to the first 100; empty when there are none. Present only in the answer to a write that carried content.markup.

Maximum array length: 100