Media ID

Modify asset

Requires the MEDIAEDIT security role. Requires the MARKPUBLIC security role in order to change an asset's isPublic state.

Custom thumbnails

To set a custom thumbnail, first upload the thumbnail image using the Modern Stack File Upload flow, then call this endpoint with the returned file id as customThumbnailFileId. To remove an existing custom thumbnail and revert to the automatically generated one, call this endpoint with removeCustomThumbnail=true. The two fields are mutually exclusive.

post/api/v4/media/{id}

Request

Base URL
https://{your-bynder-domain}
URL
https://{your-bynder-domain}/api/v4/media/{id}
Auth
- API key in header Authorization
- or OAuth 2
  Authorization code: https://{your-auth-url}
  Client credentials
  Token URL: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: , MEDIAEDIT, MARKPUBLIC

Path parameters

idstring required

Asset id.

Request body application/x-www-form-urlencoded

archiveboolean

Indicating the archived state of the asset.

archiveDatestring date-time

Archive datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.

brandIdstring

Id of the brand to save the asset to.

copyrightstring

customThumbnailFileIdstring

The file id of the custom thumbnail to be set for the asset. Custom thumbnails must first be uploaded by following the steps described in the Modern Stack File Upload documentation; use the fileId returned by that flow. Cannot be combined with removeCustomThumbnail.

datePublishedstring date-time

Publication datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.

descriptionstring

Asset description.

idstring

Asset id.

isPublicboolean

Indicating the public state of the asset. Warning irreversible, once changed to true it cannot be changed back.

limitedboolean

Indicating the limit state of the asset.

limitedDatestring date-time

Limit datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.

metapropertyobject

Mapping of metaproperty UUIDs to the option value(s) to set on the asset. Each value may be provided as option label, option DB name, or option UUID. For multi-select metaproperties, pass multiple values as a comma-separated string. <br><br>In x-www-form-urlencoded requests, fields are sent as metaproperty.<metaproperty_uuid>=<value1>,<value2>.

namestring

Name of the asset, beware the asset will have no name when this is empty.

removeCustomThumbnailboolean

Remove the current custom thumbnail from the asset, reverting to the automatically generated thumbnail. Cannot be combined with customThumbnailFileId.

tagsstring

Comma-separated tags. Tags will overwrite the current tags list.

watermarkDatestring date-time

Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.

Example request

{
  "customThumbnailFileId": "00000000-0000-0000-0000-000000000000",
  "metaproperty": {
    "02509778-CEE3-43D5-9E96-9A60B1E78314": "option_id1,option_id2",
    "EF122F1F-9BA0-4772-80F1-BF05588B1A59": "option_id3"
  },
  "removeCustomThumbnail": true
}

Response

Accepted

messagestring

statuscodeinteger

Changes

No recorded changes to this operation across all 1 revision of this API.