The ChMeetings connector lets your AI agent act in each user's ChMeetings account. Each user connects their own ChMeetings API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 33 · 19 · 833 read19 write8 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ChMeetings connection
In AgentKit > Connections, create a ChMeetings connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'chmeetings'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ChMeetings:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'chmeetings_accounting_accounts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "chmeetings"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ChMeetings:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="chmeetings_accounting_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ChMeetings credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolchmeetings_accounting_accounts_listList the ledger accounts (bank registers), optionally with their current balance.Read-onlyList Accounting Accounts
List the ledger accounts (bank registers), optionally with their current balance. Returns a page of accounts with ID, name, type (asset or liability) and, with include=balance, the running balance. Use chmeetings_accounting_accounts_list for account balances and IDs. Use chmeetings_accounting_transactions_list for activity. Needs the API key scope accounting:read.
Inputs
includestring- Set to balance to include each account's current running balance. Example: balance
include_archivedboolean- Include archived accounts. Default: false. Example: false
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 typestring- Filter by account type. Accepted values: asset, liability. One of: asset, liability. Example: assetone of
assetliability
chmeetings_accounting_categories_listList the income and expense categories of the ledger.Read-onlyList Accounting Categories
List the income and expense categories of the ledger. Returns a page of categories with ID, name, type and parent_category_id (at most two levels). Use chmeetings_accounting_categories_list to get category IDs for filtering chmeetings_accounting_transactions_list. Needs the API key scope accounting:read.
Inputs
include_archivedboolean- Include archived categories. Default: false. Example: false
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 searchstring- Text to filter categories by name (contains match). Example: Utilities
typestring- Filter by category type. Accepted values: income, expense. One of: income, expense. Example: expenseone of
incomeexpense
chmeetings_accounting_transactions_listList general-ledger transactions with their split lines, newest first, filtered by account, date range, type, categories, funds, payee, check number, text or amount.Read-onlyList Accounting Transactions
List general-ledger transactions with their split lines, newest first, filtered by account, date range, type, categories, funds, payee, check number, text or amount. Returns a page of transactions; amounts are positive and type (income or expense) gives the direction. Use chmeetings_accounting_transactions_list for the church's books. Use chmeetings_contributions_list for donor giving. Needs the API key scope accounting:read.
Inputs
account_idinteger- Filter to a single account's register. Example: 4
category_idsstring- Comma-separated category IDs; matches transactions with at least one line in any of them (e.g. "12" or "12,34"). At most 100 IDs. Example: 12,34
check_nostring- Filter by check number (contains match). Example: 1042
fromstring- Start of the transaction-date range (inclusive). Format: yyyy-MM-dd, church-local. Example: 2026-01-01
fund_idsstring- Comma-separated fund IDs; matches transactions with at least one line in any of them (e.g. "3" or "3,7"). At most 100 IDs. Example: 3,7
include_beginning_balancesboolean- Include beginning-balance (opening-balance) transactions. Default: true; each row carries is_beginning_balance. Example: true
include_voidedboolean- Include voided transactions. Voided rows contribute zero to every balance and are hidden by default. Example: false
max_amountnumber- Maximum transaction amount (amounts are positive; direction comes from type). Example: 5000
min_amountnumber- Minimum transaction amount (amounts are positive; direction comes from type). Example: 50
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 payee_idinteger- Filter by payee. Example: 55
searchstring- Text search across the transaction memo and line notes (contains match). Example: utilities
tostring- End of the transaction-date range (inclusive). Format: yyyy-MM-dd, church-local. Example: 2026-01-31
typestring- Filter by transaction type. Accepted values: income, expense. One of: income, expense. Example: expenseone of
incomeexpense
chmeetings_campaign_pledges_listList the pledges made to a campaign.Read-onlyList Campaign Pledges
List the pledges made to a campaign. Returns a page of pledges with the person, pledged amount and amount given so far. Use chmeetings_campaign_pledges_list to track campaign progress. Use chmeetings_contributions_list for actual gifts. Needs the API key scope contributions:read.
Inputs
campaign_idintegerrequired- Campaign ID, as returned by chmeetings_campaigns_list. Example: 17
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_campaigns_listList pledge campaigns.Read-onlyList Campaigns
List pledge campaigns. Returns a page of campaigns with ID, name, dates and goal. Use chmeetings_campaigns_list to find a campaign ID for chmeetings_campaign_pledges_list. Needs the API key scope contributions:read.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_contribution_batches_listList contribution batches.Read-onlyList Contribution Batches
List contribution batches. Returns a page of batches with ID, name, date, status and totals. Use chmeetings_contribution_batches_list to find a batch ID for chmeetings_contribution_create or chmeetings_contributions_list. Needs the API key scope contributions:read.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_contribution_funds_listList giving funds (such as General Fund or Missions), optionally filtered by name or tax-deductibility.Read-onlyList Contribution Funds
List giving funds (such as General Fund or Missions), optionally filtered by name or tax-deductibility. Returns a page of funds with ID, name, default flag and online-giving flag. Use chmeetings_contribution_funds_list to get fund IDs for chmeetings_contribution_create. Use chmeetings_accounting_transactions_list for the general ledger. Needs the API key scope contributions:read.
Inputs
is_tax_deductibleboolean- true returns only tax-deductible funds, false only non-deductible ones. Example: true
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 search_textstring- Text to filter funds by name (contains match). Example: Missions
chmeetings_contributions_listList contributions (donations), filtered by person, date range, batch, reference ID or organization.Read-onlyList Contributions
List contributions (donations), filtered by person, date range, batch, reference ID or organization. Returns a page of contributions with date, giver, amount per fund, payment method and batch. Use chmeetings_contributions_list for giving history. Use chmeetings_campaign_pledges_list for pledges. Needs the API key scope contributions:read.
Inputs
batch_idinteger- Returns only the contributions in this batch. Use the batch id from GET /contributions/batches (the same value returned as batch_id on each contribution), not the batch number. Example: 301
end_datestring- End of the contribution date range. Format: yyyy-MM-dd. Example: 2026-01-31
organization_idstring- Returns only the contributions owned by this organization (the church or one of its ministries). Use an id from GET /organizations. Example: 12345
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 person_idinteger- Only contributions given by this person. Example: 1024567
reference_idstring- Only the contribution with this client reference ID. Example: stripe-ch_3Nx
start_datestring- Start of the contribution date range. Format: yyyy-MM-dd. Example: 2026-01-01
chmeetings_event_getGet one event by ID.Read-onlyGet Event
Get one event by ID. Returns the event's name, description, schedule, location, visibility and image URL. Use chmeetings_event_get when you know the event ID. Use chmeetings_events_list to browse by date. Needs the API key scope events:read.
Inputs
event_idintegerrequired- Event ID, as returned by chmeetings_events_list. Example: 88123
chmeetings_event_occurrences_listList the occurrences (individual dates) of an event within a date range of at most 366 days, both materialized and computed.Read-onlyList Event Occurrences
List the occurrences (individual dates) of an event within a date range of at most 366 days, both materialized and computed. Returns a page of occurrences with ID, date, time and image URL. Use chmeetings_event_occurrences_list to get the occurrence ID needed for attendance and check-in tools. Needs the API key scope events:read.
Inputs
event_idintegerrequired- Event ID, as returned by chmeetings_events_list. Example: 88123
fromstringrequired- Start date for filtering occurrences. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-01-01
tostringrequired- End date for filtering occurrences. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-03-31
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_event_statistics_getGet attendance statistics for an event across a date range of at most 366 days.Read-onlyGet Event Statistics
Get attendance statistics for an event across a date range of at most 366 days. Returns a per-occurrence attendance summary plus a rollup for the period; include=groups adds a per-group breakdown. Use chmeetings_event_statistics_get for attendance trends over time. Use chmeetings_occurrence_attendance_summary_get for a single occurrence. Needs the API key scope events:read.
Inputs
event_idintegerrequired- Event ID, as returned by chmeetings_events_list. Example: 88123
fromstringrequired- Range start date (inclusive). Format: yyyy-MM-dd. Maximum range between 'from' and 'to' is 366 days. Example: 2026-01-01
tostringrequired- Range end date (inclusive). Format: yyyy-MM-dd. Maximum range between 'from' and 'to' is 366 days. Example: 2026-03-31
includestring- Set to groups to include a per-group breakdown inside each occurrence. Example: groups
chmeetings_events_listList events within a date range (at most 366 days).Read-onlyList Events
List events within a date range (at most 366 days). Returns a page of events with ID, name, schedule, visibility and image URL. Use chmeetings_events_list to find events. Use chmeetings_event_occurrences_list for the individual dates of a recurring event. Needs the API key scope events:read.
Inputs
fromstringrequired- Start date for filtering events. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-01-01
tostringrequired- End date for filtering events. Format: yyyy-MM-dd. The maximum allowed range between 'from' and 'to' is 366 days. Example: 2026-03-31
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_families_listList families in the church, optionally filtered by name.Read-onlyList Families
List families in the church, optionally filtered by name. Returns a page of families with their ID and members. Use chmeetings_families_list to find a family. Use chmeetings_family_get to read one family by ID. Needs the API key scope people:read.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 search_textstring- Text to filter families by name (contains match). Example: Smith
chmeetings_family_getGet one family by ID.Read-onlyGet Family
Get one family by ID. Returns the family with each member's person ID, name and family role. Use chmeetings_family_get when you know the family ID. Use chmeetings_families_list to search. Needs the API key scope people:read.
Inputs
family_idintegerrequired- Family ID, as returned by chmeetings_families_list. Example: 9811
chmeetings_family_roles_listList the family roles the church uses (for example primary, spouse, child).Read-onlyList Family Roles
List the family roles the church uses (for example primary, spouse, child). Returns each role's name. Use chmeetings_family_roles_list to pick valid family_role values for chmeetings_family_create and chmeetings_family_members_add. Needs the API key scope people:read.
Inputs
This tool takes no inputs.
chmeetings_follow_up_actions_listList the follow-up actions (categories such as First Visit) the church uses, sorted by name.Read-onlyList Follow-Up Actions
List the follow-up actions (categories such as First Visit) the church uses, sorted by name. Returns each action's ID and name. Use chmeetings_follow_up_actions_list to pick an action_id for chmeetings_follow_up_create. Needs the API key scope follow_ups:read.
Inputs
This tool takes no inputs.
chmeetings_follow_up_assignable_members_listList the people who can be assigned follow-ups, sorted by name.Read-onlyList Assignable Members
List the people who can be assigned follow-ups, sorted by name. Returns a page of people with their person IDs. Use chmeetings_follow_up_assignable_members_list to get valid assignee_ids for chmeetings_follow_up_create. Needs the API key scope follow_ups:read.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_follow_up_getGet one follow-up task by ID.Read-onlyGet Follow-Up
Get one follow-up task by ID. Returns the follow-up's person, assignees, action, date, times, notes, status and completion date. Use chmeetings_follow_up_get before chmeetings_follow_up_update, which replaces every field. Needs the API key scope follow_ups:read.
Inputs
follow_up_idintegerrequired- Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012
chmeetings_follow_ups_listList pastoral follow-up tasks, filtered by status, type, person, assignee, action, date range or text.Read-onlyList Follow-Ups
List pastoral follow-up tasks, filtered by status, type, person, assignee, action, date range or text. Returns a page of follow-ups with person, assignees, action, date and status. Use chmeetings_follow_ups_list to review open tasks. Use chmeetings_follow_up_get to read one by ID. Needs the API key scope follow_ups:read.
Inputs
action_idinteger- Return only follow-ups with this follow-up action (category). Use ids from GET /follow-ups/actions. Example: 12
assignee_idinteger- Return only follow-ups assigned to this person (the responsible person). Example: 1024999
fromstring- Inclusive start of the scheduled-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-01
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 person_idinteger- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
searchstring- Free-text search over the person's name, nickname and mobile number. Example: Smith
statusstring- Filter by status. Omit to return both. One of: pending, done. Example: pendingone of
pendingdone tostring- Inclusive end of the scheduled-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-31
typestring- Filter by follow-up type. Omit to return all types. One of: visit, phone, sms. Example: visitone of
visitphonesms
chmeetings_group_getGet one group by ID.Read-onlyGet Group
Get one group by ID. Returns the group's name, description, privacy, join option and visibility settings. Use chmeetings_group_get when you know the group ID. Use chmeetings_groups_list to search by name. Needs the API key scope groups:read.
Inputs
group_idintegerrequired- Group ID, as returned by chmeetings_groups_list. Example: 4521
chmeetings_group_people_listList the people in one or more groups.Read-onlyList Group People
List the people in one or more groups. Returns the union of the groups' members with their person and group details. Use chmeetings_group_people_list to see who is in a group. Use chmeetings_people_list with group_ids to filter the full people list instead. Needs the API key scope groups:read.
Inputs
group_idsstringrequired- Comma-separated group IDs (for example 123 or 123,456,789); the response is the union of those groups' members. Example: 4521,4522
chmeetings_groups_listList all groups in the church, ordered by name, optionally filtered by name.Read-onlyList Groups
List all groups in the church, ordered by name, optionally filtered by name. The list is not paged. Returns each group's ID, name, description and visibility settings. Use chmeetings_groups_list to find a group ID. Use chmeetings_group_people_list for the members of groups. Needs the API key scope groups:read.
Inputs
search_textstring- Text to filter by name (contains match). Example: Youth
chmeetings_occurrence_attendance_listList the attendance for one event occurrence, optionally only attendees or absentees, or one group.Read-onlyList Occurrence Attendance
List the attendance for one event occurrence, optionally only attendees or absentees, or one group. Returns a page of people with their check-in and check-out times. Use chmeetings_occurrence_attendance_list for who attended. Use chmeetings_occurrence_attendance_summary_get for totals only. Needs the API key scope attendance:read.
Inputs
occurrence_idstringrequired- Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
group_idinteger- Only people in this group. Cannot be combined with ungrouped=true. Example: 4521
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 statusstring- Which people to return: all, attended or absent. One of: all, attended, absent. Example: attendedone of
allattendedabsent ungroupedboolean- If true, returns only ungrouped members. Cannot be combined with group_id. Example: false
chmeetings_occurrence_attendance_summary_getGet attendance totals for one event occurrence.Read-onlyGet Occurrence Attendance Summary
Get attendance totals for one event occurrence. Returns counts of attended and absent people; include=groups adds a per-group breakdown. Use chmeetings_occurrence_attendance_summary_get for headcounts. Use chmeetings_occurrence_attendance_list for names. Needs the API key scope attendance:read.
Inputs
occurrence_idstringrequired- Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
includestring- Set to groups to include a per-group attendance breakdown. Example: groups
chmeetings_occurrence_getGet one event occurrence by ID, materialized or virtual.Read-onlyGet Occurrence
Get one event occurrence by ID, materialized or virtual. Returns the occurrence's event, date, start and end time. Use chmeetings_occurrence_get to check an occurrence before recording attendance. Needs the API key scope events:read.
Inputs
occurrence_idstringrequired- Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
chmeetings_organizations_listList the organizations (church and its ministries) the API key can access.Read-onlyList Organizations
List the organizations (church and its ministries) the API key can access. Returns each organization's ID, name and type. Use chmeetings_organizations_list to get organization IDs for contribution filters. Use chmeetings_person_organizations_list for one person's organizations. Needs only a valid API key.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 search_textstring- Text to filter by name (contains match). Example: Smith
chmeetings_payment_methods_listList contribution payment methods, both system and custom.Read-onlyList Payment Methods
List contribution payment methods, both system and custom. Returns a page of payment methods with ID and name. Use chmeetings_payment_methods_list to get a payment_method_id for chmeetings_contribution_create. Needs the API key scope contributions:read.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 search_textstring- Text to filter payment methods by name (contains match). Example: Check
chmeetings_people_fields_listList the member profile fields configured for the church, including custom (additional) fields and their options.Read-onlyList Member Fields
List the member profile fields configured for the church, including custom (additional) fields and their options. Returns each field's ID, name, type and, for dropdown and checkbox fields, the selectable options. Use chmeetings_people_fields_list before setting additional_fields on chmeetings_person_create or chmeetings_person_update. Needs the API key scope people:read.
Inputs
This tool takes no inputs.
chmeetings_people_listList active people in the church, with filters for name, email, mobile, groups, gender, family role, location and creation date.Read-onlyList People
List active people in the church, with filters for name, email, mobile, groups, gender, family role, location and creation date. Returns a page of people with their profile fields, and optionally their family members, custom fields, organizations and groups. Use chmeetings_people_list to search or browse members. Use chmeetings_person_get to read one person by ID. Needs the API key scope people:read.
Inputs
city_idinteger- Filter by the city of the person's address (the 'city' field of the address object). Narrower than state_id - a state contains many cities. Example: 110992
country_idinteger- Filter by the country of the person's address. Example: 233
created_fromstring- Inclusive start of the profile creation-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-01
created_tostring- Inclusive end of the profile creation-date range (church-local). Format: yyyy-MM-dd. Example: 2026-01-31
do_not_emailboolean- Filter by the email opt-out flag returned as 'do_not_email'. Example: false
do_not_textboolean- Filter by the SMS opt-out flag returned as 'do_not_text'. Example: false
emailstring- Filter by email address (contains match). Example: example.com
family_rolesstring- Comma-separated family roles; matches people in any of them (e.g. "parent" or "parent,child"). Accepted values: primary, spouse, child, parent, sibling, grandparent, other, not_in_family. Omit to match every role. Example: parent,child
gendersstring- Comma-separated genders; matches people of any of them (e.g. "male" or "male,female"). Accepted values: male, female, unknown. Omit to match every gender. Example: male,female
group_idsstring- Comma-separated group IDs; matches people in any of them. Only groups of the current organization are considered. At most 100 IDs. Cannot be combined with ungrouped=true. Example: 4521,4522
has_emailboolean- true returns only people with an email address, false only those without. Omit for both. Example: true
has_mobileboolean- true returns only people with a mobile number, false only those without. Omit for both. Example: true
has_photoboolean- true returns only people with a profile photo, false only those without. Omit for both. Example: false
include_additional_fieldsboolean- Include each person's custom (additional) profile fields. Example: truedefault
true include_family_membersboolean- Include each person's family members in the response. Example: truedefault
true include_groupsboolean- Include each person's groups as a list of id and name. Example: false
include_organizationsboolean- Include the organizations (church, ministries) each person belongs to. Example: falsedefault
false mobilestring- Filter by mobile number (contains match). Example: 5550123
namestring- Filter by name (contains match over the full name and nickname). Example: Smith
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 person_idsstring- Comma-separated person IDs (e.g. "12" or "12,34"). At most 100 IDs. Example: 12,34
state_idinteger- Filter by the state of the person's address (the 'state' field of the address object). Example: 1452
ungroupedboolean- If true, returns only people who belong to no group of the current organization. Cannot be combined with group_ids. Example: false
zip_codestring- Filter by zip/postal code (contains match). Example: 10001
chmeetings_person_getGet one active person in the church by ID.Read-onlyGet Person
Get one active person in the church by ID. Returns the person's profile, contact details, address, family and custom fields. Returns 404 Invalid Person Id when the person does not exist or was deleted, archived, removed, merged or converted to a contact. Use chmeetings_person_get when you know the ID. Use chmeetings_people_list to find someone by name, email or mobile. Needs the API key scope people:read.
Inputs
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_person_notes_listList the public notes recorded on a person's profile.Read-onlyList Person Notes
List the public notes recorded on a person's profile. Returns a page of notes with ID, text, author and date. Use chmeetings_person_notes_list to read a member's notes. Use chmeetings_person_note_create to add one. Needs the API key scope people:read.
Inputs
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_person_organizations_listList the organizations (diocese, church, ministries) a person belongs to, main church first.Read-onlyList Person Organizations
List the organizations (diocese, church, ministries) a person belongs to, main church first. Returns a page of organizations with ID, name and type. Use chmeetings_person_organizations_list for one person's memberships. Use chmeetings_organizations_list for every organization the API key can see. Needs the API key scope people:read.
Inputs
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100
chmeetings_posts_listList news posts, optionally filtered by status and publish date range.Read-onlyList Posts
List news posts, optionally filtered by status and publish date range. Returns a page of posts with ID, title, body, status, visibility, publish date and image URL. Use chmeetings_posts_list to browse announcements. Use chmeetings_post_create to publish a new one. Needs the API key scope posts:read.
Inputs
end_datestring- End of the date range to filter posts, in the church's timezone. Format: yyyy-MM-dd. Posts that carry no publish date at all (drafts, mainly) are returned whatever the range. Example: 2026-01-31
pageinteger- Page number to return, starting at 1. Example: 1default
1 page_sizeinteger- Number of items per page, from 1 to 100. Example: 50default
100 start_datestring- Start of the date range to filter posts, in the church's timezone. Format: yyyy-MM-dd. Posts that carry no publish date at all (drafts, mainly) are returned whatever the range. Example: 2026-01-01
statusstring- Return only posts with this status. Omit to return drafts and published posts together. One of: draft, published. Example: publishedone of
draftpublished
chmeetings_contribution_batch_closeClose a contribution batch so no more contributions can be added.WriteClose Contribution Batch
Close a contribution batch so no more contributions can be added. Returns the updated batch. Use chmeetings_contribution_batch_close once a batch is reconciled. Use chmeetings_contribution_batch_reopen to allow changes again. Needs the API key scope contributions:write.
- Idempotent
Inputs
batch_idintegerrequired- Batch ID, as returned by chmeetings_contribution_batches_list. Example: 301
chmeetings_contribution_batch_createCreate a contribution batch to group gifts, such as one Sunday's offering.WriteCreate Contribution Batch
Create a contribution batch to group gifts, such as one Sunday's offering. Returns the created batch with its ID. Use chmeetings_contribution_batch_create before recording gifts in a batch. Use chmeetings_contribution_batch_close when the batch is complete. Needs the API key scope contributions:write.
Inputs
datestringrequired- Batch date, yyyy-MM-dd. Example: 2026-01-11
namestringrequired- Batch name. Example: Sunday offering 2026-01-11
chmeetings_contribution_batch_reopenReopen a closed contribution batch so contributions can be added again.WriteReopen Contribution Batch
Reopen a closed contribution batch so contributions can be added again. Returns the updated batch. Use chmeetings_contribution_batch_reopen to correct a closed batch. Use chmeetings_contribution_batch_close to close it again. Needs the API key scope contributions:write.
- Idempotent
Inputs
batch_idintegerrequired- Batch ID, as returned by chmeetings_contribution_batches_list. Example: 301
chmeetings_contribution_createRecord a contribution (donation) split across one or more funds.WriteCreate Contribution
Record a contribution (donation) split across one or more funds. Returns the created contribution. Posting a reference_id that already exists is rejected as a duplicate, so retries are safe. Use chmeetings_contribution_create to import a gift. Use chmeetings_contribution_batch_create first if you want to group gifts in a batch. Needs the API key scope contributions:write.
Inputs
datestringrequired- Contribution date, yyyy-MM-dd. Example: 2026-01-11
fundsarrayrequired- How the gift is split: each item needs the fund_name and amount, and may add the fund_id, both from chmeetings_contribution_funds_list. Example: [{"fund_name": "General Fund", "fund_id": 21, "amount": 100.0}]
payment_methodstringrequired- Payment method name, such as Cash, Check or Card. Example: Check
batch_idinteger- ID of the batch to put the contribution in, from chmeetings_contribution_batches_list. Example: 301
batch_numstring- Batch number to put the contribution in, as an alternative to batch_id. Example: 2026-01-11-A
envelope_numberinteger- Giver's envelope number. Example: 118
notestring- Note on the contribution. Example: Building fund pledge payment
payment_method_idinteger- Payment method ID from chmeetings_payment_methods_list. Example: 3
payment_providerstring- Name of the payment provider the gift came through, if any. Example: Stripe
personobject- The giver: either person_id of an existing person, or first_name, last_name and email or mobile to match or create one. Example: {"person_id": 1024567}
reference_idstring- Your unique reference (idempotency key) for this contribution; reusing one is rejected as a duplicate. Example: stripe-ch_3NxA2b
chmeetings_contribution_fund_createCreate a giving fund.WriteCreate Contribution Fund
Create a giving fund. Returns the created fund with its ID. Use chmeetings_contribution_fund_create to add a new designation for gifts. Needs the API key scope contributions:write.
Inputs
namestringrequired- Fund name. Example: Building Fund
allow_for_online_givingboolean- Whether donors can choose this fund on the online giving page. Example: true
is_defaultboolean- Make this the default fund; any existing default is unset. Example: false
is_tax_deductibleboolean- Whether gifts to this fund are tax-deductible. Example: true
chmeetings_family_createCreate a family from existing people; at least two members are required.WriteCreate Family
Create a family from existing people; at least two members are required. Returns the created family with its ID. Use chmeetings_family_create to link people as a household. Use chmeetings_family_members_add to add people to an existing family. Needs the API key scope people:write.
Inputs
membersarrayrequired- Family members, each with a person_id and a family_role (a role name from chmeetings_family_roles_list, such as primary, spouse or child). Example: [{"person_id": 1024567, "family_role": "primary"}, {"person_id": 1024568, "family_role": "spouse"}]
chmeetings_family_members_addAdd people to an existing family.WriteAdd Family Members
Add people to an existing family. Returns the updated family. Use chmeetings_family_members_add to add members. Use chmeetings_family_member_remove to take one out. Needs the API key scope people:write.
Inputs
family_idintegerrequired- Family ID, as returned by chmeetings_families_list. Example: 9811
membersarrayrequired- Family members, each with a person_id and a family_role (a role name from chmeetings_family_roles_list, such as primary, spouse or child). Example: [{"person_id": 1024567, "family_role": "primary"}, {"person_id": 1024568, "family_role": "spouse"}]
chmeetings_follow_up_createCreate a pastoral follow-up task for a person and assign it to one or more people.WriteCreate Follow-Up
Create a pastoral follow-up task for a person and assign it to one or more people. Returns the created follow-up. Assignees with a user account are notified when it is created as pending. Use chmeetings_follow_up_create to schedule a visit, call or text. Use chmeetings_follow_up_update to change one. Needs the API key scope follow_ups:write. Get valid assignee IDs from chmeetings_follow_up_assignable_members_list.
Inputs
assignee_idsarrayrequired- Person IDs of the people responsible for the follow-up, from chmeetings_follow_up_assignable_members_list. At least one is required. Example: [1024999]
datestringrequired- Scheduled date, church-local yyyy-MM-dd. Example: 2026-02-03
person_idintegerrequired- ID of the person to follow up with. Example: 1024567
action_idinteger- Follow-up action (category) ID from chmeetings_follow_up_actions_list. Example: 12
end_timestring- End time on the follow-up date, HH:mm or HH:mm:ss. Required when start_time is set, and not earlier than it. Example: 10:30
notesstring- Free-text notes. Example: Welcome call for first-time visitor.
start_timestring- Start time on the follow-up date, church-local HH:mm or HH:mm:ss. Defaults to 00:00. Example: 10:00
statusstring- pending or done. Defaults to pending. One of: pending, done. Example: pendingone of
pendingdone typestring- How to follow up: visit, phone or sms. Defaults to visit. One of: visit, phone, sms. Example: phoneone of
visitphonesms
chmeetings_follow_up_updateReplace a follow-up's editable fields; omitted action_id and notes are cleared, an omitted type becomes visit and an omitted status becomes pending.WriteUpdate Follow-Up
Replace a follow-up's editable fields; omitted action_id and notes are cleared, an omitted type becomes visit and an omitted status becomes pending. Returns the updated follow-up. Use chmeetings_follow_up_update to reschedule, reassign or mark a follow-up done, after reading it with chmeetings_follow_up_get. Needs the API key scope follow_ups:write.
- Idempotent
Inputs
assignee_idsarrayrequired- Person IDs of the people responsible for the follow-up, from chmeetings_follow_up_assignable_members_list. At least one is required. Example: [1024999]
follow_up_idintegerrequired- Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012
person_idintegerrequired- ID of the person to follow up with. Example: 1024567
action_idinteger- Follow-up action (category) ID from chmeetings_follow_up_actions_list. Example: 12
datestring- Scheduled date, church-local yyyy-MM-dd. Example: 2026-02-03
end_timestring- End time on the follow-up date, HH:mm or HH:mm:ss. Required when start_time is set, and not earlier than it. Example: 10:30
notesstring- Free-text notes. Example: Welcome call for first-time visitor.
start_timestring- Start time on the follow-up date, church-local HH:mm or HH:mm:ss. Defaults to 00:00. Example: 10:00
statusstring- pending or done. Defaults to pending. One of: pending, done. Example: pendingone of
pendingdone typestring- How to follow up: visit, phone or sms. Defaults to visit. One of: visit, phone, sms. Example: phoneone of
visitphonesms
chmeetings_group_createCreate a group (small group, ministry team, class).WriteCreate Group
Create a group (small group, ministry team, class). Returns the created group. Returns 400 when the name is already used. Use chmeetings_group_create to start a new group. Use chmeetings_group_membership_add to add people to it. Needs the API key scope groups:write.
Inputs
namestringrequired- Group name; must be unique within the organization. Example: Youth Group
descriptionstring- Group description; HTML is accepted and stored as given. Example: <p>Teens aged 13 to 18, Fridays at 7pm.</p>
is_chat_enabledboolean- Enable group chat. Requires an active group chat add-on (or a branded mobile app subscription); the request is rejected with 400 otherwise. Example: false
is_group_leaders_visibleboolean- Show the group's leaders in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: true
is_members_visibleboolean- Show the group's members in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: false
is_visible_to_non_membersboolean- Show this group to members who are not in it. Always forced to true when privacy is "public". Only takes effect when privacy is "members" or "public". Example: true
join_request_optionstring- Whether members may request to join: "open", "closed", or "approval_required". Defaults to "closed". One of: open, closed, approval_required. Example: approval_requiredone of
openclosedapproval_required privacystring- Who can see the group: "internal" (visible only to users with access to this feature), "members" (visible in the Member Portal), or "public" (visible to anyone). One of: internal, members, public. Example: membersone of
internalmemberspublic
chmeetings_group_membership_addAdd a person to a group.WriteAdd Person to Group
Add a person to a group. Returns the membership; 201 when it was created, 200 when the person was already a member. Use chmeetings_group_membership_add to enroll someone. Use chmeetings_group_membership_remove to take them out. Needs the API key scope groups:write.
- Idempotent
Inputs
group_idintegerrequired- Group ID, as returned by chmeetings_groups_list. Example: 4521
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_group_updateReplace a group's editable fields; any field left out is reset to its default.WriteUpdate Group
Replace a group's editable fields; any field left out is reset to its default. Returns the updated group. Returns 400 when the name is already used by another group. Use chmeetings_group_update after reading the group with chmeetings_group_get and sending back every field you want to keep. Needs the API key scope groups:write.
- Idempotent
Inputs
group_idintegerrequired- Group ID, as returned by chmeetings_groups_list. Example: 4521
namestringrequired- Group name; must be unique within the organization. Example: Youth Group
descriptionstring- Group description; HTML is accepted and stored as given. Example: <p>Teens aged 13 to 18, Fridays at 7pm.</p>
is_chat_enabledboolean- Enable group chat. Disabling always succeeds. Enabling requires an active group chat add-on (or a branded mobile app subscription) and a group of at most 1000 active members; the request is rejected with 400 otherwise. Example: false
is_group_leaders_visibleboolean- Show the group's leaders in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: true
is_members_visibleboolean- Show the group's members in the Member Portal. Only takes effect when privacy is "members" or "public", and additionally requires the Online Member Directory to be enabled in the account's Member Role settings. Example: false
is_visible_to_non_membersboolean- Show this group to members who are not in it. Always forced to true when privacy is "public". Only takes effect when privacy is "members" or "public". Example: true
join_request_optionstring- Whether members may request to join: "open", "closed", or "approval_required". Defaults to "closed". One of: open, closed, approval_required. Example: approval_requiredone of
openclosedapproval_required privacystring- Who can see the group: "internal" (visible only to users with access to this feature), "members" (visible in the Member Portal), or "public" (visible to anyone). One of: internal, members, public. Example: membersone of
internalmemberspublic
chmeetings_occurrence_check_inCheck a person in to an event occurrence, creating their attendance record.WriteCheck In to Occurrence
Check a person in to an event occurrence, creating their attendance record. Returns the attendance record (201), or the existing record (200) when the person is already checked in. Use chmeetings_occurrence_check_in to record attendance. Use chmeetings_occurrence_check_in_cancel to undo it. Needs the API key scope attendance:write.
- Idempotent
Inputs
occurrence_idstringrequired- Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
person_idintegerrequired- ID of the person to check in, as returned by chmeetings_people_list. Example: 1024567
occurred_atstring- When the check-in happened, as the church's local wall-clock time yyyy-MM-ddTHH:mm:ss with no UTC offset (an offset such as Z is rejected). Defaults to now. Example: 2026-08-09T09:14:23
chmeetings_person_createCreate a person (member profile) in the church.WriteCreate Person
Create a person (member profile) in the church. Returns the created person with their new ID. Use chmeetings_person_create to add a new member. Use chmeetings_person_update to change an existing one. Needs the API key scope people:write.
Inputs
first_namestringrequired- First name. Example: John
last_namestringrequired- Last name. Example: Smith
additional_fieldsarray- Values for the account's custom profile fields, from chmeetings_people_fields_list. Each item gives the field_id, its field_type (text, multi_line_text, number, date, dropdown, checkbox or multiple_choice) and the value: value for text, number and date fields, selected_option_id for dropdown and multiple choice, selected_option_ids for checkbox. Fields left out keep their value. Example: [{"field_id": 12, "field_type": "text", "value": "Choir"}]
addressobject- Postal address with country, state, city, building, address_line, address_line2, floor, flat and zip_code, all as text. On update, send the whole object: leaving it out clears everything except country, state and city. Example: {"country": "United States", "state": "New York", "city": "New York", "address_line": "12 Main St", "zip_code": "10001"}
baptism_datestring- Baptism date as yyyy-MM-dd. Example: 1985-06-01
baptism_locationstring- Where the person was baptized. Example: St. Mark's Church
birth_datestring- Birth date as yyyy-MM-dd. Use the year 1776 when the year is unknown (for example 1776-11-10). Example: 1985-04-12
bishop_donorstring- Bishop donor field, for churches that track it. Example: No
churchstring- Church the person attends, when tracked as a free-text field. Example: St. Mark's
do_not_emailboolean- Set true to opt the person out of email. Example: false
do_not_textboolean- Set true to opt the person out of text messages. Example: false
education_levelstring- Education level. Example: Bachelor's degree
emailstring- Email address. Example: john.smith@example.com
engagement_datestring- Engagement date as yyyy-MM-dd. Example: 2010-05-01
facebookstring- Facebook profile URL or handle. Example: https://facebook.com/john.smith
father_namestring- Father's name. Example: Robert Smith
genderstring- Gender, one of the values returned by GET /api/v1/people/genders (for example Male or Female). Example: Male
gradestring- School grade, one of the values returned by GET /api/v1/people/grade-values. Example: 10
graduation_yearinteger- Graduation year. Example: 2027
is_deaconboolean- Whether the person is a deacon. Example: false
job_titlestring- Job title. Example: Teacher
marriage_datestring- Marriage date as yyyy-MM-dd. Use the year 1776 when the year is unknown. Example: 2011-06-18
middle_namestring- Middle name. Example: Paul
mobilestring- Mobile phone number, preferably in international format. Example: +15555550123
native_namestring- Name in the person's native script, used when Native Name is enabled. Example: Jean Dupont
nick_namestring- Nickname, used when the account has Enable Nickname turned on. Example: Johnny
qualificationstring- Professional qualification. Example: B.Ed.
rankstring- Rank, for churches that track clergy rank. Example: Reader
schoolstring- School the person attends or attended. Example: Lincoln High School
social_statusstring- Marital or social status, one of the values returned by GET /api/v1/people/social-statuses. Example: Married
talents_and_hobbiesstring- Talents and hobbies, free text. Example: Guitar, cooking
telephonestring- Landline telephone number. Example: +15555550100
work_placestring- Employer or place of work. Example: Lincoln High School
chmeetings_person_note_createAdd a note to a person's profile.WriteCreate Person Note
Add a note to a person's profile. Returns the created note with its ID. Use chmeetings_person_note_create to record pastoral or admin notes. Use chmeetings_person_note_update to edit an existing note. Needs the API key scope people:write.
Inputs
notestringrequired- Text of the note. Example: Visited after surgery; family asked for prayers.
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_person_note_updateReplace the text of a note on a person's profile.WriteUpdate Person Note
Replace the text of a note on a person's profile. Returns the updated note. Use chmeetings_person_note_update to correct a note. Use chmeetings_person_note_create to add a new one. Needs the API key scope people:write.
- Idempotent
Inputs
notestringrequired- New text of the note; replaces the existing text. Example: Visited after surgery; recovering well.
note_idintegerrequired- Note ID, as returned by chmeetings_person_notes_list. Example: 7781
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_person_updateReplace a person's profile with the fields you send; this is a full replacement, not a partial update.WriteUpdate Person
Replace a person's profile with the fields you send; this is a full replacement, not a partial update. Returns the updated person. Fields left out are cleared (including email, mobile and birth date), do_not_email and do_not_text become false, and an omitted address loses everything except country, state and city; nickname, native name and custom fields are kept. Use chmeetings_person_update after reading the person with chmeetings_person_get, changing the fields and sending the whole profile back. Needs the API key scope people:write.
- Idempotent
Inputs
first_namestringrequired- First name. Example: John
last_namestringrequired- Last name. Example: Smith
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
additional_fieldsarray- Values for the account's custom profile fields, from chmeetings_people_fields_list. Each item gives the field_id, its field_type (text, multi_line_text, number, date, dropdown, checkbox or multiple_choice) and the value: value for text, number and date fields, selected_option_id for dropdown and multiple choice, selected_option_ids for checkbox. Fields left out keep their value. Example: [{"field_id": 12, "field_type": "text", "value": "Choir"}]
addressobject- Postal address with country, state, city, building, address_line, address_line2, floor, flat and zip_code, all as text. On update, send the whole object: leaving it out clears everything except country, state and city. Example: {"country": "United States", "state": "New York", "city": "New York", "address_line": "12 Main St", "zip_code": "10001"}
baptism_datestring- Baptism date as yyyy-MM-dd. Example: 1985-06-01
baptism_locationstring- Where the person was baptized. Example: St. Mark's Church
birth_datestring- Birth date as yyyy-MM-dd. Use the year 1776 when the year is unknown (for example 1776-11-10). Example: 1985-04-12
bishop_donorstring- Bishop donor field, for churches that track it. Example: No
churchstring- Church the person attends, when tracked as a free-text field. Example: St. Mark's
do_not_emailboolean- Set true to opt the person out of email. Example: false
do_not_textboolean- Set true to opt the person out of text messages. Example: false
education_levelstring- Education level. Example: Bachelor's degree
emailstring- Email address. Example: john.smith@example.com
engagement_datestring- Engagement date as yyyy-MM-dd. Example: 2010-05-01
facebookstring- Facebook profile URL or handle. Example: https://facebook.com/john.smith
father_namestring- Father's name. Example: Robert Smith
genderstring- Gender, one of the values returned by GET /api/v1/people/genders (for example Male or Female). Example: Male
gradestring- School grade, one of the values returned by GET /api/v1/people/grade-values. Example: 10
graduation_yearinteger- Graduation year. Example: 2027
is_deaconboolean- Whether the person is a deacon. Example: false
job_titlestring- Job title. Example: Teacher
marriage_datestring- Marriage date as yyyy-MM-dd. Use the year 1776 when the year is unknown. Example: 2011-06-18
middle_namestring- Middle name. Example: Paul
mobilestring- Mobile phone number, preferably in international format. Example: +15555550123
native_namestring- Name in the person's native script, used when Native Name is enabled. Example: Jean Dupont
nick_namestring- Nickname, used when the account has Enable Nickname turned on. Example: Johnny
qualificationstring- Professional qualification. Example: B.Ed.
rankstring- Rank, for churches that track clergy rank. Example: Reader
schoolstring- School the person attends or attended. Example: Lincoln High School
social_statusstring- Marital or social status, one of the values returned by GET /api/v1/people/social-statuses. Example: Married
talents_and_hobbiesstring- Talents and hobbies, free text. Example: Guitar, cooking
telephonestring- Landline telephone number. Example: +15555550100
work_placestring- Employer or place of work. Example: Lincoln High School
chmeetings_post_createCreate a news post (announcement), as a draft or published, optionally notifying members.WriteCreate Post
Create a news post (announcement), as a draft or published, optionally notifying members. Returns the created post with its ID. Use chmeetings_post_create to share news with members. Use chmeetings_post_update to edit a post. Needs the API key scope posts:write.
Inputs
bodystringrequired- Post content as rich-text HTML. Example: <p>Join us at 9am and 11am on Easter Sunday.</p>
statusstringrequired- draft stores the post unpublished; published makes it live. One of: draft, published. Example: publishedone of
draftpublished titlestringrequired- Post title, at most 500 characters. Example: Easter service times
visibilitystringrequired- Who can see the post: internal (only users with access), members (also members in the Member Portal) or public. One of: internal, members, public. Example: membersone of
internalmemberspublic allow_commentsboolean- Whether members can comment on the post. Example: true
allow_likesboolean- Whether members can like the post. Example: true
category_idsarray- IDs of post categories to assign; every ID must belong to this organization. Example: [2]
notify_membersboolean- Send members a push notification about the post; only takes effect when status is published. Example: false
published_onstring- Publish date in the church's timezone, yyyy-MM-dd (a plain date, not a UTC instant). Example: 2026-04-01
chmeetings_post_updateUpdate a news post; title, body, status and visibility are required and replace the stored values, and category_ids replaces the categories.WriteUpdate Post
Update a news post; title, body, status and visibility are required and replace the stored values, and category_ids replaces the categories. Returns the updated post. Use chmeetings_post_update to edit or publish a draft. Use chmeetings_post_create for a new post. Needs the API key scope posts:write.
- Idempotent
Inputs
bodystringrequired- Post content as rich-text HTML. Example: <p>Join us at 9am and 11am on Easter Sunday.</p>
post_idintegerrequired- Post ID, as returned by chmeetings_posts_list. Example: 812
statusstringrequired- draft stores the post unpublished; published makes it live. One of: draft, published. Example: publishedone of
draftpublished titlestringrequired- Post title, at most 500 characters. Example: Easter service times
visibilitystringrequired- Who can see the post: internal (only users with access), members (also members in the Member Portal) or public. One of: internal, members, public. Example: membersone of
internalmemberspublic allow_commentsboolean- Whether members can comment on the post. Example: true
allow_likesboolean- Whether members can like the post. Example: true
category_idsarray- IDs of post categories to assign; every ID must belong to this organization. Example: [2]
notify_membersboolean- Send members a push notification about the post; only takes effect when status is published. Example: false
published_onstring- Publish date in the church's timezone, yyyy-MM-dd (a plain date, not a UTC instant). Example: 2026-04-01
chmeetings_contribution_deleteDelete a contribution by ID.DestructiveDelete Contribution
Delete a contribution by ID. Returns a confirmation. Use chmeetings_contribution_delete to remove a gift recorded by mistake. Needs the API key scope contributions:delete.
- Idempotent
Inputs
contribution_idintegerrequired- Contribution ID, as returned by chmeetings_contributions_list. Example: 556677
chmeetings_family_member_removeRemove a person from a family; the family must keep at least two members.DestructiveRemove Family Member
Remove a person from a family; the family must keep at least two members. Returns a confirmation. Use chmeetings_family_member_remove to take one person out. Use chmeetings_family_members_add to add people. Needs the API key scope people:write.
- Idempotent
Inputs
family_idintegerrequired- Family ID, as returned by chmeetings_families_list. Example: 9811
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_follow_up_deleteDelete a follow-up task.DestructiveDelete Follow-Up
Delete a follow-up task. Deleting the latest occurrence of a recurring follow-up schedules the next one. Returns a confirmation, or 404 when it does not exist. Use chmeetings_follow_up_delete to cancel a task. Use chmeetings_follow_up_update with status done to complete it instead. Needs the API key scope follow_ups:delete.
- Idempotent
Inputs
follow_up_idintegerrequired- Follow-up ID, as returned by chmeetings_follow_ups_list. Example: 33012
chmeetings_group_deleteDelete a group with all its memberships and leader assignments.DestructiveDelete Group
Delete a group with all its memberships and leader assignments. Returns a confirmation. Returns 400 while the group is still assigned to upcoming events. Use chmeetings_group_delete to remove a group permanently. Use chmeetings_group_membership_remove to remove one person instead. Needs the API key scope groups:delete.
- Idempotent
Inputs
group_idintegerrequired- Group ID, as returned by chmeetings_groups_list. Example: 4521
chmeetings_group_membership_removeRemove a person from a group.DestructiveRemove Person from Group
Remove a person from a group. Returns a confirmation, or 404 when the person is not in the group. Use chmeetings_group_membership_remove to take one person out. Use chmeetings_group_delete to delete the whole group. Needs the API key scope groups:write.
- Idempotent
Inputs
group_idintegerrequired- Group ID, as returned by chmeetings_groups_list. Example: 4521
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_occurrence_check_in_cancelCancel a person's check-in to an event occurrence, removing the attendance record and any check-out.DestructiveCancel Check-In
Cancel a person's check-in to an event occurrence, removing the attendance record and any check-out. Returns a confirmation, or 404 when the person has no active check-in. Use chmeetings_occurrence_check_in_cancel to undo a check-in recorded by mistake. Needs the API key scope attendance:write.
- Idempotent
Inputs
occurrence_idstringrequired- Occurrence ID, as returned by chmeetings_event_occurrences_list. Materialized occurrences have a numeric ID; virtual (not yet materialized) occurrences have a string ID, and both are accepted. Example: 5523411
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_person_deleteDelete a person from the church.DestructiveDelete Person
Delete a person from the church. Returns a confirmation. Sends a person.deleted webhook. Use chmeetings_person_delete only to remove a profile permanently. Use chmeetings_person_update to change details instead. Needs the API key scope people:delete.
- Idempotent
Inputs
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
chmeetings_person_note_deleteDelete a note from a person's profile.DestructiveDelete Person Note
Delete a note from a person's profile. Returns a confirmation. Use chmeetings_person_note_delete to remove a note permanently. Needs the API key scope people:delete.
- Idempotent
Inputs
note_idintegerrequired- Note ID, as returned by chmeetings_person_notes_list. Example: 7781
person_idintegerrequired- ChMeetings person ID, as returned by chmeetings_people_list. Example: 1024567
No tools match.