v1

latestOpenAPI 3.1.02026-07-241050242.7 KB

/personAttachments

Attach a file to a person.

post/personAttachments

Headers

X-Systemstring required

Registered system name.

X-System-Keystring required

Registered system API key.

Request body

personIdinteger required

ID of the person.

uristring required

URI of an externally hosted file.

fileNamestring required

Name of the file.

fileSizeinteger

Size of the file in bytes.

Response

201

personIdinteger

fileNamestring

{"stackTrail":"paths:/personAttachments:post:responses:201:content:application/json:schema:properties:fileSize","oasType":"schema","type":"unknown"}

idinteger

mimeTypestring

uristring

{"stackTrail":"paths:/personAttachments:post:responses:201:content:application/json:schema:properties:thumbnailUri","oasType":"schema","type":"unknown"}

statusstring

createdAtstring

createdByIdinteger

createdByNamestring

Example response

{
  "personId": 1,
  "fileName": "test.jpg",
  "id": 2,
  "mimeType": "link",
  "uri": "https://test.com/myfile",
  "status": "created",
  "createdAt": "2022-11-16T03:44:52Z",
  "createdById": 1,
  "createdByName": "Olivia Admin"
}