> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Change load document type > Change the document type of a file already attached to a load, for example after classifying an upload that arrived without the right type. Change the type Alvys files a **load** document under. Use it when a document was uploaded with the wrong type, or when a workflow classifies a file after it was attached and needs to write that classification back. The document keeps its id, its file and its download link. Only the type changes, and the change is recorded in the load's document history. ### Which documents belong here Only the load's **own** documents. [List load documents](/en/api/reference/loads/list-load-documents) also returns the documents of the load's trips, so check `ParentType` on the row first: | `ParentType` | Where to change it | | ------------ | ------------------------------------------------------------------------------------------------------------ | | `Load` | This endpoint, using the load number. | | `Trip` | [Change trip document type](/en/api/reference/trips/change-trip-document-type), using that row's `ParentId`. | Sending a trip document here returns `404`. ### Request Parameters | Parameter | In | Type | Required | Description | | ---------- | ---- | ------ | -------- | --------------------------------------------------------- | | version | path | String | Yes | API version to use. | | loadNumber | path | String | Yes | Unique load number. | | documentId | path | String | Yes | `id` of the document, as returned by List load documents. | ### Request Body | Name | Type | Required | Description | | ------------ | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- | | DocumentType | string | Yes | The type to set. Must be one of the allowed types below. Matched without case sensitivity and stored in Alvys' own casing. | ### Allowed document types * Customer Rate and Load Confirmation * Customer Load Confirmation * Customer Rate Confirmation * Signed Customer Rate Confirmation * Proof of Delivery * Proof of Pickup * Bill of Lading * Shipping Labels Anything outside this list returns `400`. The list is the same one [Upload load document](/en/api/reference/loads/upload-load-document) accepts, so you cannot reach a type by changing a document that you could not have uploaded in the first place. ### Documents that cannot be changed Invoice documents are refused with `422`. Alvys billing, factoring and settlement look these up **by their type**, so changing one would quietly detach it from the invoice it belongs to, and the type cannot be set back through this API. This covers Invoice, Customer Invoice, Supplemental Invoice, Summary Invoice, Summary Excel, Merged, Merged Invoice and Carrier Invoice. ### Example cURL Request ```bash theme={null} curl --location --request PATCH 'https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/documents/{documentId}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "DocumentType": "Proof of Delivery" }' ``` ### Example Response (200 OK) The updated document. ```json theme={null} { "id": "c2e418d5-3125-4b14-b6b0-dcf77b0c2a93", "AttachmentPath": "scan-1759237626.pdf", "AttachmentType": "Proof of Delivery", "AttachmentSize": 342115, "UploadedAt": "2025-09-30T14:02:07+00:00", "ParentId": "3022258", "ParentType": "Load", "UploadedBy": "7190175eecc1101e11d1111f1e1e0e11" } ``` ### Errors | Status | Meaning | | ------ | ------------------------------------------------------------------------------------------------------- | | `400` | `DocumentType` is missing, unrecognised, or not allowed on a load. | | `404` | The load or the document does not exist, is deleted, or the document belongs to a trip or another load. | | `422` | The document is an invoice type and cannot be changed. | ### Repeat calls Calling this endpoint again is **not** free. Each call re-runs the change, and setting a document to Proof of Delivery sends it to the customer's visibility integration every time. Call it once per classification, and only when the type is actually changing. *** ### Rate Limits All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the [Rate Limits](/en/api/guides/rate-limits) section. *** ### Try It Out This page is interactive, allowing you to try a request by specifying the **API version**, **loadNumber** and **documentId** in the URL path. ⚠️ Don't forget: make sure to **authorize yourself** before trying a request. ## OpenAPI ````yaml PATCH /api/p/v{version}/loads/{loadNumber}/documents/{documentId} openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Subsidiaries description: >- List your company's subsidiaries and read a single subsidiary, so an integration can resolve a subsidiary id to a recognizable name. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Tracking description: >- Record an asset's current location or telemetry from a third-party source, such as an external ELD or a self-reporting vehicle. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. - name: Accessorials - name: Credits paths: /api/p/v{version}/loads/{loadNumber}/documents/{documentId}: patch: tags: - Loads summary: Change load document type description: >- Change the document type of a file already attached to a load. Only the load's own documents can be changed here: List load documents also returns the documents of the load's trips (ParentType "Trip"), and those are changed through Change trip document type. Allowed document types: Customer Rate and Load Confirmation, Customer Load Confirmation, Customer Rate Confirmation, Signed Customer Rate Confirmation, Proof of Delivery, Proof of Pickup, Bill of Lading, Shipping Labels. Invoice documents cannot be changed. parameters: - name: loadNumber in: path required: true schema: type: string - name: documentId in: path required: true schema: type: string - name: version in: path description: API version (e.g., 2.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json: schema: $ref: >- #/components/schemas/Alvys.Models.Documents.DocumentTypeChangeRequest text/json: schema: $ref: >- #/components/schemas/Alvys.Models.Documents.DocumentTypeChangeRequest application/*+json: schema: $ref: >- #/components/schemas/Alvys.Models.Documents.DocumentTypeChangeRequest application/json-patch+json: schema: $ref: >- #/components/schemas/Alvys.Models.Documents.DocumentTypeChangeRequest required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Alvys.Models.PublicAPI.AttachmentResponse' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Documents.DocumentTypeChangeRequest: required: - DocumentType type: object properties: DocumentType: minLength: 1 type: string description: >- The document type to set. Must be one the endpoint's parent accepts, spelled exactly as listed in the endpoint description. Matched without case sensitivity and stored in Alvys' own casing. additionalProperties: false Alvys.Models.PublicAPI.AttachmentResponse: required: - AttachmentPath - AttachmentType - id - ParentId - ParentType type: object properties: id: type: string AttachmentPath: type: string AttachmentType: type: string AttachmentSize: type: integer format: int64 nullable: true UploadedAt: type: string format: date-time nullable: true ParentId: type: string ParentType: type: string UploadedBy: type: string nullable: true DownloadUrl: type: string nullable: true ExpiresAt: type: string format: date-time nullable: true additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````