mediatype.update

Description

object mediatype.update(object/array mediaTypes)

This method allows to update existing media types.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Media type properties to be updated.

The mediatypeid property must be defined for each media type, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard media type properties, the method accepts the following parameters.

Parameter	Type	Description
parameters	array	Script or webhook parameters to replace the current parameters.
message_templates	array	Message templates to replace the current message templates.

Return values

(object) Returns an object containing the IDs of the updated media types under the mediatypeids property.

Examples

Enabling a media type

Enable a media type, that is, set its status to "0".

Request:

{
           "jsonrpc": "2.0",
           "method": "mediatype.update",
           "params": {
               "mediatypeid": "6",
               "status": "0"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "6"
               ]
           },
           "id": 1
       }

Source

CMediaType::update() in ui/include/classes/api/services/CMediaType.php.

Documentation