> ## 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. # Record a stewardship Work completion > Requires readable Work/donor scope. Logs a manual interaction and acknowledges eligible selected gifts. For handwritten_card, supply an existing order or draft fields; unaccepted/practice cards return pending_submission and leave work/gifts incomplete until live acceptance. Replays preserve interaction and gift selection. Other channels record work already performed; this operation does not send email or SMS. The Handwrytten feature is required only for channel=handwritten_card or a supplied handwrytten_order_id. Requires permission: donors_view; plus one of donors_manage, donations, interactions_manage, mailings_generate, mailings_manage, manage_email. ## OpenAPI ````yaml post /admin/handwrytten/work-items/{workItemId}/complete 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/handwrytten/work-items/{workItemId}/complete: post: tags: - Fundraising summary: Record a stewardship Work completion description: >- Requires readable Work/donor scope. Logs a manual interaction and acknowledges eligible selected gifts. For handwritten_card, supply an existing order or draft fields; unaccepted/practice cards return pending_submission and leave work/gifts incomplete until live acceptance. Replays preserve interaction and gift selection. Other channels record work already performed; this operation does not send email or SMS. The Handwrytten feature is required only for channel=handwritten_card or a supplied handwrytten_order_id. Requires permission: donors_view; plus one of donors_manage, donations, interactions_manage, mailings_generate, mailings_manage, manage_email. operationId: stewardshipHandwryttenCompleteWorkItem parameters: - name: workItemId in: path description: Workitem id in the current organization. required: true schema: type: integer example: 42 requestBody: description: Validated request fields for this operation. required: true content: application/json: schema: required: - channel properties: channel: description: >- Channel. Validation: required, string; allowed values: call, text, sms, email, note, meeting, handwritten_card, letter, mailing. type: string enum: - call - text - sms - email - note - meeting - handwritten_card - letter - mailing example: call donor_id: description: 'Donor id. Validation: nullable, integer.' type: integer example: 1 nullable: true handwrytten_order_id: description: >- Existing order belonging to the work action contact, or omit and supply a handwrytten draft for handwritten_card. type: integer example: 1 nullable: true donation_ids: description: >- Eligible gifts for this stewardship relationship. Direct gifts are acknowledged; relationship soft-credit gifts may be retained as completion evidence only. Replays must preserve the selection. type: array items: description: 'Donation ids item. Validation: integer.' type: integer example: 1 nullable: true subject: description: 'Subject. Validation: nullable, string, max:255.' type: string maxLength: 255 example: Subject nullable: true note: description: 'Note. Validation: nullable, string, max:10000.' type: string maxLength: 10000 example: Discuss the next update with the program team. nullable: true body_plain: description: 'Body plain. Validation: nullable, string, max:10000.' type: string maxLength: 10000 example: Body Plain nullable: true body_visibility: description: >- Body visibility. Validation: nullable, string; allowed values: private, metadata, shared, team. type: string enum: - private - metadata - shared - team - null example: private nullable: true outcome: description: 'Outcome. Validation: nullable, string, max:64.' type: string maxLength: 64 example: Outcome nullable: true direction: description: >- Direction. Validation: nullable, string; allowed values: inbound, outbound, internal, none. type: string enum: - inbound - outbound - internal - none - null example: inbound nullable: true duration_minutes: description: >- Duration minutes. Validation: nullable, integer, min:1, max:1440. type: integer maximum: 1440 minimum: 1 example: 1 nullable: true follow_up_at: description: 'Follow up at. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true counts_as_touch: description: 'Counts as touch. Validation: nullable, boolean.' type: boolean example: true nullable: true shared_group_id: description: >- Shared group id. Validation: required_if:body_visibility,shared, nullable, integer. type: integer example: 1 nullable: true occurred_at: description: 'Occurred at. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true idempotency_key: description: 'Idempotency key. Validation: nullable, string, max:191.' type: string maxLength: 191 example: Idempotency Key nullable: true handwrytten: description: 'Handwrytten. Validation: nullable, array.' properties: generated_mailing_id: description: >- Handwrytten / generated mailing id. Validation: nullable, integer. type: integer example: 1 nullable: true rule_id: description: 'Handwrytten / rule id. Validation: nullable, integer.' type: integer example: 1 nullable: true account_mode: description: >- Handwrytten / account mode. Validation: nullable, string; allowed values: hys_managed, partner_owned. type: string enum: - hys_managed - partner_owned - null example: hys_managed nullable: true card_vendor_id: description: >- Handwrytten / card vendor id. Validation: nullable, string, max:128. type: string maxLength: 128 example: Handwrytten.Card Vendor Id nullable: true card_name: description: >- Handwrytten / card name. Validation: nullable, string, max:255. type: string maxLength: 255 example: Handwrytten.Card Name nullable: true font_label: description: >- Handwrytten / font label. Validation: nullable, string, max:255. type: string maxLength: 255 example: Handwrytten.Font Label nullable: true insert_vendor_id: description: >- Handwrytten / insert vendor id. Validation: nullable, string, max:128. type: string maxLength: 128 example: Handwrytten.Insert Vendor Id nullable: true message_template: description: >- Handwrytten / message template. Validation: nullable, string. type: string example: Handwrytten.Message Template nullable: true message: description: 'Handwrytten / message. Validation: nullable, string.' type: string example: Handwrytten.Message nullable: true merge_data: description: 'Handwrytten / merge data. Validation: nullable, array.' type: array items: {} nullable: true recipient_address: oneOf: - $ref: '#/components/schemas/StewardshipHandwryttenAddress' - type: string enum: - null nullable: true sender_address: oneOf: - $ref: '#/components/schemas/StewardshipHandwryttenAddress' - type: string enum: - null nullable: true program_id: description: 'Handwrytten / program id. Validation: nullable, integer.' type: integer example: 1 nullable: true campaign_key: description: >- Handwrytten / campaign key. Validation: nullable, string, max:128. type: string maxLength: 128 example: Handwrytten.Campaign Key nullable: true requested_send_date: description: >- Handwrytten / requested send date. Validation: nullable, date. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object nullable: true type: object responses: '200': description: Operation result. content: application/json: schema: properties: data: $ref: '#/components/schemas/StewardshipHandwryttenCompletion' 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 organization-owned order, recipient, Work item or source record is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '409': description: Relationship mutation lock is busy; retry after 15 seconds. '422': description: >- Provider readiness, source, state, payment or request validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: StewardshipHandwryttenAddress: description: >- Postal address snapshot. Country representations must agree with the active catalog; state/province is required for supported countries that require it. properties: first_name: description: Postal address field. type: string example: Example nullable: true last_name: description: Postal address field. type: string example: Example nullable: true name: description: Postal address field. type: string example: Example nullable: true address1: description: Postal address field. type: string example: Example nullable: true address2: description: Postal address field. type: string example: Example nullable: true street: description: Postal address field. type: string example: Example nullable: true address_line2: description: Postal address field. type: string example: Example nullable: true city: description: Postal address field. type: string example: Example nullable: true state: description: Postal address field. type: string example: Example nullable: true province: description: Postal address field. type: string example: Example nullable: true zip: description: Postal address field. type: string example: Example nullable: true postal_code: description: Postal address field. type: string example: Example nullable: true country: description: Postal address field. type: string example: Example nullable: true country_code: description: Postal address field. type: string example: Example nullable: true country_id: description: >- Provider country identifier, resolved against the active organization catalog. oneOf: - type: integer example: 1 - type: string example: '1' - type: string enum: - null nullable: true type: object additionalProperties: {} StewardshipHandwryttenCompletion: description: >- A handwritten draft does not complete the work or acknowledge gifts until a live provider acceptance. Replays return the existing interaction and no new acknowledgement. properties: completion_status: type: string enum: - completed - pending_submission example: pending_submission work_item: description: >- Serialized work-item model; includes stored source, readiness and lifecycle attributes. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true subject_type: description: Stored value. type: string example: Example nullable: true subject_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true action_contact_donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true work_item_type: description: Stored value. type: string example: Example nullable: true status: description: Stored value. type: string example: Example nullable: true acted_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true acted_by_user_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true context: description: Stored extensible JSON. oneOf: - type: object additionalProperties: {} - type: array items: {} - type: string enum: - null nullable: true lifecycle: type: array items: description: Stored extensible JSON. nullable: false oneOf: - type: object additionalProperties: {} - type: array items: {} type: object additionalProperties: {} interaction: description: >- Serialized manual Activity model; null while awaiting live handwritten submission. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false client_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true owner_user_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true type: description: Stored value. type: string example: Example nullable: true subject: description: Stored value. type: string example: Example nullable: true body_plain: description: Stored value. type: string example: Example nullable: true body_visibility: description: Stored value. type: string example: Example nullable: true source: type: string example: manual occurred_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true provider_metadata: description: Stored extensible JSON. oneOf: - type: object additionalProperties: {} - type: array items: {} - type: string enum: - null nullable: true type: object nullable: true additionalProperties: {} acknowledgement: properties: updated_count: description: Count or cent amount. type: integer example: 100 nullable: false items: type: array items: properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false acknowledged_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true acknowledged_by_user_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true acknowledgement_source: description: Stored value. type: string example: Example nullable: true type: object type: object nullable: true handwrytten_order: $ref: '#/components/schemas/StewardshipHandwryttenCompletionOrder' 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 StewardshipHandwryttenCompletionOrder: description: >- Serialized completion order model rather than the customer order projection. Hidden credential, raw vendor request/response and provider cost attributes remain excluded. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: true donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true generated_mailing_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true mailing_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true fundraising_work_item_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true status: description: Stored value. type: string example: Example nullable: true approval_status: description: Stored value. type: string example: Example nullable: true vendor_order_id: description: Stored value. type: string example: Example nullable: true vendor_status: description: Stored value. type: string example: Example nullable: true card_name: description: Stored value. type: string example: Example nullable: true card_vendor_id: description: Stored value. type: string example: Example nullable: true font_label: description: Stored value. type: string example: Example nullable: true insert_vendor_id: description: Stored value. type: string example: Example nullable: true message_resolved: description: Stored value. type: string example: Example nullable: true submitted_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true requested_send_date: description: Requested mailing date. type: string format: date example: '2026-10-20' nullable: true recipient_address_snapshot_json: $ref: '#/components/schemas/StewardshipHandwryttenAddress' governance_flags_json: description: Stored governance, pending completion and completion evidence. oneOf: - type: object additionalProperties: {} - type: array items: {} - type: string enum: - null nullable: true account_mode: type: string enum: - hys_managed - partner_owned example: hys_managed provider_test_mode: description: Workflow state. type: boolean example: true sender_address_snapshot_json: $ref: '#/components/schemas/StewardshipHandwryttenAddress' proof_snapshot_json: description: Resolved text, tokens, warnings and merge safety. oneOf: - type: object additionalProperties: {} - type: array items: {} - type: string enum: - null nullable: true customer_price_cents: description: Count or cent amount. type: integer example: 100 nullable: true wallet_reserved_cents: description: Count or cent amount. type: integer example: 100 nullable: false wallet_spent_cents: description: Count or cent amount. type: integer example: 100 nullable: false wallet_refunded_cents: description: Count or cent amount. type: integer example: 100 nullable: false created_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object nullable: true additionalProperties: {} 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 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.