Mailcoach icon

Mailcoach

Interact with Mailcoach API - Manage email lists, subscribers, campaigns, and transactional emails

Campaign → Get Unsubscribes

AI-generated

Summary

Retrieve unsubscribed recipients from a specific email campaign using its UUID, with optional pagination control.

Inputs

  • Campaign ID (required) — The UUID of the campaign for which to get unsubscribes.
  • Return All — Whether to return all unsubscribe records or limit the number returned.
  • Limit — Maximum number of unsubscribe records to return if 'Return All' is false; defaults to 100, max 1000.

Output shape

a list of unsubscribe records as JSON objects

Supports returning all records or a limited subset with pagination controlled by 'Return All' and 'Limit' parameters. Returned data corresponds to the Mailcoach API's unsubscribes for the specified campaign.

Examples

Example 1: Get the first 100 unsubscribes from a campaign

Set Campaign ID with the UUID, Return All false (default), Limit 100.

Example 2: Get all unsubscribes from a campaign

Set Campaign ID and Return All true.

Discussion