MagicDoorAPI
SupportOpen MagicDoor
Lease templates

Update a lease template

Replaces a template's name, category, description, signer slots and boxes. signers and annotations are sent in full — anything you leave out is removed.

PUT
https://api.portal.magicdoor.com/company-app/lease-templates/{leaseTemplateId}

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

leaseTemplateIdstringrequired

The template to update. A Snowflake id, sent as a decimal string.

example: 1843019384756201984

Body

application/json

leaseTemplateCategoryIdstringrequired

The category the template should sit in. A Snowflake id, sent as a decimal string.

namestringrequired

Template name. 1 to 150 characters.

signersobject[]required

The complete list of signer slots.

annotationsobject[]required

The complete list of boxes on the PDF.

descriptionstring

What the template is for.

typeenum<string>

What the template is used for.

leaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation

Response

200 · The updated template.

idstring

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

leaseTemplateCategoryIdstring

The category the template sits in. A Snowflake id, sent as a decimal string.

namestring

Template name.

descriptionstring

What the template is for.

typeenum<string>

What the template is used for: a lease, a leaseRenewal, a lateRentNotice, an eviction notice, a signatureOnly page, or an information sheet.

leaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation
isDefaultboolean

True for MagicDoor's built-in templates, false for ones the company added.

signersLeaseTemplateSigner[]

The signer slots defined on the template.

annotationsLeaseDocumentAnnotation[]

The boxes placed on the template's PDF.

fileobject

The template's stored PDF.

fileIdstringdeprecated

Use file.id.

fileNamestringdeprecated

Use file.name.

fileExtensionstringdeprecated

Use file.extension.

signedUrlstringdeprecated

Use file.secureUrl.raw.

contentTypestringdeprecated

Use file.contentType.

fileSizeintegerdeprecated

Use file.size.

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 template matched the id, or it belongs to another company.