Contacts
Get contact email preferences by ID
Retrieves the email preference state for a customer contact by their Featurebase ID.
Important: This endpoint only supports customer contacts. Leads do not have a customer email preference surface in the public API.
Path Parameters
id- The Featurebase contact ID (24-character ObjectId)
Response Format
Returns a contact email preferences object with:
object- Always "contact_email_preferences"contactId- Featurebase contact IDuserId- External user ID, if availableemail- Contact email address, if availablepreferences- Current email preference state
Preference Semantics
Each preference includes:
status- The stored preference state for that categoryeffectiveStatus- The final state after applying the globalallpreference override
Example Response
{
"object": "contact_email_preferences",
"contactId": "676f0f6765bdaa7d7d760f88",
"userId": "usr_12345",
"email": "john@example.com",
"preferences": {
"all": {
"status": "unsubscribed",
"effectiveStatus": "unsubscribed"
},
"postUpdates": {
"status": "subscribed",
"effectiveStatus": "unsubscribed"
},
"postComments": {
"status": "subscribed",
"effectiveStatus": "unsubscribed"
},
"commentReplies": {
"status": "subscribed",
"effectiveStatus": "unsubscribed"
},
"changelog": {
"status": "subscribed",
"effectiveStatus": "unsubscribed"
}
}
}Response
application/json
Success
Object type identifier
Available options:
contact_email_preferencesExample:
contact_email_preferencesEmail preference state for this contact, including both stored status and final effective status.