Church

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this church.

Responses

200Success

application/json

get

/api/church/{id}

GET /api/church/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "updated_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this church.

Responses

204

No response body

delete

/api/church/{id}

DELETE /api/church/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this church.

Body

idstring · uuidRead-onlyOptional

prayer_request_reviewersstringRead-onlyOptional

testimony_reviewersstringRead-onlyOptional

follow_up_managersstringRead-onlyOptional

follow_up_departmentstringRead-onlyOptional

feestringRead-onlyOptional

stripe_public_keystringRead-onlyOptional

failed_invoice_paymentstringRead-onlyOptional

template_variablesstringRead-onlyOptional

user_countstringRead-onlyOptional

free_trial_days_leftstringRead-onlyOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 100Optional

emailstring · email · max: 254Optional

phonestringOptional

short_codestring · nullableOptional

websitestring · uri · max: 200 · nullableOptional

timezonestring · max: 3 · nullableOptional

currencystring · max: 3Optional

urlstring · uri · max: 200Optional

address_1string · nullableOptional

address_2string · nullableOptional

citystring · nullableOptional

statestring · nullableOptional

zipstring · nullableOptional

countrystring · nullableOptional

country_codestring · nullableOptional

socialsany · nullableOptional

celebration_typesany · nullableOptional

packagestring · enumOptional

1-100 - 1-100
101-300 - 101-300
301-500 - 301-500
501-1000 - 501-1000
1001-2500 - 1001-2500
2501-5000 - 2501-5000
5001-10000 - 5001-10000
10000+ - 10000+

Possible values:

default_processorone of · nullableOptional

string · enumOptional

stripe - Stripe
raise_the_money - Raise The Money
authorize.net - Authorize.net

Possible values:

undefined · enumOptionalPossible values:

processorsanyOptional

processor_statusanyOptional

prayer_request_restrictionbooleanOptional

prayer_request_push_notificationsbooleanOptional

prayer_request_push_notification_subjectstringOptional

prayer_request_push_notification_bodystringOptional

testimony_restrictionbooleanOptional

testimony_push_notificationsbooleanOptional

testimony_push_notification_subjectstringOptional

testimony_push_notification_bodystringOptional

child_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

teenager_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

portal_logostring · nullableOptional

mobile_logostring · nullableOptional

landing_logostring · nullableOptional

statement_logostring · nullableOptional

primary_colorstring · max: 100 · nullableOptional

secondary_colorstring · max: 100 · nullableOptional

dark_mode_colorstring · max: 100 · nullableOptional

youtube_channel_idstring · nullableOptional

testimony_story_lifetimeinteger · min: -2147483648 · max: 2147483647Optional

enable_give_module_on_landing_pagebooleanOptional

enable_check_in_module_on_landing_pagebooleanOptional

enable_rsvp_module_on_landing_pagebooleanOptional

rsvp_labelstring · max: 100 · nullableOptional

enable_livestream_module_on_landing_pagebooleanOptional

user_portal_default_theme_is_darkbooleanOptional

admin_portal_default_theme_is_darkbooleanOptional

mobile_portal_default_theme_is_darkbooleanOptional

allow_users_switch_themebooleanOptional

allow_users_change_session_durationbooleanOptional

allow_geo_based_check_inbooleanOptional

pastor_namestring · max: 100 · nullableOptional

pastor_titlestring · max: 100 · nullableOptional

pastor_hub_app_codestring · max: 100 · nullableOptional

pastor_phonestring · max: 100 · nullableOptional

allow_users_set_spousebooleanOptional

allow_users_unset_spousebooleanOptional

allow_users_with_same_envelope_idbooleanOptional

maximum_number_users_with_same_envelope_idinteger · min: -2147483648 · max: 2147483647Optional

house_fellowship_name_labelstring · max: 100 · nullableOptional

house_fellowship_zone_labelstring · max: 100 · nullableOptional

house_fellowship_district_labelstring · max: 100 · nullableOptional

auto_response_text_messagestring · nullableOptional

auto_response_text_message_updated_atstring · date-time · nullableOptional

