> ## 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. # Save preferences from a signed email link > The signed token scopes the email address and organization. With only token, a category link opts out of its source category; a legacy link stops all email. Explicit changes apply only the named categories. Individual account_security changes are forbidden, and category links cannot disable all email. restore_all_email is exclusive of individual changes/disable_all_email; disable_all_email cannot be combined with enabling categories. SMS/postal changes are rejected. Restore clears stored opt-outs while donor/form suppression remains. ## OpenAPI ````yaml post /unsubscribe 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: /unsubscribe: post: tags: - Communications summary: Save preferences from a signed email link description: >- The signed token scopes the email address and organization. With only token, a category link opts out of its source category; a legacy link stops all email. Explicit changes apply only the named categories. Individual account_security changes are forbidden, and category links cannot disable all email. restore_all_email is exclusive of individual changes/disable_all_email; disable_all_email cannot be combined with enabling categories. SMS/postal changes are rejected. Restore clears stored opt-outs while donor/form suppression remains. operationId: communicationsDonorUnsubscribeConfirm requestBody: description: Validated request fields for this operation. required: true content: application/json: schema: required: - token properties: token: description: 'Token. Validation: required, string, max:4096.' type: string maxLength: 4096 example: signed-link-token disable_email_categories: description: 'Disable email categories. Validation: sometimes, array.' type: array items: description: >- Disable email categories item. Validation: string, max:100. type: string maxLength: 100 enum: - marketing - receipts_tax - payment_issues - sponsorship_updates - events_fundraising - messages - files_photos - other_updates example: marketing enable_email_categories: description: 'Enable email categories. Validation: sometimes, array.' type: array items: description: 'Enable email categories item. Validation: string, max:100.' type: string maxLength: 100 enum: - marketing - receipts_tax - payment_issues - sponsorship_updates - events_fundraising - messages - files_photos - other_updates example: marketing disable_sms: description: >- Accepted only as false; true is rejected because this signed link controls email only. type: boolean example: true disable_postal_mail: description: >- Accepted only as false; true is rejected because this signed link controls email only. type: boolean example: true disable_all_email: description: 'Disable all email. Validation: sometimes, boolean.' type: boolean example: true restore_all_email: description: 'Restore all email. Validation: sometimes, boolean.' type: boolean example: true type: object responses: '200': description: Operation result. content: application/json: schema: properties: message: type: string example: Email preferences saved. organization: properties: name: description: Serialized value. type: string example: Example nullable: false logo: type: string format: uri nullable: true type: object tokens: properties: accent: type: string example: '#4f46e5' on_accent: type: string example: '#ffffff' link: type: string example: '#4f46e5' type: object source_category_key: type: string enum: - marketing - account_security - receipts_tax - payment_issues - sponsorship_updates - events_fundraising - messages - files_photos - other_updates - null example: marketing nullable: true legacy_link: description: True for a whole-email legacy signed link. type: boolean example: true email_categories: type: array items: 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 requires_disable_warning: description: Enabled state. type: boolean example: true 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 type: object '404': description: The signed link is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: >- Conflicting choices, invalid categories or unsupported channel changes. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' '429': description: The confirmation rate limit was reached. security: [] components: schemas: NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found 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 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.