Mailing Lists

Create Mailing List

Create a new mailing list.

post/print-mail/v1/mailing_lists

Headers

idempotency-keystring

Request body

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

Response

The newly created mailing list.

idstring required

A unique ID prefixed with mailing_list_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

status'creating_contacts' | 'removing_contacts' | 'counting_recipient_country_codes' | 'completed' required

Status of the mailing list processing.

Changes

Changed in 1 of the 7 revisions of this API.42

    • added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • added the new not_found_error enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • added the new validation_error enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • added subschema #1 subschema #2 to the response body anyOf list for the response status 401

      response-body-any-of-added

    • removed subschema #1 subschema #2 from the response body anyOf list for the response status 401

      response-body-any-of-removed

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog