younifyd
Menu

/api/files/upload (Upload Attachment or Image)

Upload Attachment or Image

POST/api/files/upload

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/files/upload (Upload Attachment or Image) action (under FileController).
  3. Fill in the fields below, then reference the result from later steps as {{apiFilesUploadUploadAttachmentOrImage.response.data}}.

Request

Query parameters

typestringrequired

One ofIMAGEATTACHMENTIMAGEATTACHMENTSHAREFILE

subPathstring
uploadLimitedTypestring
isThumbnailboolean
payloadstring

Request body

Enter the body as JSON in the step's Body field.

filestring (binary)required
json
{
  "file": "string"
}

Response

Returns 201 with an object. Read it in later steps with {{apiFilesUploadUploadAttachmentOrImage.response.data.<field>}}.

idstring
fromImportboolean
deleteCommentFieldInfoListarray<object>
uiIdstring
businessKeystring
internalSeqNointeger (int32)
get_overrideCreateUserstring
get_overrideCreateUserNamestring
get_overrideUpdateUserstring
get_overrideUpdateUserNamestring
get_overrideCreatedOnstring (date-time)
get_overrideUpdatedOnstring (date-time)
get_overrideStatusstring
attachmentIdstring
typestring
fileNamestring
thumbnailboolean
filePathstring
fileSizestring
protocolstring
thumbnailUrlstring
urlstring
extraDataobject
json
{
  "id": "string",
  "fromImport": false,
  "deleteCommentFieldInfoList": [
    {
      "uiId": "string",
      "businessKey": "string",
      "internalSeqNo": 0
    }
  ],
  "get_overrideCreateUser": "string",
  "get_overrideCreateUserName": "string",
  "get_overrideUpdateUser": "string",
  "get_overrideUpdateUserName": "string",
  "get_overrideCreatedOn": "2025-01-01T00:00:00Z",
  "get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
  "get_overrideStatus": "string",
  "attachmentId": "string",
  "type": "string"
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.