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

# Aampe Property Update

> Handle property updates coming from Aampe identify calls.
Expects data in the exact format needed for publishing.



## OpenAPI

````yaml /api-guide/ingestion-openapi.json post /v1/properties
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://ingestion.{region}.api.aampe.com
    description: Aampe ingestion endpoint
    variables:
      region:
        enum:
          - europe-west3
          - asia-southeast1
          - us-east1
        default: us-east1
security:
  - BearerAuth: []
externalDocs:
  description: Full Aampe Ingestion API documentation
  url: >-
    https://kb.aampe.com/developer-guide/data-ingest/data-sources/streaming-aampe-api
paths:
  /v1/properties:
    post:
      summary: Aampe Property Update
      description: |-
        Handle property updates coming from Aampe identify calls.
        Expects data in the exact format needed for publishing.
      operationId: aampe_property_update_v1_properties_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AampePropertyUpdateEvent'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
      externalDocs:
        description: Aampe Property Update - update user properties
        url: https://kb.aampe.com/api-reference/aampe-property-update
components:
  schemas:
    AampePropertyUpdateEvent:
      properties:
        contact_id:
          type: string
          title: Contact Id
          description: The user's ID
        event_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Event Name
          description: >-
            Custom suffix for the event name. Will be appended to
            'aampe_property_update_'
        timestamp:
          type: number
          title: Timestamp
          description: >-
            Unix epoch seconds (number); decimals and millisecond values
            supported.
        event_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Event Id
          description: Optional unique ID of the event
        user_properties:
          additionalProperties: true
          type: object
          title: User Properties
          description: Dictionary of property names to values
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Additional metadata dictionary for the event
      type: object
      required:
        - contact_id
        - timestamp
        - user_properties
      title: AampePropertyUpdateEvent
      description: >-
        Represents a property update event for a user.


        Note on serialization:

        Downstream consumers expect `user_properties` and (when present)
        `metadata`

        to be JSON-encoded *strings* inside the outer JSON payload.

        We implement this via Pydantic field serializers so callers can keep
        using

        native dicts in Python.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Ingestion API key. Obtain from Integrations > API keys in the Aampe
        Dashboard. See
        [Authentication](https://kb.aampe.com/api-guide/authentication) for
        details.

````