Replace a lease document's PDF

Swaps in a new PDF for an existing lease document, keeping the document, its signers and its boxes. The uploadSessionId comes from the document's file upload-session endpoint.

PUT

https://api.portal.magicdoor.com/company-app/lease-documents/{leaseDocumentId}/file

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

leaseDocumentIdstringrequired

The document whose file you are replacing. A Snowflake id, sent as a decimal string.

example: 1842019384756201984

Body

application/json

uploadSessionIdstringrequired

The upload session the new PDF was sent to. A Snowflake id, sent as a decimal string.

Response

200 · The document, pointing at the new PDF.

idstring

Id of the lease document. A Snowflake id, sent as a decimal string.

portfolioIdstring

Portfolio the lease rolls up to. A Snowflake id, sent as a decimal string.

propertyIdstring

Property the lease is on. A Snowflake id, sent as a decimal string.

unitIdstring

Unit the lease is on. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease the document belongs to. A Snowflake id, sent as a decimal string.

leaseTemplateIdsstring[]

The lease templates the document was built from.

fileIdstring

The stored PDF. A Snowflake id, sent as a decimal string.

namestring

Name of the document.

statusenum<string>

Where the document stands: draft while it is being prepared, pendingSignatures once it has gone out, completed once everyone has signed, retracted if it was pulled back.

draftpendingSignaturescompletedretracted

typeenum<string>

Whether this is a lease document or a lease renewal document.

leaseleaseRenewal

signersLeaseDocumentSigner[]

Who has to sign, and how far each of them has got.

annotationsLeaseDocumentAnnotation[]

The boxes placed on the PDF — signatures, initials, dates and filled-in values.

fileobject

The stored PDF, resolved to a full file record.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

401 · The access token is missing, expired, or not for this company.

404 · No lease document or upload session matched the id, or it belongs to another company.

curl --request PUT \ --url 'https://api.portal.magicdoor.com/company-app/lease-documents/1842019384756201984/file' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "uploadSessionId": "1839562019840409600" }'

{ "id": "1842019384756201984", "portfolioId": "1827741029384756224", "propertyId": "1829933847562019840", "unitId": "1832019384756201984", "leaseId": "1830472847398404096", "leaseTemplateIds": [ "1843019384756201984" ], "fileId": "1838475620198404096", "name": "Residential lease agreement", "status": "draft", "type": "lease", "signers": [ { "id": "1831856473920184832", "name": "Dana Whitfield", "type": "tenant", "signatureStatus": "draft", "signatureName": "Dana Whitfield", "signatureInitials": "DW", "emailSignature": { "destination": "dana.whitfield@example.com", "type": "email", "sentDate": "2026-02-24T13:10:00" } } ], "annotations": [ { "id": "sig-tenant-1", "signerId": "1831856473920184832", "page": 6, "x": 0.12, "y": 0.72, "width": 0.3, "height": 0.06, "fontSize": 12, "type": "signature", "isInputField": true, "isVisible": true, "isMandatory": true } ], "file": { "id": "1838475620198404096", "created": "2026-08-14T10:22:41", "name": "lease-agreement.pdf", "extension": "pdf", "size": 284193, "contentType": "application/pdf", "secureUrl": { "base": "https://files.magicdoor.com", "raw": "/f/1838475620198404096/raw", "variantTemplate": "/f/1838475620198404096/{variant}" }, "fileId": "1838475620198404096", "fileName": "lease-agreement.pdf", "signedUrl": "https://files.magicdoor.com/f/1838475620198404096/raw?sig=abc123", "fileSize": 284193, "uploaded": "2026-08-14T10:22:41", "claimed": true } }