> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bevits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar segmento por engajamento em campanha

> Salva os clientes da prévia, com os mesmos critérios, como um novo segmento pronto para ser escolhido como público de uma campanha. Quem interagiu fica congelado no momento da criação; o período de compras é conferido de novo a cada envio, então quem comprar depois sai do público. Nada é enviado. Se o nome já estiver em uso, a Bevits acrescenta um número ao final. Exige uma API key com o escopo write.



## OpenAPI

````yaml /openapi.json post /v1/segments/campaign-engagement
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits, criar automações como rascunho para revisão e ativação,
    criar campanhas de WhatsApp Oficial como rascunho e montar segmentos e tags
    de clientes.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
  - name: Conta e marca
    description: Contexto da conta, identidade da marca e imagens.
  - name: Receitas
    description: Automações prontas criadas a partir de receitas, com desfazer.
  - name: Templates de e-mail
    description: Criação e importação de templates de e-mail.
  - name: Eventos
    description: Eventos personalizados enviados pela loja e seus tipos.
paths:
  /v1/segments/campaign-engagement:
    post:
      tags:
        - Segmentos
      summary: Criar segmento por engajamento em campanha
      description: >-
        Salva os clientes da prévia, com os mesmos critérios, como um novo
        segmento pronto para ser escolhido como público de uma campanha. Quem
        interagiu fica congelado no momento da criação; o período de compras é
        conferido de novo a cada envio, então quem comprar depois sai do
        público. Nada é enviado. Se o nome já estiver em uso, a Bevits
        acrescenta um número ao final. Exige uma API key com o escopo write.
      operationId: createCampaignEngagementSegment
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCampaignEngagementSegmentRequest'
            example:
              name: 'Black Friday: leram ou clicaram, sem compra em novembro'
              campaign_ids:
                - tcp_8f2k1m
                - tcp_3j9x0a
              engagement: engaged
              purchases: none
              purchases_from: '2026-11-01T00:00:00-03:00'
      responses:
        '200':
          $ref: '#/components/responses/CampaignEngagementSegment'
        '400':
          $ref: '#/components/responses/InvalidBody'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WriteScopeRequired'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave única da operação. Repetir a mesma chave com o mesmo corpo devolve
        a resposta original em vez de executar de novo.
      schema:
        type: string
  schemas:
    CreateCampaignEngagementSegmentRequest:
      type: object
      required:
        - campaign_ids
        - engagement
        - name
      properties:
        campaign_ids:
          type: array
          items:
            type: string
            pattern: ^tcp_[A-Za-z0-9_-]+$
          minItems: 1
          maxItems: 50
          description: IDs das campanhas de WhatsApp Oficial (tcp_...), até 50.
        engagement:
          type: string
          enum:
            - engaged
            - not_engaged
            - received
          description: >-
            engaged: leu a mensagem ou clicou em um link dela. not_engaged: a
            mensagem foi entregue e a pessoa não leu nem clicou. received: a
            mensagem foi entregue.
        purchases:
          type: string
          enum:
            - none
            - any
          description: >-
            Mantém quem não tem (none) ou tem (any) compra concluída no período.
            Exige purchases_from.
        purchases_from:
          type: string
          format: date-time
          description: Início do período de compras (inclusivo), em ISO 8601 com fuso.
        purchases_to:
          type: string
          format: date-time
          description: >-
            Fim do período de compras (exclusivo), em ISO 8601 com fuso. Sem
            ele, o período fica aberto.
        only_site_base:
          type: boolean
          default: true
          description: >-
            Se true (padrão), deixa de fora os clientes que pertencem só às
            unidades físicas, como nas campanhas da marca.
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Nome do segmento. Se já estiver em uso, a Bevits acrescenta um
            número ao final.
        description:
          type: string
          maxLength: 1000
        operation_id:
          $ref: '#/components/schemas/OperationId'
    OperationId:
      type: string
      minLength: 8
      maxLength: 128
      description: >-
        Identificador único opcional desta chamada, como um UUID. Repita o mesmo
        valor só para tentar de novo a mesma chamada: a nova tentativa devolve o
        primeiro resultado em vez de criar de novo. O mesmo valor com outro
        conteúdo é recusado com 409.
    CampaignEngagementSegment:
      type: object
      required:
        - object
        - segment
        - customers_added
        - reachable_count
        - breakdown
        - snapshot_at
        - next_step
      properties:
        object:
          type: string
          const: campaign_engagement_segment
        segment:
          $ref: '#/components/schemas/Segment'
        customers_added:
          type: integer
          minimum: 0
        reachable_count:
          type: integer
          minimum: 0
        breakdown:
          $ref: '#/components/schemas/CampaignEngagementBreakdown'
        snapshot_at:
          type: string
          format: date-time
        next_step:
          type: string
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    Segment:
      type: object
      required:
        - object
        - id
        - created_at
        - updated_at
        - html_url
      properties:
        object:
          type: string
          const: segment
        id:
          type: string
          pattern: ^seg_[A-Za-z0-9_-]+$
        name:
          type: string
        description:
          type: string
        type:
          type: string
          enum:
            - static
            - filters
            - rfm
            - campaign_engagement
          description: >-
            static: clientes adicionados manualmente. filters: quem atende às
            condições no momento, mais quem foi adicionado manualmente. rfm:
            mantido pela Bevits. campaign_engagement: engajamento em campanha
            registrado na criação.
        match:
          $ref: '#/components/schemas/SegmentMatch'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/SegmentCondition'
          description: >-
            Condições de um segmento por filtros, no mesmo formato aceito na
            criação e na atualização.
        customer_count:
          type: integer
          minimum: 0
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        html_url:
          type: string
          format: uri
    CampaignEngagementBreakdown:
      type: object
      required:
        - engaged
        - not_engaged
        - not_received
      properties:
        engaged:
          type: integer
          minimum: 0
        not_engaged:
          type: integer
          minimum: 0
        not_received:
          type: integer
          minimum: 0
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        code:
          type: string
          description: >-
            Motivo estável e legível por máquina dentro de type, como
            invalid_event_name. Presente quando o erro tem um motivo nomeado.
        message:
          type: string
        param:
          type: string
          description: >-
            Caminho completo do campo com problema, como customer.email ou
            events[3].name.
        suggestion:
          type: string
          description: Um valor que seria aceito, quando existe um óbvio.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
    SegmentMatch:
      type: string
      enum:
        - all
        - any
      description: >-
        all: clientes que atendem a todas as condições. any: clientes que
        atendem a pelo menos uma.
    SegmentCondition:
      description: >-
        Uma condição de um segmento por filtros. O mesmo formato entra na
        criação, na atualização e na prévia e volta em GET
        /v1/segments/{segment_id}.
      oneOf:
        - $ref: '#/components/schemas/SegmentFieldCondition'
        - $ref: '#/components/schemas/SegmentTagsCondition'
        - $ref: '#/components/schemas/SegmentProductCondition'
        - $ref: '#/components/schemas/SegmentCouponCondition'
      discriminator:
        propertyName: kind
        mapping:
          field: '#/components/schemas/SegmentFieldCondition'
          tags: '#/components/schemas/SegmentTagsCondition'
          product: '#/components/schemas/SegmentProductCondition'
          coupon: '#/components/schemas/SegmentCouponCondition'
    SegmentFieldCondition:
      type: object
      additionalProperties: false
      required:
        - kind
        - field
        - operator
      properties:
        kind:
          type: string
          const: field
        field:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            Um campo do cliente (como totalSpentInCents, lastPurchaseDate ou
            city) ou o ID de um atributo personalizado (atr_...), do catálogo de
            filtros.
        operator:
          type: string
          minLength: 1
          maxLength: 32
          description: >-
            Um dos operadores do campo no catálogo. Texto: eq, neq, in, not_in,
            contains, not_contains, starts_with, is_null, is_not_null. Número:
            eq, neq, gt, gte, lt, lte. Booleano: eq_true, eq_false, is_null,
            is_not_null. Data: gt, lt, between.
        value:
          description: >-
            Omita em is_null, is_not_null, eq_true e eq_false. Uma lista em in e
            not_in. Dinheiro em centavos. Datas em ISO 8601 com fuso.
          oneOf:
            - type: string
              maxLength: 512
            - type: number
            - type: boolean
            - type: array
              items:
                type: string
                minLength: 1
                maxLength: 256
              minItems: 1
              maxItems: 500
        value_to:
          description: Fim de um intervalo between.
          oneOf:
            - type: string
              maxLength: 64
            - type: number
    SegmentTagsCondition:
      type: object
      additionalProperties: false
      required:
        - kind
        - operator
        - tag_ids
      properties:
        kind:
          type: string
          const: tags
        operator:
          type: string
          enum:
            - has_any
            - has_all
            - has_none
          description: >-
            has_any: tem alguma das tags. has_all: tem todas. has_none: não tem
            nenhuma, inclusive quem não tem tag.
        tag_ids:
          type: array
          items:
            type: string
            pattern: ^tag_[A-Za-z0-9_-]+$
          minItems: 1
          maxItems: 50
          description: IDs das tags (tag_...), de GET /v1/tags.
    SegmentProductCondition:
      type: object
      additionalProperties: false
      required:
        - kind
        - operator
      properties:
        kind:
          type: string
          const: product
        operator:
          type: string
          enum:
            - has_purchased
            - has_not_purchased
            - purchased_in_category
        product_id:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            ID do produto na loja, como nos itens das compras. Para
            has_purchased e has_not_purchased.
        category:
          type: string
          minLength: 1
          maxLength: 256
          description: Nome da categoria do produto. Para purchased_in_category.
    SegmentCouponCondition:
      type: object
      additionalProperties: false
      required:
        - kind
        - status
      description: >-
        Cupons e cashback (giftback) que a Bevits gerou para o cliente nas
        automações, no atendimento com IA e nas vendas das lojas físicas.
      properties:
        kind:
          type: string
          const: coupon
        status:
          type: string
          enum:
            - has_available
            - has_unused
            - has_expired_unused
            - has_used
            - has_received
            - has_not_received
          description: >-
            has_available: tem cupom não usado e dentro da validade, com saldo
            para usar agora. has_unused: tem cupom que nunca usou, vencido ou
            não. has_expired_unused: deixou um cupom vencer sem usar. has_used:
            usou um cupom numa compra. has_received: recebeu um cupom.
            has_not_received: nunca recebeu um cupom.
        source:
          type: string
          enum:
            - cashback
            - any
            - flows
          default: cashback
          description: >-
            cashback: cupons gerados por uma compra (cashback ou giftback,
            online ou na loja física). any: todos os cupons que a Bevits gerou
            para o cliente. flows: só os cupons das automações em flow_ids.
        flow_ids:
          type: array
          items:
            type: string
            pattern: ^flw_[A-Za-z0-9_-]+$
          minItems: 1
          maxItems: 50
          description: 'Com source flows: automações que geram cupons, listadas no catálogo.'
        received_within_days:
          type: integer
          minimum: 1
          maximum: 3650
          description: Só cupons gerados nos últimos N dias.
        expires_within_days:
          type: integer
          minimum: 1
          maximum: 365
          description: 'Com has_available: só cupons que vencem nos próximos N dias.'
  responses:
    CampaignEngagementSegment:
      description: Segmento por engajamento criado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CampaignEngagementSegment'
    InvalidBody:
      description: >-
        Corpo da requisição ausente, que não é um objeto JSON, ou parâmetro de
        rota inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    WriteScopeRequired:
      description: A API key não tem o escopo write.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: permission_denied
              code: missing_scope
              message: This API key does not have the required "write" scope.
              param: scope
              request_id: req_07f6cdc3c20249d6afcd90b4
    IdempotencyConflict:
      description: A Idempotency-Key já foi usada com outro corpo de requisição.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Um parâmetro não passou pela validação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.