Unsubscribe contact
plunk_unsubscribe_contactOpt a contact out of marketing email while keeping their record, so they are not mailed again. Use when someone asks to stop receiving mail; transactional mail is unaffected.
Instructions
Purpose: Opt a contact out of marketing email. Transactional mail is unaffected.
Not for: Erasing them, which is plunk_delete_contact. Unsubscribing keeps the record that they opted out, which is what prevents them being mailed again.
Returns: The updated subscription state.
Use when: Someone asks to stop receiving mail. This is almost always the right tool rather than deletion.
Note: If they only want a break rather than to leave, plunk_snooze_contact pauses email for a set period and resubscribes them afterwards.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Contact's PUBLIC id — the id embedded in unsubscribe links, distinct from the regular UUID. Get it from plunk_get_contact (returns it alongside the regular id). |