Upload a file

Uploads a file as base64 and optionally links it to users or organisations

POST/api/v1/{app_id}/files/upload

Authorization

AuthorizationAPI key · headerrequired

Bearer token (format: "Bearer {token}")

Path parameters

app_idstringrequired

UUID of the app

Request body

requiredapplication/json

File upload data

base64_encoded_imagestringrequired

custom_fieldsobject

filenamestring

order_referencestring

organisation_numberstring

relationship_idsstring[]

Responses

201

Created

app_idstring

content_typestring

created_atstring

custom_fieldsobject

filenamestring

idstring

updated_atstring

urlstring

400

Invalid request

detailsstring[] | null

messagestring

successboolean

500

Internal server error

detailsstring[] | null

messagestring

successboolean

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

app_idpath*UUID of the app

Bodyapplication/json

Request body

Request

curl -X POST '//customers.enad.io/api/v1/string/files/upload' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "base64_encoded_image": "string",
  "custom_fields": {
    "property1": null,
    "property2": null
  },
  "filename": "string",
  "order_reference": "string",
  "organisation_number": "string",
  "relationship_ids": [
    "string"
  ]
}'

const response = await fetch("//customers.enad.io/api/v1/string/files/upload", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"base64_encoded_image\": \"string\",\n  \"custom_fields\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"filename\": \"string\",\n  \"order_reference\": \"string\",\n  \"organisation_number\": \"string\",\n  \"relationship_ids\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "//customers.enad.io/api/v1/string/files/upload",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"base64_encoded_image\": \"string\",\n  \"custom_fields\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"filename\": \"string\",\n  \"order_reference\": \"string\",\n  \"organisation_number\": \"string\",\n  \"relationship_ids\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "app_id": "string",
  "content_type": "string",
  "created_at": "string",
  "custom_fields": {
    "property1": null,
    "property2": null
  },
  "filename": "string",
  "id": "string",
  "updated_at": "string",
  "url": "string"
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}