Attachments API

Files can be uploaded to Aha! as a sub-resource on any resource that supports them. These resources support attachments:

The format of an attachment is either a multipart/form-data upload with the input name attachment[data] or a JSON payload pointing to an URL link:

  "attachment": {
    "file_url": "",
    "content_type": "text/html",
    "file_name": "home_page.html"

Create an attachment on a custom note field via a link

POST /api/v1/custom_fields/:custom_field_id/attachments

custom_field_id *

Numeric ID of the custom field for which the attachment should be created

Example request

POST /api/v1/custom_fields/432637490/attachments

Example CURL command

curl "" -d 'attachment[file_url][content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"


authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: multipart/form-data
accept: application/json

Request body



Status: 200 OK
contentType: application/json; charset=utf-8

Response body