Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed the response content and changed success status code to 204; Updated the example to use sanitised url-safe values for fileName and folderPath; Added status code 400.3; Made folderPath optional
Excerpt

Update a media file to in the dialogportal™ Media Archive.

A media in archive can be searched and updated based on fileName and folderPath fields. Fields - Media file content, contentType and description are optional fields that can be updated properties are updateable. The fileName and folderPath are used to uniquely identify the media file.

Endpoint ID:

9101

Method:

Status
colourGreen
titlePUT

URL:

/content/media

Request body:

JSON data with information about the media to be updated.

Required fields:
 

fileName

A file name or title of the media item.

Optional fields:
 folderPathA folder path of the media file to be updated. This path is not the entire URL (which also contains the customer name, fileName etc.) but simply a "/"-delimited string of folder names. Exclude the folderPath to update a file in the root folder.
Optional updatable fields:
 content

The content, formatted as a base64 encoded text string.

 description

A description that will be displayed in dialogportal™

 contentType

The content mime-type, i.e. "image/gif" or "text/plain". The content type may only be changed to another content type with the same resulting media file type - that is, an Image media file with content type "image/gif" may be changed to "image/png", but not to "text/css".

Code Block
titleExample: Update a single pixel image
 {
   "contentfileName": "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==clear_1x1.gif",
   "descriptionfolderPath" : "This is a media description.assets/generic_images/small",
    "contentTypecontent": "image/gifR0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
   "fileNamedescription" : "clear 1x1.gifThis is a media description.",
   "folderPathcontentType": "Assets/Generic Images/Small"   image/gif"
}

Response body:

A JSON object containing the url of the updated content.
Code Block
titleExample
{
  "url": "https://media.dialogportal.com/customer_name/assets/generic_images/small/clear_1x1.gif"
}

The URL format is:

Base URLhttps://media.dialogportal.com/
Customer name
customer_name/
Folder path
assets/generic_images/small/
File nameclear_1x1.gif
Note

The fileName and folderPath have been sanitized, making them safe to use in a URL.

None

Status codes:

200204

Media updated successfully.

 404Media to be updated file not found.
 400.1Content type not recognized
 400.2Media files may not be larger than 2MB
 400.3Altering 'contentType' may not result in a different media file type