Skip to content

CustomSender (People)

A custom sender that can be used when sending emails.

A custom sender that can be used when sending emails.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type CustomSender
TypeScript People.CustomSender, attributes People.CustomSenderAttributes, schema People.CustomSenderSchema
Planning Center path /people/v2
Planning Center docs CustomSender

How to reach it

No documented path leads to this resource. It may appear in included or as a relationship of other resources; use pco.request() for undocumented endpoints.

Attributes

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

Name Type Description
created_at string | null
email_address string | null
expired boolean | null
name string | null
updated_at string | null
verification_requested_at string | null
verification_status string | null
verified boolean | null
verified_at string | null

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
custom_sender_shares To one CustomSenderShare No

Querying

No documented where fields.

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, name, updated_at, verification_requested_at, verified_at.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
send_verification POST /people/v2 Begins the verification process when a custom sender’s email address is created or updated.

Example

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

function describe(resource: People.CustomSender): string {
    return `${resource.type} ${resource.id}`;
}

Type to search…

↑↓ navigate↵ selectEsc close