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

# Create custom UTM event

> Queues a custom UTM event with user-defined fields. Only ai_contact_id is required; all other fields are optional. Accepts arbitrary JSON in additional_params.



## OpenAPI

````yaml /openapi.json post /api/public/utm-event/create
openapi: 3.0.0
info:
  title: Vambe AI API
  description: Vambe AI documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.vambe.me
    description: Production Server
security: []
tags:
  - name: Vambe AI
    description: ''
paths:
  /api/public/utm-event/create:
    post:
      tags:
        - UTM Events
      summary: Create custom UTM event
      description: >-
        Queues a custom UTM event with user-defined fields. Only ai_contact_id
        is required; all other fields are optional. Accepts arbitrary JSON in
        additional_params.
      operationId: PublicUtmEventController_createUtmEvent
      parameters:
        - name: x-api-key
          in: header
          description: API key needed to authorize the request
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicUtmEventDto'
      responses:
        '201':
          description: Event accepted for processing
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
        '401':
          description: Unauthorized
components:
  schemas:
    CreatePublicUtmEventDto:
      type: object
      properties:
        ai_contact_id:
          type: string
        customer_id:
          type: string
          nullable: true
        referrer_url:
          type: string
          nullable: true
        user_agent:
          type: string
          nullable: true
        ip_address:
          type: string
          nullable: true
        integration_type:
          type: string
          enum:
            - facebook
            - google
            - tiktok
            - snapchat
            - linkedin
            - twitter
            - pinterest
            - bing
            - facebook_whatsapp
            - facebook_instagram
            - facebook_messenger
            - unknown
          x-enumNames:
            - FACEBOOK
            - GOOGLE
            - TIKTOK
            - SNAPCHAT
            - LINKEDIN
            - TWITTER
            - PINTEREST
            - BING
            - FACEBOOK_WHATSAPP
            - FACEBOOK_INSTAGRAM
            - FACEBOOK_MESSENGER
            - UNKNOWN
          nullable: true
        campaign_id:
          type: string
          nullable: true
        ad_set_id:
          type: string
          nullable: true
        ad_id:
          type: string
          nullable: true
        ad_source_click_id:
          type: string
          nullable: true
        utm_source:
          type: string
        utm_medium:
          type: string
        utm_term:
          type: string
        utm_content:
          type: string
        utm_referrer:
          type: string
        additional_params:
          type: object
          additionalProperties: true
      required:
        - ai_contact_id
        - additional_params

````