Deactivate a subsidizer
Marks a subsidizer inactive so it stops appearing in the default list and can no longer be picked for new work. Nothing is deleted and every subsidy already recorded against it stays exactly as it is.
Authorization
AuthorizationstringrequiredPath parameters
subsidizerIdstringrequiredThe subsidizer. A Snowflake id, sent as a decimal string.
Response
200 · The subsidizer, now with `active` set to `false`.
idstringThe subsidizer.
namestringThe subsidizer's name.
languagestringISO 639-1 language code used for messages to this subsidizer.
memostringInternal note. Absent when none was written.
activebooleanfalse once the subsidizer has been deactivated. Deactivated subsidizers are hidden from the default list but keep every subsidy already recorded against them.
websitestringThe subsidizer's website. Absent when none is on file.
contactobjectHow to reach the subsidizer.
addressobjectThe subsidizer's mailing address.
federalTaxInformationobjectTax identification for the subsidizer. Absent when none is on file.
paymentSettingsobjectHow the subsidizer pays.
typeenum<string>What kind of body the subsidizer is.
creatorobjectWho created the subsidizer record.
createdstring · date-timeWhen the subsidizer was created.
updatedstring · date-timeWhen the subsidizer was last changed.
creatorInfoobjectThe 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.
404 · No subsidizer with that id exists for the calling company. A record that belongs to another company is reported the same way as one that does not exist. The id you asked for is in `entityId`; `detail` names only the kind of record.
Deactivating sets active to false and nothing else.
What changes: the subsidizer stops appearing in list subsidizers, which filters on active by default.
What does not change: the subsidizer record, its contact and tax details, and every lease subsidy and transaction already recorded against it. Fetching it by id still works.
Use this rather than delete a subsidizer for a body you have simply stopped working with — delete is permanent and is refused once any subsidy exists.
Deactivating an already-inactive subsidizer returns it unchanged rather than failing.