Update a list

Renames the list and changes the options the body names; the rest keep their values. A deleted list takes no change. Needs scope write.

Parameters

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

Request body

application/json · required

UpdateListRequest object
confirmation_template_idstring · uuid | null

The template of the confirmation letter, a message template of the project; null clears it (not while double_opt_in is on).
double_opt_inboolean

Turn double opt-in on (needs a confirmation_template_id, the list’s or this one) or off.
from_overrideFromOverrideInput | null

The sender of the list’s own letters, replaced as a whole; null: the project’s.
2 fields
- FromOverrideInput object
- from_emailstring · emailrequired
  
  The sender address.
  
  example news@acme.example
- from_namestring | null
  
  The sender name, 1 to 128 characters, no line breaks; null or left out: the project’s settings.from_name.
  
  example Acme News
namestring

The new name.

example Monthly news

Responses

200

The list after the update

List object · all fields required
confirmation_template_idstring · uuid | null

The template of the confirmation letter; null: none.
created_atstring · date-time
deleted_atstring · date-time | null

When the list was deleted; null while it is live. A deleted list can only be read.
double_opt_inboolean

Subscribers confirm by a link before they get campaigns.
from_overrideFromOverride | null

The sender of the list’s own letters; null: the project’s.
2 fields
- FromOverride object · all fields required
- from_emailstring · email
- from_namestring | null
  
  null: the project’s settings.from_name.
idstring · uuid

example 01900000-0000-7000-8000-000000000001
namestring

example Weekly news
project_idstring · uuid

The list’s project.
updated_atstring · date-time

The latest change: creation, name, options, deletion.

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 list in it, or another project’s (not_found)

Problem (application/problem+json)

409

The list 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)