Skip to content

AnnouncementCategory (Publishing)

The AnnouncementCategory 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 AnnouncementCategory
TypeScript Publishing.AnnouncementCategory, attributes Publishing.AnnouncementCategoryAttributes, schema Publishing.AnnouncementCategorySchema
Planning Center path /publishing/v2/announcement_categories
Planning Center docs AnnouncementCategory

How to reach it

Client path Returns Filters Create
pco.publishing.announcement_categories Collection No
pco.publishing.announcements.id(announcementId).announcements_announcement_categories.id(announcementsAnnouncementCategoryId).announcement_category Collection No

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

Attributes

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

Name Type Description
name string | null

Querying

No documented where fields.

Order

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

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.publishing.announcement_categories.order('name').perPage(25).list();
const items: Publishing.AnnouncementCategory[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close