> ## 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. # Apply selected relationship-provisioning candidates > Requires stewardship_relationship_groups_v1 and unrestricted donor-form visibility. Revalidates the exact preview fingerprint and applies 1–100 available candidate keys independently; failures are reported per candidate and successful accounts are retained. Requires permission: donors_view; plus one of manage_settings, access_account_settings; plus one of donors_manage. ## OpenAPI ````yaml post /admin/fundraising/relationship-provisioning/apply 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: /admin/fundraising/relationship-provisioning/apply: post: tags: - Fundraising summary: Apply selected relationship-provisioning candidates description: >- Requires stewardship_relationship_groups_v1 and unrestricted donor-form visibility. Revalidates the exact preview fingerprint and applies 1–100 available candidate keys independently; failures are reported per candidate and successful accounts are retained. Requires permission: donors_view; plus one of manage_settings, access_account_settings; plus one of donors_manage. operationId: fundraisingHubApplyRelationshipProvisioning requestBody: description: Validated request fields for this operation. required: true content: application/json: schema: required: - fingerprint - candidate_keys properties: fingerprint: description: >- Fingerprint. Validation: required, string, size:64, regex:/^[a-f0-9]{64}$/. type: string maxLength: 64 minLength: 64 pattern: ^[a-f0-9]{64}$ example: >- aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa candidate_keys: description: 'Candidate keys. Validation: required, array, min:1, max:100.' type: array items: description: >- Candidate keys item. Validation: required, string, max:191, distinct. type: string maxLength: 191 example: Candidate Keys.* maxItems: 100 minItems: 1 uniqueItems: true type: object responses: '200': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: $ref: '#/components/schemas/FundraisingHubProvisioningApply' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The authenticated user lacks access to this workflow or its related records. '404': description: The selected organization record or required feature is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: >- Request, policy, source relationship, lifecycle or selection validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: FundraisingHubProvisioningApply: properties: created_count: description: Count. type: integer example: 2 nullable: false failed_count: description: Count. type: integer example: 2 nullable: false created: type: array items: $ref: '#/components/schemas/FundraisingHubRelationshipGroup' failed: type: array items: properties: candidate_key: description: Serialized value. type: string example: Example nullable: true message: description: Serialized value. type: string example: Example nullable: true type: object preview: $ref: '#/components/schemas/FundraisingHubProvisioningPreview' 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 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 FundraisingHubRelationshipGroup: description: >- Active relationship group. Detailed reads add missing expected attribution; detail giving-vehicle links add legal giving totals; mutations may include committed projection/owner warnings. properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false kind: type: string enum: - family_fund - business_family - organization example: family_fund display_name: description: Serialized value. type: string example: Example nullable: false core_subject_type: type: string enum: - donor - household example: donor core_subject_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false representative_donor_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false assigned_fundraiser_user_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true is_active: description: Workflow state. type: boolean example: true origin: type: string enum: - manual - rule example: manual provisioning_key: description: Serialized value. type: string example: Example nullable: true provisioning_evidence: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} core_members: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true type: object links: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true link_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false role: type: string enum: - giving_vehicle - relationship_lead - designated_contact - affiliated_contact example: giving_vehicle giving_scope: type: string enum: - none - attributed_only - all_qualified example: attributed_only expects_attribution: description: Workflow state. type: boolean example: true is_primary_contact: description: Workflow state. type: boolean example: true collapse_in_portfolio: description: Workflow state. type: boolean example: true relationship_label: description: Serialized value. type: string example: Example nullable: true legal_lifetime_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_ytd_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_gift_count: description: Count. type: integer example: 2 nullable: false type: object data_quality: properties: core_available: description: Workflow state. type: boolean example: true core_issue: description: Serialized value. type: string example: Example nullable: true count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false gift_amount: description: Amount or percentage. type: number example: 25 nullable: false items: type: array items: properties: donation_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false date: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true amount: description: Amount or percentage. type: number example: 25 nullable: false missing_attribution_amount: description: Amount or percentage. type: number example: 25 nullable: false existing_attribution_amount: description: Amount or percentage. type: number example: 25 nullable: false currency: description: Serialized value. type: string example: Example nullable: true legal_donor_name: description: Serialized value. type: string example: Example nullable: true type: object type: object current_donor_role: description: Present in for-donor relationship responses. type: string example: Example nullable: true current_link_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true warnings: type: array items: properties: code: description: Serialized value. type: string example: Example nullable: true message: description: Serialized value. type: string example: Example nullable: false type: object type: object FundraisingHubProvisioningPreview: properties: enabled: description: Workflow state. type: boolean example: true policy_version: description: Count. type: integer example: 2 nullable: false default_giving_scope: description: Serialized value. type: string example: Example nullable: true fingerprint: description: >- SHA-256 of policy, candidates and evidence; return unchanged when applying. type: string maxLength: 64 minLength: 64 example: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa summary: properties: total: description: Count. type: integer example: 2 nullable: false returned: description: Count. type: integer example: 2 nullable: false selected: description: Count. type: integer example: 2 nullable: false review: description: Count. type: integer example: 2 nullable: false needs_mapping: description: Count. type: integer example: 2 nullable: false blocked: description: Count. type: integer example: 2 nullable: false already_active: description: Count. type: integer example: 2 nullable: false deactivated: description: Count. type: integer example: 2 nullable: false type: object candidates: type: array items: $ref: '#/components/schemas/FundraisingHubProvisioningCandidate' truncated: description: Workflow state. type: boolean example: true selection_limited: description: Workflow state. type: boolean example: true selection_limit: description: Count. type: integer example: 2 nullable: false 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 FundraisingHubProvisioningCandidate: properties: candidate_key: description: Serialized value. type: string example: Example nullable: false status: type: string enum: - available - already_active - deactivated - blocked - needs_mapping example: available confidence: type: string enum: - high - review example: high recommended_action: type: string enum: - create - review - add_mapping - none example: create selected_by_default: description: Workflow state. type: boolean example: true blockers: type: array items: type: string core: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false name: description: Serialized value. type: string example: Example nullable: true subject_type: type: string enum: - donor - household example: donor type: object additionalProperties: {} mapped_vehicles: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true rule_keys: type: array items: type: string relationship_evidence: type: array items: properties: forward_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false reverse_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false core_relationship_type: description: Serialized value. type: string example: Example nullable: true vehicle_relationship_type: description: Serialized value. type: string example: Example nullable: true type: object soft_credit: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} giving_scope: description: Serialized value. type: string example: Example nullable: true type: object additionalProperties: {} evidence_only_vehicles: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true rule_keys: type: array items: type: string relationship_evidence: type: array items: properties: forward_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false reverse_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false core_relationship_type: description: Serialized value. type: string example: Example nullable: true vehicle_relationship_type: description: Serialized value. type: string example: Example nullable: true type: object soft_credit: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} giving_scope: description: Serialized value. type: string example: Example nullable: true type: object additionalProperties: {} mapped_vehicle_count: description: Count. type: integer example: 2 nullable: false evidence_only_vehicle_count: description: Count. type: integer example: 2 nullable: false giving_scope: description: Serialized value. type: string example: Example nullable: true evidence: properties: rule_keys: type: array items: type: string relationship_evidence: type: array items: type: object additionalProperties: {} soft_credit: properties: gift_count: description: Count. type: integer example: 2 nullable: false attributed_amount: description: Amount or percentage. type: number example: 25 nullable: false soft_credit_type_keys: type: array items: type: string policy_basis: type: array items: type: string type: object type: object proposed_group: properties: kind: description: Serialized value. type: string example: Example nullable: true display_name: description: Serialized value. type: string example: Example nullable: true core_subject_type: description: Serialized value. type: string example: Example nullable: true core_subject_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false assigned_fundraiser_user_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true links: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true link_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false role: type: string enum: - giving_vehicle - relationship_lead - designated_contact - affiliated_contact example: giving_vehicle giving_scope: type: string enum: - none - attributed_only - all_qualified example: attributed_only expects_attribution: description: Workflow state. type: boolean example: true is_primary_contact: description: Workflow state. type: boolean example: true collapse_in_portfolio: description: Workflow state. type: boolean example: true relationship_label: description: Serialized value. type: string example: Example nullable: true legal_lifetime_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_ytd_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_gift_count: description: Count. type: integer example: 2 nullable: false type: object type: object type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.