Upload an image

POST

https://www.rapidoform.com/be/api/get/uploadImage

All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.

Parameters

NameType / locationDescription
mediamultipart fileRequired file part. Use multipart/form-data, not JSON or base64.

Let curl or your HTTP client set the multipart boundary. Storage limits apply; exhausted storage returns HTTP 402. Save the returned fileName for deletion and fileLink for display. A missing multipart media file returns HTTP 400.

Example request

curl --request POST 'https://www.rapidoform.com/be/api/get/uploadImage' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --form 'media=@./image.png'

Response

Examples show selected fields, not every stored property. Empty arrays are valid for list/report endpoints.

{
  "Errors": [],
  "Info": [],
  "Data": [
    {
      "uploaded": true,
      "message": "File uploaded successfully.",
      "fileLink": "https://example.com/image.png",
      "fileName": "userId_EXAMPLE%2Forigin_addMedia%2FImage%2Fexample.png"
    }
  ],
  "ErrorCode": "SUCCESS",
  "fieldErrors": {
    "List": []
  }
}

HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.