Uploads a file and links it to the person.
Add File to a Person
Uploads a file and attaches it to an existing person relation.
A developer calls this endpoint to store a document against a person's record, for example a signed contract, an identification document scan, or other supporting paperwork, so it can be retrieved later from within Bloxs.
The person to attach the file to is located via reference or externalIdentifier, at least one of which must be supplied.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the person to attach the file to. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the person to attach the file to. |
File | string (binary) | Required | The file to upload, sent as multipart/form-data (or as a base64-style binary field if submitted as application/json). If no file is included in the request, the call fails. |
Response Fields
This endpoint returns no response body on success. A 200 response confirms the file was created and attached to the person.
Field | Type | Required | Description |
|---|---|---|---|
(none) | No fields are returned on success. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The file was created
No file was uploaded
There was a problem attaching the file to the person