Create a list

Creates a mailing list in the project. Needs scope write; an admin key may create one in any live project.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`Idempotency-Key`	header	string 1–128 characters · pattern `^[!-~]{1,128}$`	A key of the client’s choosing, one per request it means to send once (a UUID will do). A repeat with the same key and the same body within 24 h creates nothing again and gets the first answer, marked `Idempotent-Replayed: true`. The key belongs to the API key that sent it. Only a `2xx` answer is kept: after any other answer the key is free again.

Request body

application/json · required

CreateListRequest object
namestringrequired

What people call the list: 1 to 128 characters, trimmed. Two lists may share a name.

example Weekly news
confirmation_template_idstring · uuid | null

The template of the confirmation letter: the id of a message template of the project; required with double_opt_in. null or left out: none.
double_opt_inboolean

Subscribers confirm by a link before they get campaigns; default false. Needs confirmation_template_id.
from_overrideFromOverrideInput | null

The sender of the list’s own letters (confirmations) in place of the project’s; null or left out: 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

Responses

201

The list

Header	Type	Description
`Idempotent-Replayed`	string · enum	`true` when the answer is a replay of an earlier request with the same `Idempotency-Key`; absent otherwise.
`Location`	string	The list’s URL

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 another project’s (not_found)

Problem (application/problem+json)

409

The project is deleted (conflict); or a request with the same Idempotency-Key has not answered yet (idempotency_key_in_progress)

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): unknown_field, required (also confirmation_template_id with double_opt_in), invalid_type, invalid; or the Idempotency-Key was used in the last 24 h for another request (idempotency_key_reused), or is not 1 to 128 visible ASCII characters (validation_failed, field Idempotency-Key)

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)