Discussions
How can I check the email subscribe status of a profile?
18 days ago by Arlen Jacobs
ChMS Email Unsubscribe: v1 vs v2
Quick guide on reading email subscription status across API versions.
| Version | v1 | v2 |
|---|---|---|
| Field | receive_email_from_church | email_unsubscribed |
v1: Single Boolean
Maps to "General Church Communication" setting. Simple true/false, no connection to other email subscription statuses.
This setting can be TRUE, at the same time that the user is UNSUBSCRIBED to all emails. This XML response property is no longer recommended for use.
v2: Two Mechanisms
1. Profile-Level Unsubscribe:
email_unsubscribed: User unsubscribed from profile settings in the UI.
2. Email-Level Opt-In:
email_opt_in_status: (e.g. "PRE_OPT_IN" for subscribed, awaiting confirmation or "OPT_IN_CONFIRMED" for explicitly confirmed)email_unsubscribed_reason: Audit trail (e.g., "SITE_UNSUBSCRIBED")
Key Difference
v2 separates profile-level unsubscribe from email opt-in status. A user can be subscribed but awaiting email confirmation. v1 only looks at one specific email type, from the church, and does not apply to the profile account as a whole.
Recommendation
Use v2 for integrations. Check email_unsubscribed as the primary signal, and email_opt_in_status for granular control.