Update an Attachment

Update information for an attachment. You can update the name, description, and metadata.

Note To update the attachment file, remove the existing attachment and upload a new attachment.

Endpoint

PUT /v1/attachments/{attachmentId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

attachmentId REQUIRED

string (UUID)

ID of the attachment.

Request Body

name

string, max length: 40

Name of the attachment.

description

string, max length: 1000

Description of the attachment.

metadata

string, max properties: 6, value max length: 1024

Key/value pairs used to store additional information about the attachment.

Returns

Returns the Attachment object. This object contains the attachment details, including the attachment ID and status.

SAMPLE REQUEST

				
					{
  "name": "Contract",
  "description": "contract",
  "metadata": {
    "type": "contract"
  }
}

SAMPLE RESPONSE

				
					{
  "businessAccountId": "e8800f5a-26a9-4435-8fec-5fc47126d1cb",
  "entityId": "c924605d-0c65-446f-8f36-1db31df6e80a",
  "entityType": "CUSTOMER",
  "name": "Contract",
  "description": "contract",
  "metadata": {
    "type": "contract"
  },
  "createdBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "createdAt": "2024-06-20T17:13:43.181Z",
  "updatedBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "updatedAt": "2024-06-20T17:14:43.181Z",
  "id": "22e27516-f2b9-469c-a204-15a963e37753",
  "status": "SCANNED",
  "extension": "PDF"
}