files_post: Initiate an upload of a file into the platform

In civis: R Client for the 'Civis Platform API'

Initiate an upload of a file into the platform

Description

Initiate an upload of a file into the platform

Usage

files_post(name, expires_at = NULL)

Arguments

name	string required. The file name.
expires_at	string optional. The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.

Value

A list containing the following elements:

id	integer, The ID of the file.
name	string, The file name.
createdAt	string, The date and time the file was created.
fileSize	integer, The file size.
expiresAt	string, The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.
uploadUrl	string, The URL that may be used to upload a file. To use the upload URL, initiate a POST request to the given URL with the file you wish to import as the "file" form field.
uploadFields	list, A hash containing the form fields to be included with the POST request.
myPermissionLevel	string, Your permission level on the object. One of "read", "write", or "manage".

civis documentation built on April 1, 2023, 12:01 a.m.