Update Audience

Updates an audience or a superaudience.

You may not convert an audience to a superaudience or vice versa. As a result, you may not modify the type property.

Request

Request syntax:

PATCH /audiences/Audience 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_audience module (Python 3) to update an audience. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams
audience_id = 'abc11672b78c4d03bf4756ec3ea46a22' # Replace with the ID for the desired audience.

class Audience:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Update an audience.
        """
        self._update_audience()

    def _update_audience(self):
        url = "{}{}{}".format(self.host, "/api/v4/audiences/", audience_id)

        payload = {
            'country_codes': ['US', 'MX'] # Replace with the desired country codes.
        }

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

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

        print(response.json())

Audience().run()

Response:

{
	'@id': '/api/v4/audiences/abc11672b78c4d03bf4756ec3ea46a22',
	'@type': 'Audience',
	'created': '2021-06-30T22:32:09.362Z',
	'id': 'cc1c1672b78c4d03bf4756ec3ea46a45',
	'owner': 'abc123def456ghi789jkl012mno345pq',
	'match_type': 'ANY',
	'external_id': 'NorthAmerica',
	'country_codes': ['MX', 'US'],
	'dma_codes': [],
	'desc': 'My New audience',
	'devices': [],
	'ip_networks': [],
	'zip_codes': [],
	'sub_audiences': [],
	'type': 'Single'
}