File upload

Upload file data to an external system and return the response object. This card supports multipart uploads.

This function card is only available in Connector Builder.

Input

Field Definition Type Required
File Content The file contents to upload. File TRUE
URL The URL of the request, including the protocol http:// or https://. String TRUE
HTTP Method

The HTTP method to use:

  • POST

  • PUT

Dropdown TRUE
Protocol

The protocol to use:

  • HTTP

  • SFTP

Dropdown TRUE
Query

Specify any additional query parameters to include as key and value pairs.

For example: {"name":"something-urgent"} turns into the query parameter ?name=something-urgent&....

 Object FALSE
Headers Specify any headers for the request. Object FALSE
File Metadata

This input is used for multipart uploads. It contains additional properties to send alongside the file contents. If your integration requires an order for the file request body properties, this input represents the first portion. The required details for this input vary from one integration to another.

Some examples of data that can be sent include the following:

  • File name.

  • File description.

  • Upload location.

If your integration doesn't require headers for the request body, use the key and value pairs format.

If the content of your data isn't a string, you can use the JSON Stringify card to convert your content into a string for use in this card.

Example format for https://developer.box.com/reference/post-files-content/:

Copy 
{
    "your_key_name": "content"
}

Example format that requires specifying headers for https://developers.google.com/workspace/drive/api/guides/manage-uploads:

Copy 
{
    "your_key_name":{
        "headers": object,
        "content": string,
    }
}
 Object FALSE
File Info

This property is used for multipart upload requests. It's required if you use the File Metadata input. This input requires at least one property with the key "name" . The value can be empty. Other details for this input vary from one integration to another. If your integration requires an order for file request properties, this input represents the second option.

Some examples of data that can be sent include the following:

  • File name.

  • File type.

  • File contents.

Example format for https://developer.box.com/reference/post-files-content/:

Copy 
{
    "name": {integration_field_name},
    "params": {
        "filename": "{filename}"
    },
    "headers": object (if required)
}

Example format for https://developers.google.com/workspace/drive/api/guides/manage-uploads:

Copy 
{
    "name": {integration_field_name},
    "headers": object (if required)
}
 Object FALSE

Output

Field Definition Type
Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

 Number
Headers Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. The header is similar to {"Content-type":"application/json"}. Object
Body

The data returned from your selected HTTP request.

For example, the data from a GET request.

 Text

Related topics

Functions

Workflow elements