REST API: Check In File

Anonymous User

Published: 9/14/2015

Grace Kamau

Updated: 2/25/2021

0 (0votes)

Check In File

Check in a file in place of an already checked out file. Used to update an existing file. Valid for Communifire version 5.2 and above.

HTTP Method

PUT

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.
ContentID	Used in the request URL as a path parameter	Unique identifier for a particular content(file).
FileName	Used in the request URL as a query parameter	Name of the file you want to upload.

Body: The file stream

Content ID is returned as ResponseData

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

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