---
title: "Complete Attachment Upload"
method: PATCH
path: "/finalize/v2/agreements/{agreement_id}/attachments/{attachment_id}"
tags: ["Finalize Attachments"]
---

# Complete Attachment Upload

`PATCH /finalize/v2/agreements/{agreement_id}/attachments/{attachment_id}`

## Request

- Base URL: `https://api.linksquares.com/api`
- URL: `https://api.linksquares.com/api/finalize/v2/agreements/{agreement_id}/attachments/{attachment_id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/linksquares/apis/linksquares-api/docs/finalize/v2/agreements/:agreement_id/attachments/:attachment_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `agreement_id` string, uuid, required
- `attachment_id` string, uuid, required

## Request body

- object
  - `data` object, required
    - `upload_complete` boolean, required: For attachment creation, patch this field as `true` when the attachment file has been uploaded.

## Response `200`

ok

- object
  - `data` object, required
    - `id` string, uuid, required: The UUID of the attachment record.
    - `created_at` string, date-time, required: The ISO 8601 datetime of when the attachment was created.
    - `file_name` string, nullable, required: The name of the attachment file. Expected to be null if file has not been uploaded yet.

## Other responses

- `404`: not_found
- `422`: unprocessable_entity

---

[API](https://skmtc.dev/linksquares/apis/linksquares-api.md) - [All operations](https://skmtc.dev/linksquares/apis/linksquares-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linksquares/apis/linksquares-api/revisions/4d597e83cd78?raw)
