Sign in
Campaign Audiences

Get all campaign audiences

Retrieves a list of all campaign audiences and their respective configurations.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Rates and BenefitsManage benefits and ratesGerenciarPromocoesETarifas

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/rnb/pvt/campaignConfiguration

Headers

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

beginDateUtcstring

Start date of the campaign audience in UTC format.

endDateUtcstring

End date of the campaign audience in UTC format.

idstring

Campaign audience ID.

namestring

Campaign audience name.

isActiveboolean

Defines if the campaign audience is active (true) or not (false).

isAndOperatorboolean

When true, determines that all the targetConfigurations need to be valid for the campaign audience to be active. When false, determines that if at least one of the targetConfigurations is valid, the campaign audience will be active.

isArchivedboolean

Defines if the campaign audience is archived (true) or not (false).

Changes

Changed in 4 of the 52 revisions of this API.26

  • 645047bc2b2c1See the full diff
    • ○

      response property items/targetConfigurations/items/coupon/items/ deprecated

      response-property-deprecated

  • 7a856118329114See the full diff
    • ▲

      the items/targetConfigurations/items/collections1BuyTogether/items/ response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property items/targetConfigurations/items/collections1BuyTogether/items/id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/targetConfigurations/items/collections1BuyTogether/items/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/targetConfigurations/items/zipCodeRanges/items/zipCodeFrom to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/targetConfigurations/items/zipCodeRanges/items/zipCodeTo to the response with the 200 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e2056ec818011See the full diff
    • ○

      endpoint added

      endpoint-added

  • 649ab443f2ce1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog