Update a campaign

Changes the fields the body names; the rest keep their values. Only a draft or scheduled campaign takes a change. Needs scope write.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`campaign_id`required	path	string · uuid	The campaign’s id

Request body

application/json · required

UpdateCampaignRequest object
from_emailstring · email | null
from_namestring | null
list_idsarray of string

1 to 16 distinct ids of live lists of the project.

1–16 items
namestring

example Spring sale, final
reply_tostring · email | null
subject_overridestring | null
template_idstring · uuid

A message template of the project.
throttle_per_hourinteger · int64 | null

1–4294967295
tracking_overrideTrackingOverrideInput | null

What a campaign tracks in place of the project’s settings.tracking.
2 fields
- TrackingOverrideInput object · all fields required
- clicksboolean
  
  Click redirects.
- opensboolean
  
  The open pixel.
transport_overridestring | null

Responses

200

The campaign after the update

Campaign object · all fields required
completed_atstring · date-time | null
created_atstring · date-time
from_emailstring · email | null

null: the project’s settings.from_email.
from_namestring | null

null: the project’s settings.from_name.
idstring · uuid

example 01900000-0000-7000-8000-000000000001
last_errorstring | null

Why the launch failed; null unless failed.
launched_atstring · date-time | null
list_idsarray of string

In the order given.
namestring

example Spring sale
partial_versionsmap of string → integer · int32

The versions of the partials fixed at launch, by name; {} before.
project_idstring · uuid
reply_tostring · email | null

null: the project’s settings.reply_to.
scheduled_atstring · date-time | null

When a scheduled campaign launches; null unless scheduled.
shard_countinteger · int32 | null

Fixed at launch; null before.

≥ 0
statusstring

draft, scheduled, launching, sending, paused, completed, cancelled or failed.

example draft
subject_overridestring | null

null: the template’s subject.
template_idstring · uuid
template_versioninteger · int32 | null

The template’s version fixed at launch; null before.

≥ 0
throttle_per_hourinteger · int32 | null

null: the project’s default_throttle_per_hour, or no limit.

≥ 0
total_recipientsinteger · int64 | null

Recipients of the launch’s snapshot; null before.

≥ 0
tracking_overrideTrackingOverride | null

null: the project’s settings.tracking.
2 fields
- TrackingOverride object · all fields required
- clicksboolean
- opensboolean
transport_overridestring | null

null: the project’s transport, then the node’s default.
updated_atstring · date-time

The latest change: creation, fields, status.

400

Not JSON (invalid_json)

Problem (application/problem+json)

401

No valid key

Problem (application/problem+json)

403

A project key without scope write (forbidden)

Problem (application/problem+json)

404

No such project or campaign in it, or another project’s (not_found)

Problem (application/problem+json)

409

The campaign is past scheduled, or its project is deleted (conflict)

Problem (application/problem+json)

413

Over 10 MB (body_too_large)

Problem (application/problem+json)

415

Not application/json (unsupported_media_type)

Problem (application/problem+json)

422

Invalid fields, every one in errors (validation_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)