An email address that is marked as spam
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | SpamEmailAddress |
| TypeScript | People.SpamEmailAddress, attributes People.SpamEmailAddressAttributes, schema People.SpamEmailAddressSchema |
| Planning Center path | /people/v2/spam_email_addresses |
| Planning Center docs | SpamEmailAddress |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.spam_email_addresses |
Collection | No |
From a collection, .id(spamEmailAddressId) addresses one SpamEmailAddress: pco.people.spam_email_addresses.id(spamEmailAddressId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.SpamEmailAddressAttributes. Every resource also has id and type ('SpamEmailAddress') next to its attributes.
| Name | Type | Description |
|---|---|---|
address |
string | null |
|
created_at |
string | null |
|
updated_at |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.spam_email_addresses.perPage(25).list();
const items: People.SpamEmailAddress[] = page.data;