Subsidizers

Create a subsidizer

Adds a body that pays part of a tenant's rent — a housing authority, a charity, an employer. The new subsidizer starts active and can be attached to leases straight away.

POST
https://api.portal.magicdoor.com/company-app/subsidizers

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.

Body

application/json

type and name are required. Everything else is optional.

typeenum<string>required

What kind of body the subsidizer is.

governmentnonProfitprivateother
namestringrequired

The subsidizer's name. 1 to 200 characters.

languagestring

ISO 639-1 language code for messages to this subsidizer. Stored as en when omitted.

memostring

Internal note. Up to 1,000 characters.

websitestring

The subsidizer's website. Up to 500 characters.

contactobject

How to reach the subsidizer.

addressobject

The subsidizer's mailing address.

federalTaxInformationobject

Tax identification for the subsidizer. Sending it stores a government identifier.

paymentSettingsobject

How the subsidizer pays.

Response

200 · The new subsidizer.

idstring

The subsidizer.

namestring

The subsidizer's name.

languagestring

ISO 639-1 language code used for messages to this subsidizer.

memostring

Internal note. Absent when none was written.

activeboolean

false once the subsidizer has been deactivated. Deactivated subsidizers are hidden from the default list but keep every subsidy already recorded against them.

websitestring

The subsidizer's website. Absent when none is on file.

contactobject

How to reach the subsidizer.

addressobject

The subsidizer's mailing address.

federalTaxInformationobject

Tax identification for the subsidizer. Absent when none is on file.

paymentSettingsobject

How the subsidizer pays.

typeenum<string>

What kind of body the subsidizer is.

governmentnonProfitprivateother
creatorobject

Who created the subsidizer record.

createdstring · date-time

When the subsidizer was created.

updatedstring · date-time

When the subsidizer was last changed.

creatorInfoobject

The person or company behind creator, filled in so you do not have to fetch them. Only the property that matches creator.type is present.

401 · The access token is missing, expired, or does not belong to a property manager.

What a subsidizer is

A subsidizer is a body that pays part of a tenant's rent — a housing authority, a charity, an employer. It is a payer, not a person with a portal sign-in: there is no password, no invite and no portal status here. Subsidizers are attached to leases as lease subsidies, and the money they send appears on the lease ledger.