Postwind Pre-release Download
Docs menu update_list

Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Lists HTTP API

PATCH/api/v1/projects/{project_id}/lists/{list_id}

update_list

Renames a mailing list and changes its options: double opt-in, the confirmation template, the sender of its own letters.

Call it
to turn double opt-in on or off or to brand a list’s letters.
Needs
an admin key with project_id, or a project key with scope write (its own project; the argument is ignored), and a list that is not deleted; double opt-in needs a confirmation template, a message template of the project. Arguments left out keep their values; null clears what may be empty; from_override is replaced as a whole.
Returns
the list after the change, the same as PATCH /api/v1/projects/{project_id}/lists/{list_id}.

Arguments

  • object
  • list_idstring · uuidrequired

    The list’s id.

  • 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; leave it out to keep it.

  • from_overrideFromOverrideArguments | null

    The sender of the list’s own letters, replaced as a whole; null: the project’s.

    2 fields
    • FromOverrideArguments object
    • from_emailstringrequired

      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.

  • namestring

    The new name; leave it out to keep the name.

  • project_idstring · uuid | null

    The list’s project. An admin key must pass it; a project key’s own project is used and this is ignored.

No other arguments are accepted.

Result

The result comes back as structuredContent, with the same JSON as a text block.

  • 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
    • from_namestring | null

      null: the project’s settings.from_name.

  • idstring · uuid
  • namestring
  • project_idstring · uuid

    The list’s project.

  • updated_atstring · date-time

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

Definitions

FromOverride

The sender of a list’s own letters.

  • object · all fields required
  • from_emailstring
  • from_namestring | null

    null: the project’s settings.from_name.

FromOverrideArguments

The sender of a list’s own letters.

  • object
  • from_emailstringrequired

    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.

Errors

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors

HTTP API

The same operation over HTTP: PATCH /api/v1/projects/{project_id}/lists/{list_id}