MAmailchimp
lists

Batch subscribe or unsubscribe

Batch subscribe or unsubscribe list members.

post/3.0/lists/{list_id}

Request

Path parameters

list_idstring required

The unique ID for the list.

Query parameters

skip_merge_validationboolean

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

skip_duplicate_checkboolean

If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false.

Request body

sync_tagsboolean nullable

Whether this batch operation will replace all existing tags with tags in request.

update_existingboolean nullable

Whether this batch operation will change existing members' subscription status.

Response

error_countinteger

The total number of items matching the query, irrespective of pagination.

total_createdinteger

The total number of items matching the query, irrespective of pagination.

total_updatedinteger

The total number of items matching the query, irrespective of pagination.

Example response

{
  "error_count": 42,
  "total_created": 42,
  "total_updated": 42
}

Changes

No recorded changes to this operation across all 1 revision of this API.