Skip to content

AnnouncementSettings (Publishing)

Settings for how an Organization's Announcements are displayed

Settings for how an Organization’s Announcements are displayed

Property Value
Product Publishing (pco.publishing, API version 2024-03-25)
Resource type AnnouncementSettings
TypeScript Publishing.AnnouncementSettings, attributes Publishing.AnnouncementSettingsAttributes, schema Publishing.AnnouncementSettingsSchema
Planning Center path /publishing/v2/announcement_settings
Planning Center docs AnnouncementSettings

How to reach it

Client path Returns Filters Create
pco.publishing.announcement_settings Single resource No

Collections support where, include, order, and pagination; single resources have get().

Attributes

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

Name Type Description
announcements_sort_mode string | null See details.

Attribute details

announcements_sort_mode

How Announcements are sorted. manual uses the order set with the reorder_announcements action.

Possible values: default, manual

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update Yes, update() on a reference
Delete No

Update attributes

Typed as Publishing.AnnouncementSettingsSchema['update'].

Attribute Type
announcements_sort_mode string | null

See Writing data.

Example

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

const { data } = await pco.publishing.announcement_settings.get();
const item: Publishing.AnnouncementSettings | null = data;

Type to search…

↑↓ navigate↵ selectEsc close