v1
latestOpenAPI 3.0.42026-08-04342835917.6 KBPatches an existing audience.
Path parameters
The unique identifier of the audience to update.
Request body
The new name to give to this audience.
The new description for the audience. Supports markdown. Set to null to remove.
Minimum graduated users before disabling distilling boost. When graduated count is below this, external distilling audience ID is added to campaign boosting.
Minimum distilling users before disabling global boost. When distilling count is below this, GlobalBoostLevel is set above zero.
Maximum responses before user exits the distilling campaign. Set to null to disable this exit condition.
Minimum responses before the drop score check applies. Users need at least this many responses before they can be kicked out for low score. Set to null to apply drop score check from the first response.
Score floor - users below this score exit the distilling campaign (only after completing DropMinResponses). Set to null to disable this exit condition.
Maximum sessions (rapid retrievals) before user exits the distilling campaign. Set to a value to enable session-based exit condition.
Number of days of inactivity before a distilling user is dropped. Set to null to disable this exit condition.
Minimum submission rate (responses / sessions) before a user is dropped. Set to null to disable this exit condition.
Minimum number of sessions before the submission rate check applies. Set to null to apply from the first session.
Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users. Set a lower value to be more lenient with graduated users.
Response
OK
The id of the audience state recalculation that was dispatched as a result of this update. Only populated when state-affecting parameters (e.g. graduation score, drop score) changed; null when the update only touched descriptive fields or boost configuration.
The id of the audience inactivity sync that was dispatched as a result of this update. Only populated when InactivityDropDays was changed to a non-null value; null otherwise.