| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | TextSetting |
| TypeScript | Services.TextSetting, attributes Services.TextSettingAttributes, schema Services.TextSettingSchema |
| Planning Center path | /services/v2/people/{person_id}/text_settings |
| Planning Center docs | TextSetting |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).text_settings |
Collection | No |
From a collection, .id(textSettingId) addresses one TextSetting: pco.services.people.id(personId).text_settings.id(textSettingId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.TextSettingAttributes. Every resource also has id and type ('TextSetting') next to its attributes.
| Name | Type | Description |
|---|---|---|
carrier |
string | null |
|
display_number |
string | null |
|
general_emails_enabled |
boolean | null |
|
normalized_number |
string | null |
|
reminders_enabled |
boolean | null |
|
scheduling_replies_enabled |
boolean | null |
|
scheduling_requests_enabled |
boolean | 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 Services.TextSettingSchema['update'].
| Attribute | Type |
|---|---|
general_emails_enabled |
boolean | null |
reminders_enabled |
boolean | null |
scheduling_replies_enabled |
boolean | null |
scheduling_requests_enabled |
boolean | null |
See Writing data.
Example
import type { Services } from '@mackenly/planningcenterkit';
const personId = '1'; // Person id
const page = await pco.services.people.id(personId).text_settings.perPage(25).list();
const items: Services.TextSetting[] = page.data;