REST API: Add File

Anonymous User

Published: 5/5/2015

Mandy Barclay-Pollard

Updated: 12/12/2022

0 (0votes)

Add File

Adds a file to a specific directory. Valid for Communifire version 5.2 and above.

HTTP Method

POST

Response Format

JSON

Requires Authentication?

YES

Product Version

5.2 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
File Stream	Used in the request body	Send the byte stream of the file you want to upload.
FileDirectoryID	Used in the request URL as a query parameter	Unique identifier for a particular file directory under which file is to be uploaded.
FileName	Used in the request URL as a query parameter	Name of the file you want to upload.

Optional Parameters	How to use	Description
ContentBody	&ContentBody=x - Used in the request URL as a query parameter	The file description.
tags	Upload file via API using Content list widget	File displays on Content List Widget.

Body: The file stream

File content ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":"2333"
}

Please Note The content type that you pass in the header of your request should be application/octet-stream.