API Reference

Update watermark group

Used to update watermark group properties

To update watermark group properties, you can make a PUT request to the endpoint provided (https://api-v2.pandavideo.com.br/drm/videos/{drm_group_id}). This allows you to modify the properties of an existing watermark group.

Path Parameters

  • drm_group_id (string, required): The ID of the watermark group to be updated.

Request Body Parameters

  • videos (object): Specify the properties to update for the associated videos.

    • action (string): Specify the action to perform on the videos (e.g., "increment", "set", or "delete").
  • folders (object): Specify the properties to update for the associated folders.

    • action (string): Specify the action to perform on the folders (e.g., "increment", "set", or "delete").
  • font-family (string): Choose the font family for the watermark. Available fonts: fredoka-regular, arial, helvetica, times-new-roman, and times.

  • font-color (string): Specify the font color for the watermark (e.g., "white").

  • font-size (string): Set the font size for the watermark (e.g., "22").

  • box-color (string): Specify the color for the watermark box (e.g., "#4874F1").

  • box-opacity (string): Set the opacity of the watermark box. The value should be between 0 and 1.

  • active (boolean): Set the watermark group as active or inactive. If set to true, the videos will be blocked without using the signed URL.

  • watermark_question (string): [Optional] Specify a watermark question.

📘

Responses

  • 200: Success. The watermark group has been successfully updated.
  • 400: Bad request. Check the provided parameters.
  • 404: Not found. The endpoint or resource could not be found.
  • 409: Conflict. A conflict occurred while updating the watermark group.
  • 500: Internal server error. Please try again later.

By making a PUT request to this endpoint with the appropriate path parameter and request body, you can update the properties of the watermark group.

Recipes

The Recipes section provides a collection of code examples and sample implementations to help you understand and use the API effectively. Each recipe includes commented code that explains the purpose and functionality of each line. You can refer to these recipes as a guide to implement specific features or interact with the API endpoints.

See the recipes below:

Language
Authorization
Header
Click Try It! to start a request and see the response here!