Edit an Audience
Edits an audience.
Request
- audience_idstring [uuid]Required
A unique identifier for the entity.
Example:ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
- ad_account_idstring [uuid]Required
A unique identifier for an Ad Account.
Example:ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
- audience_typestringRequired
Type of the audience to edit.
Example:"CUSTOM"
- namestring
Name of the audience.
Length between2
and80
Example:"US - 18-24 - All gender"
- descriptionstring
Description of the audience.
Maximum length:80
Example:"For spring promotion campaign"
- audience_typestringRequired
Type of the audience to edit.
Example:"CUSTOM"
- namestring
Name of the audience.
Length between2
and80
Example:"US - 18-24 - All gender"
- descriptionstring
Description of the audience.
Maximum length:80
Example:"For spring promotion campaign"
Response
An audience.
- created_atstring [date-time]
Date the entity was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
Example:"2026-01-23T04:56:07Z"
- updated_atstring [date-time]
Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
Example:"2026-01-23T04:56:07Z"
- idstring [uuid]
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- namestring
Name of the audience.
Length between2
and80
Example:"US - 18-24 - All gender"
- descriptionstring
Description of the audience.
Maximum length:80
Example:"For spring promotion campaign"
- typestring
Type of the audience.
Default:"CUSTOM"
Allowed values:"CUSTOM"
,"LOOKALIKE"
An approximate range of users in the audience.
- mininteger
Minimum of an approximate range of users in the audience.
Minimum value:0
- maxinteger
Maximum of an approximate range of users in the audience.
Minimum value:0
- statusstring
Status of the audience.
Default:"PROCESSING"
Allowed values:"ARCHIVED"
,"PROCESSING"
,"EMPTY"
,"BOOKABLE"
,"LIVE"
- sourcesarray of strings
Sources of the audience data.
Source of the audience data.
Default:"UNKNOWN"
Allowed values:"UNKNOWN"
,"CUSTOMER_LIST"
,"AUDIENCE"
,"PIXEL"
,"CONVERSIONS_API"
,"MOBILE_APP"
- seed_audience_idstring [uuid]
ID of the seed audience for the lookalike audience.
Supported content-type(s):Example:
"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- lookalike_audience_idsarray of strings
IDs of the lookalike audiences created from the current audience.
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
Datasets associated with the web event custom audience.
- idstring [uuid]
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- namestring
The name of the dataset.
- included_eventsarray of strings
Event names included in the web event custom audience.
Example:"ADDTOCART"
- excluded_eventsarray of strings
Event names excluded from the web event custom audience.
Example:"PURCHASE"
- lookback_daysinteger
Lookback window for events in the web event custom audience.
Example:30
Response sample
{ "created_at": "2026-01-23T04:56:07Z", "updated_at": "2026-01-23T04:56:07Z", "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "name": "US - 18-24 - All gender", "description": "For spring promotion campaign", "type": "CUSTOM", "size": { "min": 0, "max": 0 }, "status": "PROCESSING", "sources": ["UNKNOWN"], "seed_audience_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "lookalike_audience_ids": ["ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"], "datasets": [ { "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "name": "string" } ], "included_events": ["ADDTOCART"], "excluded_events": ["PURCHASE"], "lookback_days": 30}