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

# Create Event



## OpenAPI

````yaml /openapi/crm.json post /events
openapi: 3.0.3
info:
  title: Universal CRM API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://crm.universal.rollout.com/api
security: []
paths:
  /events:
    post:
      tags:
        - Events
      summary: Create Event
      operationId: postEvents
      parameters:
        - name: fields
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated top-level fields to return; the parameter can also
              be repeated, once per field. `id` is always returned. Omit it, or
              pass `allFields`, to get every field, including `original`.
              Unknown names return 400.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                personId:
                  type: string
                person:
                  type: object
                  properties:
                    id:
                      type: string
                  required:
                    - id
                noteId:
                  type: string
                propertyId:
                  type: string
                message:
                  type: string
                description:
                  type: string
                source:
                  type: string
                system:
                  type: string
                type:
                  type: string
                pageTitle:
                  type: string
                pageUrl:
                  type: string
                pageReferrer:
                  type: string
                pageDuration:
                  type: number
                occurredAt:
                  type: string
                additionalAttributes:
                  type: object
                  additionalProperties: {}
                property:
                  anyOf:
                    - type: object
                      properties:
                        id:
                          type: number
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        code:
                          type: string
                        mlsNumber:
                          type: string
                        price:
                          anyOf:
                            - type: number
                            - nullable: true
                              type: string
                        forRent:
                          type: number
                        url:
                          nullable: true
                          type: string
                        type:
                          type: string
                        bedrooms:
                          nullable: true
                          type: string
                        bathrooms:
                          nullable: true
                          type: string
                        area:
                          nullable: true
                          type: string
                        lot:
                          nullable: true
                          type: string
                        lat:
                          nullable: true
                          type: number
                        lng:
                          nullable: true
                          type: number
                      required:
                        - street
                        - city
                        - state
                    - type: object
                      properties:
                        address:
                          type: string
                        price:
                          type: number
                        beds:
                          type: number
                        baths:
                          type: number
                        sqft:
                          type: number
                propertySearch:
                  type: object
                  properties:
                    minPrice:
                      type: number
                    maxPrice:
                      type: number
                    beds:
                      type: number
                    minBaths:
                      type: number
                    maxBaths:
                      type: number
                    minSqft:
                      type: number
                    maxSqft:
                      type: number
                    minLotSize:
                      type: number
                    maxLotSize:
                      type: number
                    minYearBuilt:
                      type: number
                    maxYearBuilt:
                      type: number
                    minDaysOnSite:
                      type: number
                    maxDaysOnSite:
                      type: number
                    listingStatus:
                      type: string
                    location:
                      type: string
                    propertyType:
                      type: string
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                personId:
                  type: string
                person:
                  type: object
                  properties:
                    id:
                      type: string
                  required:
                    - id
                noteId:
                  type: string
                propertyId:
                  type: string
                message:
                  type: string
                description:
                  type: string
                source:
                  type: string
                system:
                  type: string
                type:
                  type: string
                pageTitle:
                  type: string
                pageUrl:
                  type: string
                pageReferrer:
                  type: string
                pageDuration:
                  type: number
                occurredAt:
                  type: string
                additionalAttributes:
                  type: object
                  additionalProperties: {}
                property:
                  anyOf:
                    - type: object
                      properties:
                        id:
                          type: number
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        code:
                          type: string
                        mlsNumber:
                          type: string
                        price:
                          anyOf:
                            - type: number
                            - nullable: true
                              type: string
                        forRent:
                          type: number
                        url:
                          nullable: true
                          type: string
                        type:
                          type: string
                        bedrooms:
                          nullable: true
                          type: string
                        bathrooms:
                          nullable: true
                          type: string
                        area:
                          nullable: true
                          type: string
                        lot:
                          nullable: true
                          type: string
                        lat:
                          nullable: true
                          type: number
                        lng:
                          nullable: true
                          type: number
                      required:
                        - street
                        - city
                        - state
                    - type: object
                      properties:
                        address:
                          type: string
                        price:
                          type: number
                        beds:
                          type: number
                        baths:
                          type: number
                        sqft:
                          type: number
                propertySearch:
                  type: object
                  properties:
                    minPrice:
                      type: number
                    maxPrice:
                      type: number
                    beds:
                      type: number
                    minBaths:
                      type: number
                    maxBaths:
                      type: number
                    minSqft:
                      type: number
                    maxSqft:
                      type: number
                    minLotSize:
                      type: number
                    maxLotSize:
                      type: number
                    minYearBuilt:
                      type: number
                    maxYearBuilt:
                      type: number
                    minDaysOnSite:
                      type: number
                    maxDaysOnSite:
                      type: number
                    listingStatus:
                      type: string
                    location:
                      type: string
                    propertyType:
                      type: string
          multipart/form-data:
            schema:
              type: object
              properties:
                personId:
                  type: string
                person:
                  type: object
                  properties:
                    id:
                      type: string
                  required:
                    - id
                noteId:
                  type: string
                propertyId:
                  type: string
                message:
                  type: string
                description:
                  type: string
                source:
                  type: string
                system:
                  type: string
                type:
                  type: string
                pageTitle:
                  type: string
                pageUrl:
                  type: string
                pageReferrer:
                  type: string
                pageDuration:
                  type: number
                occurredAt:
                  type: string
                additionalAttributes:
                  type: object
                  additionalProperties: {}
                property:
                  anyOf:
                    - type: object
                      properties:
                        id:
                          type: number
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        code:
                          type: string
                        mlsNumber:
                          type: string
                        price:
                          anyOf:
                            - type: number
                            - nullable: true
                              type: string
                        forRent:
                          type: number
                        url:
                          nullable: true
                          type: string
                        type:
                          type: string
                        bedrooms:
                          nullable: true
                          type: string
                        bathrooms:
                          nullable: true
                          type: string
                        area:
                          nullable: true
                          type: string
                        lot:
                          nullable: true
                          type: string
                        lat:
                          nullable: true
                          type: number
                        lng:
                          nullable: true
                          type: number
                      required:
                        - street
                        - city
                        - state
                    - type: object
                      properties:
                        address:
                          type: string
                        price:
                          type: number
                        beds:
                          type: number
                        baths:
                          type: number
                        sqft:
                          type: number
                propertySearch:
                  type: object
                  properties:
                    minPrice:
                      type: number
                    maxPrice:
                      type: number
                    beds:
                      type: number
                    minBaths:
                      type: number
                    maxBaths:
                      type: number
                    minSqft:
                      type: number
                    maxSqft:
                      type: number
                    minLotSize:
                      type: number
                    maxLotSize:
                      type: number
                    minYearBuilt:
                      type: number
                    maxYearBuilt:
                      type: number
                    minDaysOnSite:
                      type: number
                    maxDaysOnSite:
                      type: number
                    listingStatus:
                      type: string
                    location:
                      type: string
                    propertyType:
                      type: string
      responses:
        '201':
          description: Response for status 201
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  personId:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  noteId:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  propertyId:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  created:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  updated:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  rolloutUpdated:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  occurredAt:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  message:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  description:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  source:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  system:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  type:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  pageTitle:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  pageUrl:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  pageReferrer:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  pageDuration:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: number
                  property:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: object
                    additionalProperties: {}
                  propertySearch:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: object
                    additionalProperties: {}
                  additionalAttributes:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: object
                    additionalProperties: {}
                  originalIds:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: number
                        - type: string
                  original:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties: {}
                required:
                  - id
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                    enum:
                      - >-
                        Data for this credential is not ready yet. Please try
                        again.
                required:
                  - errorMessage
        '423':
          description: >-
            423 Locked — the credential is temporarily frozen by an operator.
            Reads still work; POST/PATCH/PUT/DELETE are rejected until it is
            unfrozen. Unlike 424 (invalid credential), do not re-authenticate —
            retry later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                      required:
                        - message
                required:
                  - errors
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

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