Update Clipping Profile Metadata

Updates Clipping Profile Metadata

Request

Request syntax:

PATCH /clipping-profiles/Clipping Profile ID/metadata/Metadata ID

Request URL variable:

Define the following variables when submitting the above request:

Request body parameters:

Pass the following request body parameters (pass only the fields you want to update):

Response

A successful request returns a 200 OK response that contains the following properties:

Sample Request/Response

Call the [clipping_profiles_integrations_update module](../Resources/Scripts/clipping_profile_integrations_patch.py) (Python 3) to update a clipping profile's metadata. This module imports names from the api_auth module.

			import json
			from pprint import PrettyPrinter
			import requests
			from api_auth import APICredentials, APIParams

			pp = PrettyPrinter().pprint

			class ClippingProfiles:
			"""Class Description"""
			def __init__(self, source_list):
			"""dummy"""
			self.profile_id = None
			self.integration_id = None

			for key, value in source_list.items():
			setattr(self, key, value)

			self.host = "https://services.uplynk.com"
			self.headers = {"Content-Type": "application/json"}

			def run(self):
			"""dummy"""
			self._get_youtube_login_url()

			def _get_youtube_login_url(self):
			"""dummy"""
			end_point = f"/api/v4/clipping-profiles/{self.profile_id}/integrations/{self.integration_id}"
			url = f"{self.host}{end_point}"

			payload = {
			"metamap": {
			"category": "$blue_colors",
			"description": "@desc",
			"keywords": "$blue_colors",
			},
			}

			response = requests.patch(
			url,
			params=APIParams(APICredentials()).get_params({}),
			data=json.dumps(payload),
			headers=self.headers,
			timeout=15
			)

			pp(response.json())

			class_variables = {
			"profile_id": "be1af15490e24399bb6c4f2a36384d66",
			"integration_id": "c3eb485e9b374945a623abc3b883eb78"
			}
			ClippingProfiles(class_variables).run()

Response:

			{
			"@id": "/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/metadata/704d17c332624569b3a6414a3422fdd1",
			"@type": "ClippingProfileMetadata",
			"created": "2024-05-07T15:27:41.767Z",
			"default_value": "",
			"id": "704d17c332624569b3a6414a3422fdd1",
			"include_free_form": False,
			"include_null": False,
			"input_type": "dropdown",
			"key": "blue_colors",
			"lastmod": "2024-05-07T15:42:35.345Z",
			"owner": "53b2162d19394227b56d5cdca5c3dc9f",
			"profile": "be1af15490e24399bb6c4f2a36384d66",
			"values": [
			["blue_dark", "Dark Blue"],
			["blue_egyptian", "Egyptian Blue"],
			["blue_liberty", "Liberty"],
			["blue_medium", "Medium Blue"],
			["blue_neon", "Neon Blue"],
			["blue_periwinkle", "Periwinkle"],
			["blue_savoy", "Savoy Blue"],
			["blue_ultra", "Ultramarine"],
			],
			}