subscribe_text_messagestring · nullableOptional

subscribe_text_message_updated_atstring · date-time · nullableOptional

unsubscribe_text_messagestring · nullableOptional

unsubscribe_text_message_updated_atstring · date-time · nullableOptional

credit_totalinteger · min: -2147483648 · max: 2147483647Optional

child_badge_printingbooleanOptional

child_sms_check_in_notificationsbooleanOptional

child_email_check_in_notificationsbooleanOptional

child_push_notification_check_in_notificationsbooleanOptional

child_receive_featurebooleanOptional

child_mobile_app_check_inbooleanOptional

child_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

child_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

child_kids_app_codestring · max: 100 · nullableOptional

teenager_badge_printingbooleanOptional

teenager_sms_check_in_notificationsbooleanOptional

teenager_email_check_in_notificationsbooleanOptional

teenager_push_notification_check_in_notificationsbooleanOptional

teenager_receive_featurebooleanOptional

teenager_mobile_app_check_inbooleanOptional

teenager_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

teenager_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

teenager_kids_app_codestring · max: 100 · nullableOptional

follow_up_reminder_timeinteger · min: -2147483648 · max: 2147483647Optional

allow_testimony_sharingbooleanOptional

allow_testimony_sharing_to_othersbooleanOptional

contribution_statement_durationinteger · min: -2147483648 · max: 2147483647Optional

contribution_update_windowinteger · min: -2147483648 · max: 2147483647Optional

allow_contribution_type_changebooleanOptional

contribution_notification_usersanyOptional

contribution_minimum_amountinteger · min: -2147483648 · max: 2147483647Optional

contribution_maximum_amountinteger · min: -2147483648 · max: 2147483647Optional

cyclestring · enumOptional

yearly - yearly
monthly - monthly

Possible values:

android_app_urlstring · max: 255 · nullableOptional

ios_app_urlstring · max: 255 · nullableOptional

app_onboarding_screensanyOptional

app_namestring · max: 100 · nullableOptional

has_appbooleanOptional

auto_deductbooleanOptional

stripe_customer_idstring · max: 100 · nullableOptional

quick_actionsany · nullableOptional

explore_modulesany · nullableOptional

external_linksany · nullableOptional

statusstring · enumOptional

active - active
inactive - inactive
suspended - suspended

Possible values:

enable_give_modulebooleanOptional

enable_unified_communications_modulebooleanOptional

Responses

200Success

application/json

patch

/api/church/{id}

PATCH /api/church/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4328

