CAcardda
Company settings

Update company settings

Updates the self-service company settings. Only requires_refund_document, review_reminder_cadence and external_notification_preferences are writable — the review-reminder age guardrails (review_reminder_max_age_days / review_reminder_min_age_days) are server-side and cannot be changed here.

patch/v1/companies/{company_id}/company_settings

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/companies/{company_id}/company_settings
  • Auth
    HTTP bearer

Path parameters

company_idstring uuid required

The UUID of the company the nested resource belongs to.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Request body

requires_refund_documentboolean
review_reminder_cadence'disabled' | 'daily' | 'weekly' | 'monthly'
external_notification_preferencesobject

Response

The updated company settings.

idstring uuid required
company_idstring uuid required
requires_refund_documentboolean

Whether reimbursements must carry a supporting document.

review_reminder_cadence'disabled' | 'daily' | 'weekly' | 'monthly'

Cadence for the "pending review" reminder. Only the cadence is self-service; the age guardrails (review_reminder_max_age_days / review_reminder_min_age_days) are server-side and not client-editable.

review_reminder_max_age_daysinteger

Server-side guardrail (read-only). Oldest transaction age still reminded about.

review_reminder_min_age_daysinteger

Server-side guardrail (read-only). Youngest transaction age reminded about.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.