Delete Clipping Profile Integration

v4

Removes a specified integration from a clipping profile.

Request

Request syntax:

DELETE /clipping-profiles/{Clipping Profile ID}/integrations/{Integration ID}

Request URL variable:

Define the following variables when submitting the above request:

VariableDescription
Clipping Profile ID RequiredIdentifies a clipping profile by its system-defined or external ID. Use the Get Multiple Clipping Profiles endpoint to retrieve a list of clipping profiles and their IDs.
Integration ID RequiredIdentifies a clipping profile integration id by its system-defined ID

Response

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

NameData TypeDescription
@idStringIndicates the relative path to the requested endpoint.
@typeStringReturns ClippingProfileIntegrations.
messageStringReturns Deleted.

Sample Request/Response

The code below (Python 3) shows how to delete a profile integration.

This code imports names from the api_auth module for V4 APIs (see below).

Request:

			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"

			def run(self):
			"""run description"""
			self._delete_metadata()

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

			response = requests.delete(
			url,
			params=APIParams(APICredentials()).get_params(query_params),
			timeout=15
			)

			pp(response.json())

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

Response:

{
	"@id": "/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/integrations/c3eb485e9b374945a623abc3b883eb78",
	"@type": "ClippingProfileIntegrations",
	"message": "Deleted"
}