SUsuperwall
Campaigns V2

Reset Audience Assignments

Changed on

Clears existing user-to-variant assignments for one treatment variant when variant_id is provided as a query parameter, or every live variant when omitted, so affected users are re-bucketed on their next evaluation. Requires campaigns:write scope.

post/v2/campaigns/{id}/audiences/{audience_id}/reset

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/campaigns/{id}/audiences/{audience_id}/reset
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required
audience_idstring required

Query parameters

variant_idstring

Treatment variant to reset. Omit to reset all audience assignments.

Response

Success

idstring required
object'audience' required

Object type, always audience

enabledboolean required

Whether this audience is enabled

expressionstring nullable required

Compiled filter expression for matching users, or null for all users

rule_conditionsunknown required
expression_celstring nullable required

The CEL expression evaluated by modern SDKs, derived from rule_conditions. Null when the audience has no structured rule.

expression_sqlstring nullable required

The dashboard-side SQL compilation of rule_conditions (for preview/copy). Null when the audience has no structured rule.

rankstring required

Priority rank of this audience within the campaign

descriptionstring nullable required

Human-readable description of the audience

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • bfb85c07a3d3Revision changes
    • info

      added the new optional query request parameter variant_id