| 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: | |
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: | | | folderPath | A 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 |
|---|
| title | Example: 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 |
|---|
| {
"url": "https://media.dialogportal.com/customer_name/assets/generic_images/small/clear_1x1.gif"
} |
The URL format is: | Base URL | https://media.dialogportal.com/ | | Customer name | customer_name/ | | Folder path | assets/generic_images/small/ | | File name | clear_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. |
| | 404 | Media to be updated file not found. |
| | 400.1 | Content type not recognized |
| | 400.2 | Media files may not be larger than 2MB |
| | 400.3 | Altering 'contentType' may not result in a different media file type |