| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | NoteTemplate |
| TypeScript | Publishing.NoteTemplate, attributes Publishing.NoteTemplateAttributes, schema Publishing.NoteTemplateSchema |
| Planning Center path | /publishing/v2/episodes/{episode_id}/note_template |
| Planning Center docs | NoteTemplate |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.episodes.id(episodeId).note_template |
Single resource | No |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.NoteTemplateAttributes. Every resource also has id and type ('NoteTemplate') next to its attributes.
| Name | Type | Description |
|---|---|---|
auto_create_free_form_notes |
boolean | null |
|
enabled |
boolean | null |
|
published_at |
string | null |
|
template |
string | null |
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.NoteTemplateSchema['update'].
| Attribute | Type |
|---|---|
auto_create_free_form_notes |
boolean | null |
enabled |
boolean | null |
template |
string | null |
See Writing data.
Example
import type { Publishing } from '@mackenly/planningcenterkit';
function describe(resource: Publishing.NoteTemplate): string {
return `${resource.type} ${resource.id}`;
}