<aside> 🔒

Information Classification: Public

</aside>

Where possible we recommend not using this, and instead using Beacon Forms/Portal Forms for adding data into your system, due to the complexity of the below.

Adding data to 'File upload' fields requires a different process than adding data to other field types. It’s a two step process:

  1. Upload your file
    1. Get a signed URL
    2. Upload your file to it
    3. (If an image) Generate a preview image
  2. Update your record with the uploaded file ID

Get a "signed URL" from our API

Run an API request to this endpoint:

GET /account/{account_id}/entity_file/upload_url

Include the following parameters in the query string:

Example:

https://api.beaconcrm.org/v1/account/12345/entity_file/upload_url?content_type=image/png&name=MyFile.png