Mailing Lists

Get Mailing List

Changed on

Retrieve a specific mailing list by its ID.

get/print-mail/v1/mailing_lists/{id}

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/mailing_lists/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The unique identifier (mailing_list_...) for the mailing list.

Response

The requested mailing list details.

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

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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