Archives an existing owner from the given date. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the owner.
Archive an Owner
Archives an existing owner relation as of a given date.
A developer calls this endpoint when an owner relation is no longer active but should be retained in Bloxs for historical and audit purposes rather than deleted. Since an owner has its own financial administration, archiving affects that administration's status as well, not just the contact-level relation data.
The owner to archive is located via reference or externalIdentifier.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
archiveDate | string (date) | Required | The date from which the owner is considered archived, formatted as ISO 8601 (YYYY-MM-DD), for example "2026-06-30". |
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the owner to archive. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the owner to archive. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, max 100 | Optional | The internal identifier (Reference/Code) of the archived owner. |
externalIdentifier | string, max 100 | Optional | The external API identifier of the archived owner, if any. |
displayName | string | Optional | The formatted display name of the owner. |
name | string, max 256 | Required | The owner's registered or trading name. |
website | string, nullable | Optional | The owner's website URL. |
correspondenceMethod | integer (enum) | Required | How correspondence is delivered to this owner. Allowed values: 1 = Email, 2 = Post. |
languageISOCode | string, max 2, nullable | Optional | ISO 639-1 two-letter language code determining the correspondence language. |
address.street | string, max 200 | Conditionally required | Street name of the owner's main address. |
address.houseNumber | string, max 40, nullable | Optional | House number of the owner's main address, including any suffix. |
address.postalCode | string, max 20 | Conditionally required | Postal code of the owner's main address. |
address.city | string, max 200 | Conditionally required | City of the owner's main address. |
address.countryISOCode | string, max 2 | Conditionally required | ISO 3166-1 alpha-2 country code of the owner's main address. |
invoiceAddress.street | string, max 200 | Required (if invoiceAddress is set) | Street name of the invoice address. |
invoiceAddress.houseNumber | string, max 40, nullable | Optional | House number of the invoice address. |
invoiceAddress.postalCode | string, max 20 | Required (if invoiceAddress is set) | Postal code of the invoice address. |
invoiceAddress.city | string, max 200 | Required (if invoiceAddress is set) | City of the invoice address. |
invoiceAddress.countryISOCode | string, max 2 | Required (if invoiceAddress is set) | ISO 3166-1 alpha-2 country code of the invoice address. |
postalAddress.street | string, max 200 | Required (if postalAddress is set) | Street name of the postal address. |
postalAddress.houseNumber | string, max 40, nullable | Optional | House number of the postal address. |
postalAddress.postalCode | string, max 20 | Required (if postalAddress is set) | Postal code of the postal address. |
postalAddress.city | string, max 200 | Required (if postalAddress is set) | City of the postal address. |
postalAddress.countryISOCode | string, max 2 | Required (if postalAddress is set) | ISO 3166-1 alpha-2 country code of the postal address. |
phoneNumber | string, nullable | Optional | The owner's landline phone number. |
mobileNumber | string, nullable | Optional | The owner's mobile phone number. |
primaryEmailAddresses | array of string, nullable | Conditionally required | The owner's primary email address(es). |
invoicesEmailAddresses | array of string, nullable | Optional | Email address(es) that receive invoices for this owner. |
paymentRemindersEmailAddresses | array of string, nullable | Optional | Email address(es) that receive payment reminder correspondence. |
indexationsEmailAddresses | array of string, nullable | Optional | Email address(es) that receive rent or fee indexation notices. |
serviceTicketsEmailAddresses | array of string, nullable | Optional | Email address(es) that receive service or maintenance ticket correspondence. |
purchaseOrdersEmailAddresses | array of string, nullable | Optional | Email address(es) that receive purchase order correspondence. |
portalsEmailAddresses | array of string, nullable | Optional | Email address(es) used for portal-related notifications. |
otherEmailAddresses | array of string, nullable | Optional | Any additional email address(es) not covered by the categories above. |
cocNumber | string, max 256, nullable | Optional | Chamber of Commerce (KVK-style) registration number, where applicable. |
cocDescription | string, nullable | Optional | Free-text description associated with the Chamber of Commerce registration. |
vatNumber | string, max 256, nullable | Optional | The owner's VAT identification number. |
remarks | string, nullable | Optional | Free-text internal remarks about the owner. |
archiveDate | string (date), nullable | Optional | The date from which the owner is now archived, formatted as an ISO 8601 date (YYYY-MM-DD). Reflects the value submitted in the request. |
The date on which it is archived.
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The owner was archived
Email = 1 Post = 2
The archiving has validation issues
The requested owner was not found.