Skip to content

Message (People)

A message is an individual email or sms text sent to a member.

A message is an individual email or sms text sent to a member. Every message has a parent message group.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type Message
TypeScript People.Message, attributes People.MessageAttributes, schema People.MessageSchema
Planning Center path /people/v2/messages
Planning Center docs Message

How to reach it

Client path Returns Filters Create
pco.people.messages Collection created_after No
pco.people.message_groups.id(messageGroupId).messages Collection No
pco.people.people.id(personId).messages Collection created_after, received, sent, unread No

From a collection, .id(messageId) addresses one Message: pco.people.messages.id(messageId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On People.MessageAttributes. Every resource also has id and type ('Message') next to its attributes.

Name Type Description
app_name string | null
bounced_at string | null
created_at string | null
delivery_status string | null
file Record<string, unknown> | null
from_address string | null
from_name string | null
kind string | null Possible values: email, sms, or church_center_message
message_type string | null
read_at string | null
reject_reason string | null
rejection_notification_sent_at string | null
sent_at string | null
subject string | null
to_addresses string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): message_group, to.

Relationship Type To Includable
from To one Person No
message_group To one MessageGroup Yes
to To one Person Yes

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
app_name string Equality only
bounced_at string | Date gt, gte, lt, lte
created_at string | Date gt, gte, lt, lte
delivery_status string Equality only
file unknown Equality only
from_address string Equality only
kind string Equality only
reject_reason string Equality only
rejection_notification_sent_at string | Date gt, gte, lt, lte
sent_at string | Date gt, gte, lt, lte
subject string Equality only
to_addresses string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: app_name, bounced_at, created_at, delivery_status, file, from_address, from_name, kind, reject_reason, rejection_notification_sent_at, sent_at, subject, to_addresses.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.people.messages created_after
messages on Person created_after, received, sent, unread

Edges

Follow these from one Message, ref = pco.people.messages.id(messageId):

Edge Leads to Returns Filters Create
ref.message_group MessageGroup Collection No
ref.to Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

import type { People } from '@mackenly/planningcenterkit';

const page = await pco.people.messages.order('app_name').perPage(25).list();
const items: People.Message[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close