> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Update donor portal notification preferences > Requires a valid donor session and client-owned program or none context. Saves catalog category/event overrides atomically with channel choices. Valid email categories are returned by GET; email event changes are mirrored to donor records sharing the address. Account access cannot be disabled individually. sms_opt_out=true opts matching records out; false does not grant SMS consent. restore_all_email clears stored email opt-outs and event overrides while donor/form master suppression remains unless do_not_email is separately cleared. Postal changes apply to every matching donor. ## OpenAPI ````yaml put /frontend/donor/dashboard/notification-preferences/{client_id}/{program_id}/{session_id} openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /frontend/donor/dashboard/notification-preferences/{client_id}/{program_id}/{session_id}: put: tags: - Communications summary: Update donor portal notification preferences description: >- Requires a valid donor session and client-owned program or none context. Saves catalog category/event overrides atomically with channel choices. Valid email categories are returned by GET; email event changes are mirrored to donor records sharing the address. Account access cannot be disabled individually. sms_opt_out=true opts matching records out; false does not grant SMS consent. restore_all_email clears stored email opt-outs and event overrides while donor/form master suppression remains unless do_not_email is separately cleared. Postal changes apply to every matching donor. operationId: communicationsDonorNotificationPreferenceUpdate parameters: - name: client_id in: path description: Client id in the current organization. required: true schema: type: integer example: 42 - name: program_id in: path description: >- Organization program id, or none for the global donor portal context. required: true schema: type: string pattern: ^(none|[1-9][0-9]*)$ example: none - name: session_id in: path description: Opaque donor session id issued by portal login. required: true schema: type: string example: donor-session-id requestBody: description: Validated request fields for this operation. required: false content: application/json: schema: properties: preferences: type: array items: required: - category_key - channel properties: category_key: type: string enum: - marketing - account_security - receipts_tax - payment_issues - sponsorship_updates - events_fundraising - messages - files_photos - other_updates example: marketing event_key: description: >- A catalog event key or * for the whole category; defaults *. type: string example: '*' channel: type: string enum: - email example: email enabled: description: Required unless reset/default is true. type: boolean example: true reset: description: Delete the saved override; defaults false. type: boolean example: true default: description: Alias for reset. type: boolean example: true type: object anyOf: - required: - enabled - required: - reset properties: reset: type: boolean enum: - true type: object - required: - default properties: default: type: boolean enum: - true type: object postal_mail_enabled: description: 'Postal mail enabled. Validation: sometimes, boolean.' type: boolean example: true sms_opt_out: description: 'Sms opt out. Validation: sometimes, boolean.' type: boolean example: true restore_all_email: description: 'Restore all email. Validation: sometimes, boolean.' type: boolean example: true do_not_email: description: 'Do not email. Validation: sometimes, boolean.' type: boolean example: true type: object responses: '200': description: Operation result. content: application/json: schema: properties: message: type: string example: Notification preferences saved. audience: type: string enum: - donor example: donor catalog: type: array items: $ref: >- #/components/schemas/CommunicationsNotificationCatalogCategory communication: $ref: >- #/components/schemas/CommunicationsDonorPortalCommunicationState type: object '401': description: The donor session or organization program context is invalid. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: >- A category/event/channel/value is invalid or account access was disabled. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: [] components: schemas: CommunicationsNotificationCatalogCategory: properties: key: type: string enum: - marketing - account_security - receipts_tax - payment_issues - sponsorship_updates - events_fundraising - messages - files_photos - other_updates example: marketing label: description: Serialized value. type: string example: Example nullable: false description: description: Serialized value. type: string example: Example nullable: false criticality: type: string enum: - standard - security - transactional - recommended example: standard requires_disable_warning: description: Enabled state. type: boolean example: true channels: type: array items: type: string enum: - email example: email enabled: type: object additionalProperties: description: Enabled state. type: boolean example: true mappings: properties: novu_templates: type: array items: type: string activity_actions: type: array items: type: string type: object events: type: array items: properties: key: description: Serialized value. type: string example: Example nullable: false label: description: Serialized value. type: string example: Example nullable: false channels: type: array items: type: string enum: - email example: email enabled: type: object additionalProperties: description: Enabled state. type: boolean example: true novu_workflow: description: Serialized value. type: string example: Example nullable: true mappings: properties: email_triggers: type: array items: type: string novu_event_types: type: array items: type: string novu_templates: type: array items: type: string activity_actions: type: array items: type: string type: object type: object type: object CommunicationsDonorPortalCommunicationState: properties: email_categories: type: object additionalProperties: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' saved_email_categories: type: object additionalProperties: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' sms: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' saved_sms: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' postal_mail: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' saved_postal_mail: $ref: '#/components/schemas/CommunicationsDeliveryPreferenceState' do_not_email: description: Enabled state. type: boolean example: true type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object RequestRejection: description: >- Request or workflow rejection. Framework field-validation failures contain errors; semantic rejections may contain message without errors; legacy/provider failures may use error and error_code. The operation description identifies the rejected condition. Domain responses may add current revision, limits or other conflict context. anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' - required: - error properties: error: description: Legacy or provider-facing error message. type: string example: The request could not be completed. error_code: description: Stable domain error code, when provided. type: string example: WORKFLOW_UNAVAILABLE type: object CommunicationsDeliveryPreferenceState: description: >- Effective delivery state. events and partially_enabled appear when applicable; null blocked_reason can accompany an opt-out. properties: enabled: description: Enabled state. type: boolean example: true events: type: object additionalProperties: description: Enabled state. type: boolean example: true partially_enabled: description: Enabled state. type: boolean example: true blocked_code: type: string example: category_opt_out nullable: true blocked_reason: type: string example: All donor email is turned off. nullable: true type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.