Lease subsidies

Delete a subsidy

Removes a subsidy from the lease. By default the payments it has already made stay on the ledger; set deleteRelatedRecords to true to remove those too. To stop a subsidy but keep its history, deactivate it instead.

DELETE

https://api.portal.magicdoor.com/company-app/leases/{leaseId}/subsidies/{leaseSubsidyId}

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

leaseIdstringrequired

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

example: 1830472847398404096

leaseSubsidyIdstringrequired

The subsidy to delete. A Snowflake id, sent as a decimal string.

example: 1845019384756201984

Body

application/json

deleteRelatedRecordsboolean

Whether to also remove the payments this subsidy has already made.

default: false

Response

200 · The subsidy was deleted. No body is returned.

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

Request

curl --request DELETE \
  --url 'https://api.portal.magicdoor.com/company-app/leases/1830472847398404096/subsidies/1845019384756201984' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deleteRelatedRecords": false
}'

Body

{
  "deleteRelatedRecords": false
}