VTvtex
Campaign Audiences

Get campaign audience configuration

Changed on

Retrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name.

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/{campaignId}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/rnb/pvt/campaignConfiguration/{campaignId}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

campaignIdstring required
Example:dd270d06-1ed1-47fc-b04e-a2431121b5a4

Campaign audience unique identifier.

Headers

Content-Typestring required

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

  • 645047bc2b2cRevision changes
    • info

      response property targetConfigurations/items/coupon/items/ deprecated

  • 7a8561183291Revision changes
    • breaking

      the /// response's property type changed from string to object for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status