{
  "locations": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "give_methods": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "updated_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

route_actionstringRequiredPattern: ^(positions|salutations)$

Responses

200Success

application/json

get

/api/church/{route_action}

GET /api/church/{route_action} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "updated_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

route_actionstringRequiredPattern: ^(positions|salutations)$

Body

idstring · uuidRead-onlyRequired

prayer_request_reviewersstringRead-onlyRequired

testimony_reviewersstringRead-onlyRequired

follow_up_managersstringRead-onlyRequired

follow_up_departmentstringRead-onlyRequired

feestringRead-onlyRequired

stripe_public_keystringRead-onlyRequired

failed_invoice_paymentstringRead-onlyRequired

template_variablesstringRead-onlyRequired

user_countstringRead-onlyRequired

free_trial_days_leftstringRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 100Required

emailstring · email · max: 254Required

phonestringRequired

short_codestring · nullableOptional

websitestring · uri · max: 200 · nullableOptional

timezonestring · max: 3 · nullableOptional

currencystring · max: 3Optional

urlstring · uri · max: 200Required

address_1string · nullableOptional

address_2string · nullableOptional

citystring · nullableOptional

statestring · nullableOptional

zipstring · nullableOptional

countrystring · nullableOptional

country_codestring · nullableOptional

socialsany · nullableOptional

celebration_typesany · nullableOptional

packagestring · enumOptional

1-100 - 1-100
101-300 - 101-300
301-500 - 301-500
501-1000 - 501-1000
1001-2500 - 1001-2500
2501-5000 - 2501-5000
5001-10000 - 5001-10000
10000+ - 10000+

Possible values:

default_processorone of · nullableOptional

string · enumOptional

stripe - Stripe
raise_the_money - Raise The Money
authorize.net - Authorize.net

Possible values:

undefined · enumOptionalPossible values:

processorsanyOptional

processor_statusanyOptional

prayer_request_restrictionbooleanOptional

prayer_request_push_notificationsbooleanOptional

prayer_request_push_notification_subjectstringOptional

prayer_request_push_notification_bodystringOptional

testimony_restrictionbooleanOptional

testimony_push_notificationsbooleanOptional

testimony_push_notification_subjectstringOptional

testimony_push_notification_bodystringOptional

child_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

teenager_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

portal_logostring · nullableOptional

mobile_logostring · nullableOptional

landing_logostring · nullableOptional

statement_logostring · nullableOptional

primary_colorstring · max: 100 · nullableOptional

secondary_colorstring · max: 100 · nullableOptional

dark_mode_colorstring · max: 100 · nullableOptional

youtube_channel_idstring · nullableOptional

testimony_story_lifetimeinteger · min: -2147483648 · max: 2147483647Optional

enable_give_module_on_landing_pagebooleanOptional

enable_check_in_module_on_landing_pagebooleanOptional

enable_rsvp_module_on_landing_pagebooleanOptional

rsvp_labelstring · max: 100 · nullableOptional

enable_livestream_module_on_landing_pagebooleanOptional

user_portal_default_theme_is_darkbooleanOptional

admin_portal_default_theme_is_darkbooleanOptional

mobile_portal_default_theme_is_darkbooleanOptional

allow_users_switch_themebooleanOptional

allow_users_change_session_durationbooleanOptional

allow_geo_based_check_inbooleanOptional

pastor_namestring · max: 100 · nullableOptional

pastor_titlestring · max: 100 · nullableOptional

pastor_hub_app_codestring · max: 100 · nullableOptional

pastor_phonestring · max: 100 · nullableOptional

allow_users_set_spousebooleanOptional

allow_users_unset_spousebooleanOptional

allow_users_with_same_envelope_idbooleanOptional

maximum_number_users_with_same_envelope_idinteger · min: -2147483648 · max: 2147483647Optional

house_fellowship_name_labelstring · max: 100 · nullableOptional

house_fellowship_zone_labelstring · max: 100 · nullableOptional

house_fellowship_district_labelstring · max: 100 · nullableOptional

auto_response_text_messagestring · nullableOptional

auto_response_text_message_updated_atstring · date-time · nullableOptional

subscribe_text_messagestring · nullableOptional

subscribe_text_message_updated_atstring · date-time · nullableOptional

unsubscribe_text_messagestring · nullableOptional

unsubscribe_text_message_updated_atstring · date-time · nullableOptional

credit_totalinteger · min: -2147483648 · max: 2147483647Optional

child_badge_printingbooleanOptional

child_sms_check_in_notificationsbooleanOptional

child_email_check_in_notificationsbooleanOptional

child_push_notification_check_in_notificationsbooleanOptional

child_receive_featurebooleanOptional

child_mobile_app_check_inbooleanOptional

child_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

child_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

child_kids_app_codestring · max: 100 · nullableOptional

teenager_badge_printingbooleanOptional

teenager_sms_check_in_notificationsbooleanOptional

teenager_email_check_in_notificationsbooleanOptional

teenager_push_notification_check_in_notificationsbooleanOptional

teenager_receive_featurebooleanOptional

teenager_mobile_app_check_inbooleanOptional

teenager_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

teenager_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

teenager_kids_app_codestring · max: 100 · nullableOptional

follow_up_reminder_timeinteger · min: -2147483648 · max: 2147483647Optional

allow_testimony_sharingbooleanOptional

allow_testimony_sharing_to_othersbooleanOptional

contribution_statement_durationinteger · min: -2147483648 · max: 2147483647Optional

contribution_update_windowinteger · min: -2147483648 · max: 2147483647Optional

allow_contribution_type_changebooleanOptional

contribution_notification_usersanyOptional

contribution_minimum_amountinteger · min: -2147483648 · max: 2147483647Optional

contribution_maximum_amountinteger · min: -2147483648 · max: 2147483647Optional

cyclestring · enumOptional

yearly - yearly
monthly - monthly

Possible values:

android_app_urlstring · max: 255 · nullableOptional

ios_app_urlstring · max: 255 · nullableOptional

app_onboarding_screensanyOptional

app_namestring · max: 100 · nullableOptional

has_appbooleanOptional

auto_deductbooleanOptional

stripe_customer_idstring · max: 100 · nullableOptional

quick_actionsany · nullableOptional

explore_modulesany · nullableOptional

external_linksany · nullableOptional

statusstring · enumOptional

active - active
inactive - inactive
suspended - suspended

Possible values:

enable_give_modulebooleanOptional

enable_unified_communications_modulebooleanOptional

Responses

200Success

application/json

post

/api/church/{route_action}

POST /api/church/{route_action} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4328

{
  "locations": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "give_methods": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "updated_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

route_actionstringRequiredPattern: ^(positions|salutations)$

Responses

204

No response body

delete

/api/church/{route_action}

DELETE /api/church/{route_action} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

route_actionstringRequiredPattern: ^(positions|salutations)$

Body

idstring · uuidRead-onlyOptional

prayer_request_reviewersstringRead-onlyOptional

testimony_reviewersstringRead-onlyOptional

follow_up_managersstringRead-onlyOptional

follow_up_departmentstringRead-onlyOptional

feestringRead-onlyOptional

stripe_public_keystringRead-onlyOptional

failed_invoice_paymentstringRead-onlyOptional

template_variablesstringRead-onlyOptional

user_countstringRead-onlyOptional

free_trial_days_leftstringRead-onlyOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 100Optional

emailstring · email · max: 254Optional

phonestringOptional

short_codestring · nullableOptional

websitestring · uri · max: 200 · nullableOptional

timezonestring · max: 3 · nullableOptional

currencystring · max: 3Optional

urlstring · uri · max: 200Optional

address_1string · nullableOptional

address_2string · nullableOptional

citystring · nullableOptional

statestring · nullableOptional

zipstring · nullableOptional

countrystring · nullableOptional

country_codestring · nullableOptional

socialsany · nullableOptional

celebration_typesany · nullableOptional

packagestring · enumOptional

1-100 - 1-100
101-300 - 101-300
301-500 - 301-500
501-1000 - 501-1000
1001-2500 - 1001-2500
2501-5000 - 2501-5000
5001-10000 - 5001-10000
10000+ - 10000+

Possible values:

default_processorone of · nullableOptional

string · enumOptional

stripe - Stripe
raise_the_money - Raise The Money
authorize.net - Authorize.net

Possible values:

undefined · enumOptionalPossible values:

processorsanyOptional

processor_statusanyOptional

prayer_request_restrictionbooleanOptional

prayer_request_push_notificationsbooleanOptional

prayer_request_push_notification_subjectstringOptional

prayer_request_push_notification_bodystringOptional

testimony_restrictionbooleanOptional

testimony_push_notificationsbooleanOptional

testimony_push_notification_subjectstringOptional

testimony_push_notification_bodystringOptional

child_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

teenager_maximum_ageinteger · min: -2147483648 · max: 2147483647Optional

portal_logostring · nullableOptional

mobile_logostring · nullableOptional

landing_logostring · nullableOptional

statement_logostring · nullableOptional

primary_colorstring · max: 100 · nullableOptional

secondary_colorstring · max: 100 · nullableOptional

dark_mode_colorstring · max: 100 · nullableOptional

youtube_channel_idstring · nullableOptional

testimony_story_lifetimeinteger · min: -2147483648 · max: 2147483647Optional

enable_give_module_on_landing_pagebooleanOptional

enable_check_in_module_on_landing_pagebooleanOptional

enable_rsvp_module_on_landing_pagebooleanOptional

rsvp_labelstring · max: 100 · nullableOptional

enable_livestream_module_on_landing_pagebooleanOptional

user_portal_default_theme_is_darkbooleanOptional

admin_portal_default_theme_is_darkbooleanOptional

mobile_portal_default_theme_is_darkbooleanOptional

allow_users_switch_themebooleanOptional

allow_users_change_session_durationbooleanOptional

allow_geo_based_check_inbooleanOptional

pastor_namestring · max: 100 · nullableOptional

pastor_titlestring · max: 100 · nullableOptional

pastor_hub_app_codestring · max: 100 · nullableOptional

pastor_phonestring · max: 100 · nullableOptional

allow_users_set_spousebooleanOptional

allow_users_unset_spousebooleanOptional

allow_users_with_same_envelope_idbooleanOptional

maximum_number_users_with_same_envelope_idinteger · min: -2147483648 · max: 2147483647Optional

house_fellowship_name_labelstring · max: 100 · nullableOptional

house_fellowship_zone_labelstring · max: 100 · nullableOptional

house_fellowship_district_labelstring · max: 100 · nullableOptional

auto_response_text_messagestring · nullableOptional

auto_response_text_message_updated_atstring · date-time · nullableOptional

subscribe_text_messagestring · nullableOptional

subscribe_text_message_updated_atstring · date-time · nullableOptional

unsubscribe_text_messagestring · nullableOptional

unsubscribe_text_message_updated_atstring · date-time · nullableOptional

credit_totalinteger · min: -2147483648 · max: 2147483647Optional

child_badge_printingbooleanOptional

child_sms_check_in_notificationsbooleanOptional

child_email_check_in_notificationsbooleanOptional

child_push_notification_check_in_notificationsbooleanOptional

child_receive_featurebooleanOptional

child_mobile_app_check_inbooleanOptional

child_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

child_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

child_kids_app_codestring · max: 100 · nullableOptional

teenager_badge_printingbooleanOptional

teenager_sms_check_in_notificationsbooleanOptional

teenager_email_check_in_notificationsbooleanOptional

teenager_push_notification_check_in_notificationsbooleanOptional

teenager_receive_featurebooleanOptional

teenager_mobile_app_check_inbooleanOptional

teenager_drop_off_timeinteger · min: -2147483648 · max: 2147483647Optional

teenager_cancel_check_ininteger · min: -2147483648 · max: 2147483647Optional

teenager_kids_app_codestring · max: 100 · nullableOptional

follow_up_reminder_timeinteger · min: -2147483648 · max: 2147483647Optional

allow_testimony_sharingbooleanOptional

allow_testimony_sharing_to_othersbooleanOptional

contribution_statement_durationinteger · min: -2147483648 · max: 2147483647Optional

contribution_update_windowinteger · min: -2147483648 · max: 2147483647Optional

allow_contribution_type_changebooleanOptional

contribution_notification_usersanyOptional

contribution_minimum_amountinteger · min: -2147483648 · max: 2147483647Optional

contribution_maximum_amountinteger · min: -2147483648 · max: 2147483647Optional

cyclestring · enumOptional

yearly - yearly
monthly - monthly

Possible values:

android_app_urlstring · max: 255 · nullableOptional

ios_app_urlstring · max: 255 · nullableOptional

app_onboarding_screensanyOptional

app_namestring · max: 100 · nullableOptional

has_appbooleanOptional

auto_deductbooleanOptional

stripe_customer_idstring · max: 100 · nullableOptional

quick_actionsany · nullableOptional

explore_modulesany · nullableOptional

external_linksany · nullableOptional

statusstring · enumOptional

active - active
inactive - inactive
suspended - suspended

Possible values:

enable_give_modulebooleanOptional

enable_unified_communications_modulebooleanOptional

Responses

200Success

application/json

patch

/api/church/{route_action}

PATCH /api/church/{route_action} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4328

{
  "locations": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "give_methods": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T03:19:22.079Z",
      "updated_at": "2026-02-17T03:19:22.079Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T03:19:22.079Z",
      "restored_at": "2026-02-17T03:19:22.079Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:19:22.079Z",
  "updated_at": "2026-02-17T03:19:22.079Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T03:19:22.079Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}

PreviousTeachers NextCelebration wall