openapi: 3.2.0
info:
  title: Hostfully Custom Data API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Custom Data
paths:
  /api/v3.3/custom-data:
    get:
      tags:
      - Custom Data
      summary: Get the custom data
      description: Fetches all custom data for either a property or a lead. Exactly one of 'propertyUid' or 'leadUid' must be provided. For leads that are main leads in a group booking, authorization is done by the multi-unit property or master unit to which the main lead is attached to.
      operationId: getAll_19
      parameters:
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomDataApi3ResponseWrapperCustomDataApi3_1Dto'
    post:
      tags:
      - Custom Data
      summary: Create custom data
      description: Adds or updates a custom data entry for a specific property or lead.
      operationId: post_16
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDataAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomDataApiResponseWrapperCustomDataApi3_1Dto'
    delete:
      tags:
      - Custom Data
      summary: Delete custom data
      description: Deletes a custom data entry linked to a property or lead. The field is identified by 'customDataFieldUid'. Exactly one of 'propertyUid' or 'leadUid' must be provided.
      operationId: delete_15
      parameters:
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      - name: customDataFieldUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
components:
  schemas:
    CustomDataApiResponseWrapperCustomDataApi3_1Dto:
      type: object
      properties:
        customData:
          $ref: '#/components/schemas/CustomDataApi3_1Dto'
    CustomDataFieldApi3Dto:
      type: object
      properties:
        agencyUid:
          type: string
        uid:
          type: string
        type:
          type: string
          enum:
          - TEXT
          - LONG_TEXT
          - SINGLE_SELECT
        name:
          type: string
        variable:
          type: string
        index:
          type: integer
          format: int32
        minAgeToShow:
          type: integer
          format: int32
        subType:
          type: string
          enum:
          - PRIMARY_GUEST_INFORMATION
          - OTHER_GUEST_INFORMATION
          - ADDITIONAL_GUEST_INFORMATION
          - ARRIVAL_INFORMATION
          - OTHER
        usage:
          type: string
          enum:
          - CUSTOM_VARIABLES
          - PRE_ARRIVAL_FORM
          - OTHER
        isOptional:
          type: boolean
        isActive:
          type: boolean
        options:
          type: array
          items:
            $ref: '#/components/schemas/CustomDataFieldOptionDto'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    CustomDataFieldOptionDto:
      type: object
      properties:
        uid:
          type: string
        optionText:
          type: string
        optionValue:
          type: string
        sortOrder:
          type: integer
          format: int32
        active:
          type: boolean
    CustomDataApi3ResponseWrapperCustomDataApi3_1Dto:
      type: object
      properties:
        customData:
          type: array
          items:
            $ref: '#/components/schemas/CustomDataApi3_1Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    CustomDataAddingApi3Dto:
      required:
      - customDataFieldUid
      - text
      type: object
      properties:
        text:
          maxLength: 4096
          minLength: 0
          type: string
        customDataFieldUid:
          type: string
        propertyUid:
          type: string
          description: Either provide propertyUid, or leadUid
        leadUid:
          type: string
          description: Either provide propertyUid, or leadUid
    CustomDataApi3_1Dto:
      type: object
      properties:
        text:
          type: string
        customDataField:
          $ref: '#/components/schemas/CustomDataFieldApi3Dto'
        propertyUid:
          type: string
        leadUid:
          type: string
        unitUid:
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true