The default times for a channel
| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | ChannelDefaultTime |
| TypeScript | Publishing.ChannelDefaultTime, attributes Publishing.ChannelDefaultTimeAttributes, schema Publishing.ChannelDefaultTimeSchema |
| Planning Center path | /publishing/v2/channels/{channel_id}/channel_default_times |
| Planning Center docs | ChannelDefaultTime |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.channels.id(channelId).channel_default_times |
Collection | Yes |
From a collection, .id(channelDefaultTimeId) addresses one ChannelDefaultTime: pco.publishing.channels.id(channelId).channel_default_times.id(channelDefaultTimeId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.ChannelDefaultTimeAttributes. Every resource also has id and type ('ChannelDefaultTime') next to its attributes.
| Name | Type | Description |
|---|---|---|
day_of_week |
number | null |
The day of the week. 0 is Sunday, 1 is Monday, etc. |
frequency |
string | null |
Possible values: weekly |
hour |
number | null |
|
minute |
number | null |
|
position |
number | null |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: position.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on channel_default_times on Channel |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Publishing.ChannelDefaultTimeSchema['create'].
| Attribute | Type |
|---|---|
_destroy |
unknown |
day_of_week |
number | null |
frequency |
string | null |
hour |
number | null |
minute |
number | null |
position |
number | null |
Update attributes
Typed as Publishing.ChannelDefaultTimeSchema['update'].
| Attribute | Type |
|---|---|
_destroy |
unknown |
day_of_week |
number | null |
frequency |
string | null |
hour |
number | null |
minute |
number | null |
position |
number | null |
See Writing data.
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const channelId = '1'; // Channel id
const page = await pco.publishing.channels.id(channelId).channel_default_times.order('position').perPage(25).list();
const items: Publishing.ChannelDefaultTime[] = page.data;