Mailing Lists

Submit a Mailing List Job

Changed on

Runs a mailing list job. Mailing list jobs allow you to add or remove contacts to your mailing list from mailing list imports or directly with contact IDs. Only one job can be ran at a time and jobs are only able to be ran while the mailing list has a status of "completed".

Once a job as successfully been kicked off, the mailing list will have a status of either creating_contacts or removing_contacts depending on which job was ran. After the job has finished, the mailing list will go back into the completed state where more jobs can be ran. If there are any errors while running a job, the errors field on the mailing list will contain a list of error objects which describe the errors.

post/print-mail/v1/mailing_lists/{id}/jobs

Request

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

Path parameters

idstring required

Request body

addContactsstring[]

List of contact IDs to add to the mailing list. Cannot be used with other operations.

removeContactsstring[]

List of contact IDs to remove from the mailing list. Cannot be used with other operations.

addMailingListImportsstring[]

List of mailing list import IDs to add to the mailing list. Cannot be used with other operations.

removeMailingListImportsstring[]

List of mailing list import IDs to remove from the mailing list. Cannot be used with other operations.

Response

The request has succeeded.

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

      added subschema #1 subschema #2 subschema #3 subschema #4 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

    • info

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