Skip to content

Announcement (Publishing)

The Announcement resource in Planning Center Publishing: how to reach it, its attributes, and what you can query and write.

Property Value
Product Publishing (pco.publishing, API version 2024-03-25)
Resource type Announcement
TypeScript Publishing.Announcement, attributes Publishing.AnnouncementAttributes, schema Publishing.AnnouncementSchema
Planning Center path /publishing/v2/announcements
Planning Center docs Announcement

How to reach it

Client path Returns Filters Create
pco.publishing.announcements Collection active, active_and_scheduled, archived, inactive No

From a collection, .id(announcementId) addresses one Announcement: pco.publishing.announcements.id(announcementId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Publishing.AnnouncementAttributes. Every resource also has id and type ('Announcement') next to its attributes.

Name Type Description
archived boolean | null
attach_linked_resource_image_job_id string | null
church_center_url string | null
featured boolean | null
hide_at string | null
image Record<string, unknown> | null
link string | null
link_resource_id number | null
link_type string | null
position number | null
show_at string | null
status string | null
summary string | null
title string | null

Relationships and includes

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

Querying

Where

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

Field Value type Operators
title string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: featured, position, show_at, status, title.

Filters

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

Edge Filters
pco.publishing.announcements active, active_and_scheduled, archived, inactive

Edges

Follow these from one Announcement, ref = pco.publishing.announcements.id(announcementId):

Edge Leads to Returns Filters Create
ref.announcements_announcement_categories AnnouncementsAnnouncementCategory Collection No
ref.announcements_campuses AnnouncementsCampus Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.publishing.announcements.order('featured').perPage(25).list();
const items: Publishing.Announcement[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close