Skip to content
DonorIntel Knowledge Base

Patch My Tenant Settings

PATCH
/v1/tenants/my-tenant/settings

Update tenant settings. Admin only. EIN and webhook secret are stored encrypted.

Request Body required

Section titled “Request Body required ”
TenantSettingsUpdate
object
default_timezone
Any of:
string
default_currency
Any of:
string
<= 8 characters
fiscal_year_start_month
Any of:
integer
>= 1 <= 12
date_format
Any of:
DateFormat
string
Allowed values: MM/DD/YYYY DD/MM/YYYY YYYY-MM-DD
number_format_locale
Any of:
string
language
Any of:
string
treat_pledges_as_receivable
Any of:
boolean
default_gift_type
Any of:
DefaultGiftType
string
Allowed values: cash check stock in_kind crypto wire
soft_credit_enabled
Any of:
boolean
matching_gift_tracking
Any of:
boolean
daf_gift_handling
Any of:
DafGiftHandling
string
Allowed values: soft_credit anonymous org_defined
in_kind_valuation_method
Any of:
InKindValuationMethod
string
Allowed values: donor_stated appraised fair_market cost_basis
stock_gift_valuation_date
Any of:
StockGiftValuationDate
string
Allowed values: receipt_date sale_date average_of_both
duplicate_gift_window_days
Any of:
integer
gift_entry_requires_approval
Any of:
boolean
gift_approval_threshold_amount
Any of:
number
anonymous_gift_display_name
Any of:
string
auto_acknowledge_gifts
Any of:
boolean
receipt_minimum_amount
Any of:
number
tax_receipt_legal_text
Any of:
string
ein_tax_id
Any of:
string
receipt_delivery_method
Any of:
ReceiptDeliveryMethod
string
Allowed values: email postal both none
annual_giving_statement_month
Any of:
integer
>= 1 <= 12
pledge_reminder_days_before
Any of:
integer
overdue_pledge_grace_period_days
Any of:
integer
recurring_gift_retry_attempts
Any of:
integer
recurring_gift_retry_interval_days
Any of:
integer
lapsed_recurring_threshold_days
Any of:
integer
lapsed_donor_threshold_months
Any of:
integer
major_gift_threshold_amount
Any of:
number
mid_level_gift_threshold_amount
Any of:
number
prospect_score_model
Any of:
ProspectScoreModel
string
Allowed values: rfm ml_model manual_only off
household_giving_rollup
Any of:
boolean
tribute_gift_enabled
Any of:
boolean
unsubscribe_handling
Any of:
UnsubscribeHandling
string
Allowed values: all_email marketing_only channel_specific
gdpr_mode_enabled
Any of:
boolean
data_retention_years
Any of:
integer
>= 1
donor_self_service_portal
Any of:
boolean
donor_portal_url_slug
Any of:
string
event_registration_tax_receipt
Any of:
EventRegistrationTaxReceipt
string
Allowed values: net_charitable full_amount none
campaign_goal_display
Any of:
CampaignGoalDisplay
string
Allowed values: amount_raised donor_count percent_to_goal all
default_campaign_duration_days
Any of:
integer
>= 1
mfa_required_for_staff
Any of:
boolean
session_timeout_minutes
Any of:
integer
>= 15
payment_processor
Any of:
PaymentProcessor
string
Allowed values: stripe authorize_net braintree square
webhook_secret_key
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response[TenantSettingsRead]
object
data
required
TenantSettingsRead
object
id
required
Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
tenant_id
required
Tenant Id
string format: uuid
updated_by
required
Any of:
string
default_timezone
required
Default Timezone
string
default_currency
required
Default Currency
string
fiscal_year_start_month
required
Fiscal Year Start Month
integer
date_format
required
Date Format
string
number_format_locale
required
Number Format Locale
string
language
required
Language
string
treat_pledges_as_receivable
required
Treat Pledges As Receivable
boolean
default_gift_type
required
Default Gift Type
string
soft_credit_enabled
required
Soft Credit Enabled
boolean
matching_gift_tracking
required
Matching Gift Tracking
boolean
daf_gift_handling
required
Daf Gift Handling
string
in_kind_valuation_method
required
In Kind Valuation Method
string
stock_gift_valuation_date
required
Stock Gift Valuation Date
string
duplicate_gift_window_days
required
Duplicate Gift Window Days
integer
gift_entry_requires_approval
required
Gift Entry Requires Approval
boolean
gift_approval_threshold_amount
required
Gift Approval Threshold Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
anonymous_gift_display_name
required
Anonymous Gift Display Name
string
auto_acknowledge_gifts
required
Auto Acknowledge Gifts
boolean
receipt_minimum_amount
required
Receipt Minimum Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
tax_receipt_legal_text
required
Any of:
string
has_ein_tax_id
required
Has Ein Tax Id
boolean
receipt_delivery_method
required
Receipt Delivery Method
string
annual_giving_statement_month
required
Annual Giving Statement Month
integer
pledge_reminder_days_before
required
Pledge Reminder Days Before
integer
overdue_pledge_grace_period_days
required
Overdue Pledge Grace Period Days
integer
recurring_gift_retry_attempts
required
Recurring Gift Retry Attempts
integer
recurring_gift_retry_interval_days
required
Recurring Gift Retry Interval Days
integer
lapsed_recurring_threshold_days
required
Lapsed Recurring Threshold Days
integer
lapsed_donor_threshold_months
required
Lapsed Donor Threshold Months
integer
major_gift_threshold_amount
required
Major Gift Threshold Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
mid_level_gift_threshold_amount
required
Mid Level Gift Threshold Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prospect_score_model
required
Prospect Score Model
string
household_giving_rollup
required
Household Giving Rollup
boolean
tribute_gift_enabled
required
Tribute Gift Enabled
boolean
unsubscribe_handling
required
Unsubscribe Handling
string
gdpr_mode_enabled
required
Gdpr Mode Enabled
boolean
data_retention_years
required
Data Retention Years
integer
donor_self_service_portal
required
Donor Self Service Portal
boolean
donor_portal_url_slug
required
Any of:
string
event_registration_tax_receipt
required
Event Registration Tax Receipt
string
campaign_goal_display
required
Campaign Goal Display
string
default_campaign_duration_days
required
Default Campaign Duration Days
integer
mfa_required_for_staff
required
Mfa Required For Staff
boolean
session_timeout_minutes
required
Session Timeout Minutes
integer
payment_processor
required
Payment Processor
string
has_webhook_secret_key
required
Has Webhook Secret Key
boolean
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object