Update an existing audience

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/audiences/{audience_id}/update

Modifies the configuration of an existing audience. This can include changing its name, type, status (active/archived), or the rules defining its criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project into which the audience is stored

audience_id

integer

required

ID of the audience to be updated

Body Params

description

string

length ≤ 500

An optional, more detailed explanation of the audience's purpose or criteria, aiding in identification and management.

status

string

enum

The status of an audience:

active: The audience is currently active and can be used for targeting experiences.
archived: The audience is no longer active and cannot be used for new experiences, but its definition and past usage data are preserved. Archived audiences can often be cloned. Knowledge Base: "Benefits of Archiving Unused Goals, Locations, and Audiences."

Allowed:

name

string

length ≤ 100

A user-defined, friendly name for the audience (e.g., "New Visitors from USA", "Repeat Purchasers - Mobile"). This name appears in the Convert UI when selecting audiences for experiences.

selected_default

boolean

If true, this audience will be automatically pre-selected when creating new experiences within the project. Useful for commonly targeted segments.

type

string

enum

Defines the behavior and persistence of an audience that does not use URL-based conditions in its rules.

permanent: Once a visitor matches the audience criteria, they are permanently considered part of this audience for future sessions and evaluations, even if their characteristics change later. The matching is checked only at the initial bucketing time.
transient: A visitor must match the audience criteria upon each evaluation (e.g., on every page load or when an experiment is rechecked) to be included. If conditions are no longer met, the visitor is no longer part of the audience for that specific evaluation. For Full Stack projects, only transient and segmentation (if applicable without URL rules) are valid.

Allowed:

rules

object | null

Similar to RuleObject, but the individual RuleElementNoUrl conditions within OR_WHEN arrays cannot include URL-based matching types. Used for 'permanent' or 'transient' audiences where URL context is not persistently evaluated or relevant for the audience type.

Responses

200Detailed information for a single audience, including its name, type, status, and the rules (visitor data, traffic source, cookie values, JS conditions) that define its criteria.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.