Update Rule

Updates a specific rule.

Request

Request syntax:

PATCH /rules/Rule ID

Define the following variable when submitting the above request:

Request body parameters:

Pass the following request body parameters:

Response

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

Sample Request/Response

Call the update_rule module (Python 3) to update a rule. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams
rule_id = 'c2eb5a555b9d45b7a43552f65a268075' # Replace with the ID for the desired rule.

class Rule:
    def __init__(self):
        self.host = "https://services.uplynk.com"import json, requests

    def run(self):
        """
        Update a rule.
        """
        self._update_rule()

    def _update_rule(self):
        url = "{}{}{}".format(self.host, "/api/v4/rules/", rule_id)

        payload = {
            'alternate_content_type': 'asset', # Sets the type of alternate content.
            'alternate_content_id': '062048d702734ca6a38f3e7f8e4f4488' # Replace with the desired asset ID.
        }

        headers = {'Content-Type': 'application/json'}

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

        print(response.json())

Rule().run()

Response:

{
	'@id': '/api/v4/rules/c2eb5a555b9d45b7a43552f65a268075',
	'@type': 'Rule',
	'id': 'c2eb5a555b9d45b7a43552f65a268075',
	'created': '2021-07-01T23:34:38.215Z',
	'owner': 'abc123def456ghi789jkl012mno345pq',
	'external_id': '',
	'audience': '',
	'alternate_content_type': 'asset',
	'alternate_content_id': '062048d702734ca6a38f3e7f8e4f4488',
	'alternate_content_loop': True,
	'all_viewers': True,
	'desc': 'My New Rule'
}