API ReferenceHouseholds

Create Document

<Badge>Available by Request</Badge> Creates a document for a specific household <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

householdIdstringRequired
The id of the household

Request

This endpoint expects a multipart form containing a file.
filefileRequired

The file to upload (max 5MB). Supported formats - image/jpeg, image/png, image/gif, application/pdf

idempotencyIdstringRequiredformat: "uuid"
Unique identifier to ensure idempotent operations
createdByIdstringRequiredformat: "uuid"
The ID of the user who created the attachment
namestringOptional<=255 characters
The name of the document. If not provided, the filename will be used
documentTypeenumOptionalDefaults to Miscellaneous
The type of document being uploaded
Allowed values:

Response

The created document
householdIdstringformat: "uuid"
idstringformat: "uuid"
propertyIdstringformat: "uuid"
urlstring
createdAtdatetime or null
createdByUserIdstring or nullformat: "uuid"
deletedAtdatetime or null
householdobject or null
idempotencyIdstring or nullformat: "uuid"
isReviewedboolean or nullDefaults to false
Indicates if the document has been reviewed by compliance
mimeTypestring or null
namestring or null
notesstring or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
readableIdstring or null
typestring or null
updatedAtdatetime or null