> ## 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 Property

> Requires `properties: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).



## OpenAPI

````yaml /openapi/crm.json post /properties
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:
  /properties:
    post:
      tags:
        - Properties
      summary: Create Property
      description: >-
        Requires `properties: true` in the credential's `entitiesToSync`
        selection and a connector that supports this operation. [Choose what
        data to
        sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout),
        or [fix an entity that is not configured to
        sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).
      operationId: postProperties
      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:
                loanId:
                  type: string
                personId:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    street:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    code:
                      type: string
                    county:
                      type: string
                    country:
                      type: string
                  required:
                    - type
                    - street
                    - city
                    - state
                    - code
                    - country
                type:
                  type: string
                name:
                  type: string
                mlsNumber:
                  type: string
                purchasePrice:
                  type: number
                currentValue:
                  type: number
                appraisedValue:
                  type: number
                appraisalDate:
                  nullable: true
                  type: string
                occupancyType:
                  type: string
                zoning:
                  type: string
                propertyCharacteristics:
                  type: object
                  additionalProperties: {}
                insured:
                  nullable: true
                  type: boolean
                insuranceProvider:
                  type: string
                insurancePolicyNumber:
                  type: string
              required:
                - address
                - type
                - currentValue
                - appraisalDate
                - insured
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                loanId:
                  type: string
                personId:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    street:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    code:
                      type: string
                    county:
                      type: string
                    country:
                      type: string
                  required:
                    - type
                    - street
                    - city
                    - state
                    - code
                    - country
                type:
                  type: string
                name:
                  type: string
                mlsNumber:
                  type: string
                purchasePrice:
                  type: number
                currentValue:
                  type: number
                appraisedValue:
                  type: number
                appraisalDate:
                  nullable: true
                  type: string
                occupancyType:
                  type: string
                zoning:
                  type: string
                propertyCharacteristics:
                  type: object
                  additionalProperties: {}
                insured:
                  nullable: true
                  type: boolean
                insuranceProvider:
                  type: string
                insurancePolicyNumber:
                  type: string
              required:
                - address
                - type
                - currentValue
                - appraisalDate
                - insured
          multipart/form-data:
            schema:
              type: object
              properties:
                loanId:
                  type: string
                personId:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    street:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    code:
                      type: string
                    county:
                      type: string
                    country:
                      type: string
                  required:
                    - type
                    - street
                    - city
                    - state
                    - code
                    - country
                type:
                  type: string
                name:
                  type: string
                mlsNumber:
                  type: string
                purchasePrice:
                  type: number
                currentValue:
                  type: number
                appraisedValue:
                  type: number
                appraisalDate:
                  nullable: true
                  type: string
                occupancyType:
                  type: string
                zoning:
                  type: string
                propertyCharacteristics:
                  type: object
                  additionalProperties: {}
                insured:
                  nullable: true
                  type: boolean
                insuranceProvider:
                  type: string
                insurancePolicyNumber:
                  type: string
              required:
                - address
                - type
                - currentValue
                - appraisalDate
                - insured
      responses:
        '201':
          description: The created property.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  address:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    properties:
                      type:
                        type: string
                      street:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      code:
                        type: string
                      county:
                        type: string
                      country:
                        type: string
                    required:
                      - type
                      - street
                      - city
                      - state
                      - code
                      - country
                  type:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  name:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  mlsNumber:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  purchasePrice:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: number
                  currentValue:
                    description: Present unless the request's `fields` leaves it out.
                    type: number
                  appraisedValue:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: number
                  appraisalDate:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  occupancyType:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  zoning:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  propertyCharacteristics:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: object
                    additionalProperties: {}
                  insured:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: boolean
                  insuranceProvider:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  insurancePolicyNumber:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  created:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  updated:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  numberOfUnits:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: number
                  mixedUse:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: boolean
                  manufacturedHome:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: boolean
                  rolloutUpdated:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  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
                description: The created property.
        '400':
          description: Response for status 400
          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.