# Structurely Direct v2

## Overview

The Structurely API allows integrators to provide automation for their accounts. It offers various functionalities to streamline lead management, messaging, lead qualification conversations, and retrieval of metadata.

The Structurely API simplifies the integration process and removes the necessity to track additional fields in your system. It is specifically designed to utilize **your system's IDs** as internal keys, enabling you to seamlessly use IDs from your CRM or database as parameters, such as externalLeadId, and externalMessageId.

By utilizing this API, integrators can streamline their workflows, activate enhanced AI qualification conversations, and gain valuable insights into their accounts, leads, and conversations.

### Security

The Structurely API provides secure authentication and authorization mechanisms to ensure controlled access to its endpoints. The authentication system utilizes API tokens to secure interactions with the API.

Types of tokens and keys:

  
- bearer-access-token: Bearer JWT; **valid until deactivated**

**Note:** It is essential to keep your bearer-access-tokens secure and avoid sharing them with unauthorized parties to maintain the integrity and security of your Structurely API integration.

Version: `v3.35.20`

## Accounts

- [GET /api/direct/v2/accounts](/api/direct/v2/accounts/get.md)
- [PATCH /api/direct/v2/accounts](/api/direct/v2/accounts/patch.md)

### GET /api/direct/v2/accounts

[GET /api/direct/v2/accounts](/api/direct/v2/accounts/get.md)

**Summary:** Retrieve account settings

**Description:**

Retrieve the authenticated account. Requires read:account or write:account scope.

#### Responses

- `200`: Account settings
  - Schema: `Account`
  ```json
  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "readOnly": true
      },
      "name": {
        "type": "string",
        "readOnly": true
      },
      "phone": {
        "type": "string",
        "readOnly": true,
        "nullable": true
      },
      "settings": {
        "readOnly": true,
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountSettings"
          }
        ]
      }
    },
    "required": [
      "id",
      "name",
      "phone",
      "settings"
    ]
  }
  ```
- `400`: Invalid request, check response message
  - Schema: `InvalidRequest`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "The parameter leadId must be provided"
      },
      "statusCode": {
        "type": "number",
        "example": 400
      }
    }
  }
  ```
- `401`: Request is not authorized
  - Schema: `NotAuthorized`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Access Token is not authorized"
      },
      "statusCode": {
        "type": "number",
        "example": 401
      }
    }
  }
  ```
- `404`: Resource was not found, check response message
  - Schema: `NotFound`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Lead not found"
      },
      "statusCode": {
        "type": "number",
        "example": 404
      }
    }
  }
  ```
- `500`: Internal server error, check response message
  - Schema: `InternalServerError`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Internal server error"
      },
      "statusCode": {
        "type": "number",
        "example": 500
      }
    }
  }
  ```

#### Security

- `bearer-access-token`

#### Example request

```bash
curl -sS -X GET 'https://client.structurely.com/api/direct/v2/accounts' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $STRUCTURELY_API_TOKEN"
```

### PATCH /api/direct/v2/accounts

[PATCH /api/direct/v2/accounts](/api/direct/v2/accounts/patch.md)

**Summary:** Update account settings

**Description:**

Update the authenticated account. Omitted fields preserve their existing values. Requires write:account scope.

#### Request body

Account fields to update.

Schema: `PatchAccount`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "settings": {
      "$ref": "#/components/schemas/PatchAccountSettings"
    }
  }
}
```

#### Responses

- `200`: Updated account settings
  - Schema: `Account`
  ```json
  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "readOnly": true
      },
      "name": {
        "type": "string",
        "readOnly": true
      },
      "phone": {
        "type": "string",
        "readOnly": true,
        "nullable": true
      },
      "settings": {
        "readOnly": true,
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountSettings"
          }
        ]
      }
    },
    "required": [
      "id",
      "name",
      "phone",
      "settings"
    ]
  }
  ```
- `400`: Invalid request, check response message
  - Schema: `InvalidRequest`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "The parameter leadId must be provided"
      },
      "statusCode": {
        "type": "number",
        "example": 400
      }
    }
  }
  ```
- `401`: Request is not authorized
  - Schema: `NotAuthorized`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Access Token is not authorized"
      },
      "statusCode": {
        "type": "number",
        "example": 401
      }
    }
  }
  ```
- `404`: Resource was not found, check response message
  - Schema: `NotFound`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Lead not found"
      },
      "statusCode": {
        "type": "number",
        "example": 404
      }
    }
  }
  ```
- `500`: Internal server error, check response message
  - Schema: `InternalServerError`
  ```json
  {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "description": "A message describing the error",
        "example": "Internal server error"
      },
      "statusCode": {
        "type": "number",
        "example": 500
      }
    }
  }
  ```

#### Security

- `bearer-access-token`

#### Example request

```bash
curl -sS -X PATCH 'https://client.structurely.com/api/direct/v2/accounts' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $STRUCTURELY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Schemas

### `Account`

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "phone": {
      "type": "string",
      "readOnly": true,
      "nullable": true
    },
    "settings": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountSettings"
        }
      ]
    }
  },
  "required": [
    "id",
    "name",
    "phone",
    "settings"
  ]
}
```

### `AccountAppointmentScheduling`

```json
{
  "type": "object",
  "properties": {
    "scheduleOnHolidays": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether appointments may be scheduled on holidays.",
      "example": true
    },
    "minimumBusinessDaysUntilSchedule": {
      "type": "integer",
      "readOnly": true,
      "description": "Minimum business days required before an appointment may be scheduled.",
      "example": 1,
      "nullable": true
    },
    "minimumHoursUntilSchedule": {
      "type": "integer",
      "readOnly": true,
      "minimum": 1,
      "maximum": 12,
      "description": "Minimum hours required before an appointment may be scheduled.",
      "example": 4
    },
    "maximumBusinessDaysBeforeSchedule": {
      "type": "integer",
      "readOnly": true,
      "description": "Maximum business days in advance an appointment may be scheduled; null or zero means no maximum.",
      "example": 30,
      "nullable": true
    }
  },
  "required": [
    "maximumBusinessDaysBeforeSchedule",
    "minimumBusinessDaysUntilSchedule",
    "minimumHoursUntilSchedule",
    "scheduleOnHolidays"
  ]
}
```

### `AccountHoursOfOperation`

```json
{
  "type": "object",
  "properties": {
    "monday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "tuesday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "wednesday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "thursday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "friday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "saturday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    },
    "sunday": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/AccountHoursOfOperationMode"
      }
    }
  },
  "required": [
    "friday",
    "monday",
    "saturday",
    "sunday",
    "thursday",
    "tuesday",
    "wednesday"
  ]
}
```

### `AccountHoursOfOperationMode`

```json
{
  "type": "object",
  "properties": {
    "time": {
      "type": "string",
      "enum": [
        "12a",
        "1a",
        "2a",
        "3a",
        "4a",
        "5a",
        "6a",
        "7a",
        "8a",
        "9a",
        "10a",
        "11a",
        "12p",
        "1p",
        "2p",
        "3p",
        "4p",
        "5p",
        "6p",
        "7p",
        "8p",
        "9p",
        "10p",
        "11p"
      ]
    },
    "mode": {
      "type": "string",
      "enum": [
        "active",
        "sleep"
      ]
    }
  },
  "required": [
    "mode",
    "time"
  ]
}
```

### `AccountSettings`

```json
{
  "type": "object",
  "properties": {
    "defaultChatbotName": {
      "type": "string",
      "readOnly": true
    },
    "chatbotHoursOfOperation": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountHoursOfOperation"
        }
      ]
    },
    "callingHoursOfOperation": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountHoursOfOperation"
        }
      ]
    },
    "timeZone": {
      "type": "string",
      "readOnly": true
    },
    "industries": {
      "type": "array",
      "readOnly": true,
      "items": {
        "type": "string",
        "enum": [
          "real_estate",
          "mortgage",
          "software",
          "solar",
          "insurance",
          "travel",
          "automotive",
          "support",
          "home_services",
          "financial_services",
          "recruiting",
          "other"
        ]
      }
    },
    "leadTypes": {
      "type": "array",
      "readOnly": true,
      "items": {
        "type": "string",
        "enum": [
          "buyer",
          "seller",
          "renter",
          "rent_to_own",
          "new_home_loan",
          "home_refinance",
          "auto_insurance",
          "crop_insurance",
          "home_insurance",
          "life_insurance",
          "long_term_disability_insurance",
          "mortgage_insurance",
          "pet_insurance",
          "recruiting_insurance",
          "renters_insurance",
          "travel_insurance",
          "umbrella_insurance",
          "bathroom",
          "deck",
          "door",
          "flooring",
          "gutter_guard",
          "gutters",
          "patio",
          "roofing",
          "screened_porch_sunroom",
          "siding",
          "solar",
          "windows",
          "wealth_management",
          "used_vehicle",
          "new_vehicle",
          "inbound_recruit",
          "outbound_recruit"
        ]
      }
    },
    "fauxAgentsInheritHoursOfOperation": {
      "type": "boolean",
      "readOnly": true
    },
    "allowMultiConversations": {
      "type": "boolean",
      "readOnly": true
    },
    "appointmentScheduling": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountAppointmentScheduling"
        }
      ]
    }
  },
  "required": [
    "allowMultiConversations",
    "appointmentScheduling",
    "callingHoursOfOperation",
    "chatbotHoursOfOperation",
    "defaultChatbotName",
    "fauxAgentsInheritHoursOfOperation",
    "industries",
    "leadTypes",
    "timeZone"
  ]
}
```

### `InternalServerError`

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A message describing the error",
      "example": "Internal server error"
    },
    "statusCode": {
      "type": "number",
      "example": 500
    }
  }
}
```

### `InvalidRequest`

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A message describing the error",
      "example": "The parameter leadId must be provided"
    },
    "statusCode": {
      "type": "number",
      "example": 400
    }
  }
}
```

### `NotAuthorized`

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A message describing the error",
      "example": "Access Token is not authorized"
    },
    "statusCode": {
      "type": "number",
      "example": 401
    }
  }
}
```

### `NotFound`

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A message describing the error",
      "example": "Lead not found"
    },
    "statusCode": {
      "type": "number",
      "example": 404
    }
  }
}
```

### `PatchAccount`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "settings": {
      "$ref": "#/components/schemas/PatchAccountSettings"
    }
  }
}
```

### `PatchAccountAppointmentScheduling`

```json
{
  "type": "object",
  "properties": {
    "scheduleOnHolidays": {
      "type": "boolean",
      "description": "Whether appointments may be scheduled on holidays.",
      "example": true
    },
    "minimumBusinessDaysUntilSchedule": {
      "type": "integer",
      "minimum": 0,
      "description": "Minimum business days required before an appointment may be scheduled.",
      "example": 1,
      "nullable": true
    },
    "minimumHoursUntilSchedule": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "description": "Minimum hours required before an appointment may be scheduled.",
      "example": 4
    },
    "maximumBusinessDaysBeforeSchedule": {
      "type": "integer",
      "minimum": 0,
      "description": "Maximum business days in advance an appointment may be scheduled; null or zero means no maximum.",
      "example": 30,
      "nullable": true
    }
  }
}
```

### `PatchAccountSettings`

```json
{
  "type": "object",
  "properties": {
    "defaultChatbotName": {
      "type": "string"
    },
    "chatbotHoursOfOperation": {
      "$ref": "#/components/schemas/AccountHoursOfOperation"
    },
    "callingHoursOfOperation": {
      "$ref": "#/components/schemas/AccountHoursOfOperation"
    },
    "timeZone": {
      "type": "string",
      "enum": [
        "Africa/Abidjan",
        "Africa/Accra",
        "Africa/Addis_Ababa",
        "Africa/Algiers",
        "Africa/Asmara",
        "Africa/Bamako",
        "Africa/Bangui",
        "Africa/Banjul",
        "Africa/Bissau",
        "Africa/Blantyre",
        "Africa/Brazzaville",
        "Africa/Bujumbura",
        "Africa/Cairo",
        "Africa/Casablanca",
        "Africa/Ceuta",
        "Africa/Conakry",
        "Africa/Dakar",
        "Africa/Dar_es_Salaam",
        "Africa/Djibouti",
        "Africa/Douala",
        "Africa/El_Aaiun",
        "Africa/Freetown",
        "Africa/Gaborone",
        "Africa/Harare",
        "Africa/Johannesburg",
        "Africa/Juba",
        "Africa/Kampala",
        "Africa/Khartoum",
        "Africa/Kigali",
        "Africa/Kinshasa",
        "Africa/Lagos",
        "Africa/Libreville",
        "Africa/Lome",
        "Africa/Luanda",
        "Africa/Lubumbashi",
        "Africa/Lusaka",
        "Africa/Malabo",
        "Africa/Maputo",
        "Africa/Maseru",
        "Africa/Mbabane",
        "Africa/Mogadishu",
        "Africa/Monrovia",
        "Africa/Nairobi",
        "Africa/Ndjamena",
        "Africa/Niamey",
        "Africa/Nouakchott",
        "Africa/Ouagadougou",
        "Africa/Porto-Novo",
        "Africa/Sao_Tome",
        "Africa/Tripoli",
        "Africa/Tunis",
        "Africa/Windhoek",
        "America/Adak",
        "America/Anchorage",
        "America/Anguilla",
        "America/Antigua",
        "America/Araguaina",
        "America/Argentina/Buenos_Aires",
        "America/Argentina/Catamarca",
        "America/Argentina/Cordoba",
        "America/Argentina/Jujuy",
        "America/Argentina/La_Rioja",
        "America/Argentina/Mendoza",
        "America/Argentina/Rio_Gallegos",
        "America/Argentina/Salta",
        "America/Argentina/San_Juan",
        "America/Argentina/San_Luis",
        "America/Argentina/Tucuman",
        "America/Argentina/Ushuaia",
        "America/Aruba",
        "America/Asuncion",
        "America/Atikokan",
        "America/Bahia",
        "America/Bahia_Banderas",
        "America/Barbados",
        "America/Belem",
        "America/Belize",
        "America/Blanc-Sablon",
        "America/Boa_Vista",
        "America/Bogota",
        "America/Boise",
        "America/Cambridge_Bay",
        "America/Campo_Grande",
        "America/Cancun",
        "America/Caracas",
        "America/Cayenne",
        "America/Cayman",
        "America/Chicago",
        "America/Chihuahua",
        "America/Ciudad_Juarez",
        "America/Costa_Rica",
        "America/Creston",
        "America/Cuiaba",
        "America/Curacao",
        "America/Danmarkshavn",
        "America/Dawson",
        "America/Dawson_Creek",
        "America/Denver",
        "America/Detroit",
        "America/Dominica",
        "America/Edmonton",
        "America/Eirunepe",
        "America/El_Salvador",
        "America/Fort_Nelson",
        "America/Fortaleza",
        "America/Glace_Bay",
        "America/Goose_Bay",
        "America/Grand_Turk",
        "America/Grenada",
        "America/Guadeloupe",
        "America/Guatemala",
        "America/Guayaquil",
        "America/Guyana",
        "America/Halifax",
        "America/Havana",
        "America/Hermosillo",
        "America/Indiana/Indianapolis",
        "America/Indiana/Knox",
        "America/Indiana/Marengo",
        "America/Indiana/Petersburg",
        "America/Indiana/Tell_City",
        "America/Indiana/Vevay",
        "America/Indiana/Vincennes",
        "America/Indiana/Winamac",
        "America/Inuvik",
        "America/Iqaluit",
        "America/Jamaica",
        "America/Juneau",
        "America/Kentucky/Louisville",
        "America/Kentucky/Monticello",
        "America/Kralendijk",
        "America/La_Paz",
        "America/Lima",
        "America/Los_Angeles",
        "America/Lower_Princes",
        "America/Maceio",
        "America/Managua",
        "America/Manaus",
        "America/Marigot",
        "America/Martinique",
        "America/Matamoros",
        "America/Mazatlan",
        "America/Menominee",
        "America/Merida",
        "America/Metlakatla",
        "America/Mexico_City",
        "America/Miquelon",
        "America/Moncton",
        "America/Monterrey",
        "America/Montevideo",
        "America/Montserrat",
        "America/Nassau",
        "America/New_York",
        "America/Nome",
        "America/Noronha",
        "America/North_Dakota/Beulah",
        "America/North_Dakota/Center",
        "America/North_Dakota/New_Salem",
        "America/Nuuk",
        "America/Ojinaga",
        "America/Panama",
        "America/Paramaribo",
        "America/Phoenix",
        "America/Port-au-Prince",
        "America/Port_of_Spain",
        "America/Porto_Velho",
        "America/Puerto_Rico",
        "America/Punta_Arenas",
        "America/Rankin_Inlet",
        "America/Recife",
        "America/Regina",
        "America/Resolute",
        "America/Rio_Branco",
        "America/Santarem",
        "America/Santiago",
        "America/Santo_Domingo",
        "America/Sao_Paulo",
        "America/Scoresbysund",
        "America/Sitka",
        "America/St_Barthelemy",
        "America/St_Johns",
        "America/St_Kitts",
        "America/St_Lucia",
        "America/St_Thomas",
        "America/St_Vincent",
        "America/Swift_Current",
        "America/Tegucigalpa",
        "America/Thule",
        "America/Tijuana",
        "America/Toronto",
        "America/Tortola",
        "America/Vancouver",
        "America/Whitehorse",
        "America/Winnipeg",
        "America/Yakutat",
        "Antarctica/Casey",
        "Antarctica/Davis",
        "Antarctica/DumontDUrville",
        "Antarctica/Macquarie",
        "Antarctica/Mawson",
        "Antarctica/McMurdo",
        "Antarctica/Palmer",
        "Antarctica/Rothera",
        "Antarctica/Syowa",
        "Antarctica/Troll",
        "Antarctica/Vostok",
        "Arctic/Longyearbyen",
        "Asia/Aden",
        "Asia/Almaty",
        "Asia/Amman",
        "Asia/Anadyr",
        "Asia/Aqtau",
        "Asia/Aqtobe",
        "Asia/Ashgabat",
        "Asia/Atyrau",
        "Asia/Baghdad",
        "Asia/Bahrain",
        "Asia/Baku",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Beirut",
        "Asia/Bishkek",
        "Asia/Brunei",
        "Asia/Chita",
        "Asia/Choibalsan",
        "Asia/Colombo",
        "Asia/Damascus",
        "Asia/Dhaka",
        "Asia/Dili",
        "Asia/Dubai",
        "Asia/Dushanbe",
        "Asia/Famagusta",
        "Asia/Gaza",
        "Asia/Hebron",
        "Asia/Ho_Chi_Minh",
        "Asia/Hong_Kong",
        "Asia/Hovd",
        "Asia/Irkutsk",
        "Asia/Jakarta",
        "Asia/Jayapura",
        "Asia/Jerusalem",
        "Asia/Kabul",
        "Asia/Kamchatka",
        "Asia/Karachi",
        "Asia/Kathmandu",
        "Asia/Khandyga",
        "Asia/Kolkata",
        "Asia/Krasnoyarsk",
        "Asia/Kuala_Lumpur",
        "Asia/Kuching",
        "Asia/Kuwait",
        "Asia/Macau",
        "Asia/Magadan",
        "Asia/Makassar",
        "Asia/Manila",
        "Asia/Muscat",
        "Asia/Nicosia",
        "Asia/Novokuznetsk",
        "Asia/Novosibirsk",
        "Asia/Omsk",
        "Asia/Oral",
        "Asia/Phnom_Penh",
        "Asia/Pontianak",
        "Asia/Pyongyang",
        "Asia/Qatar",
        "Asia/Qostanay",
        "Asia/Qyzylorda",
        "Asia/Riyadh",
        "Asia/Sakhalin",
        "Asia/Samarkand",
        "Asia/Seoul",
        "Asia/Shanghai",
        "Asia/Singapore",
        "Asia/Srednekolymsk",
        "Asia/Taipei",
        "Asia/Tashkent",
        "Asia/Tbilisi",
        "Asia/Tehran",
        "Asia/Thimphu",
        "Asia/Tokyo",
        "Asia/Tomsk",
        "Asia/Ulaanbaatar",
        "Asia/Urumqi",
        "Asia/Ust-Nera",
        "Asia/Vientiane",
        "Asia/Vladivostok",
        "Asia/Yakutsk",
        "Asia/Yangon",
        "Asia/Yekaterinburg",
        "Asia/Yerevan",
        "Atlantic/Azores",
        "Atlantic/Bermuda",
        "Atlantic/Canary",
        "Atlantic/Cape_Verde",
        "Atlantic/Faroe",
        "Atlantic/Madeira",
        "Atlantic/Reykjavik",
        "Atlantic/South_Georgia",
        "Atlantic/St_Helena",
        "Atlantic/Stanley",
        "Australia/Adelaide",
        "Australia/Brisbane",
        "Australia/Broken_Hill",
        "Australia/Darwin",
        "Australia/Eucla",
        "Australia/Hobart",
        "Australia/Lindeman",
        "Australia/Lord_Howe",
        "Australia/Melbourne",
        "Australia/Perth",
        "Australia/Sydney",
        "Canada/Atlantic",
        "Canada/Central",
        "Canada/Eastern",
        "Canada/Mountain",
        "Canada/Newfoundland",
        "Canada/Pacific",
        "Europe/Amsterdam",
        "Europe/Andorra",
        "Europe/Astrakhan",
        "Europe/Athens",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Bucharest",
        "Europe/Budapest",
        "Europe/Busingen",
        "Europe/Chisinau",
        "Europe/Copenhagen",
        "Europe/Dublin",
        "Europe/Gibraltar",
        "Europe/Guernsey",
        "Europe/Helsinki",
        "Europe/Isle_of_Man",
        "Europe/Istanbul",
        "Europe/Jersey",
        "Europe/Kaliningrad",
        "Europe/Kirov",
        "Europe/Kyiv",
        "Europe/Lisbon",
        "Europe/Ljubljana",
        "Europe/London",
        "Europe/Luxembourg",
        "Europe/Madrid",
        "Europe/Malta",
        "Europe/Mariehamn",
        "Europe/Minsk",
        "Europe/Monaco",
        "Europe/Moscow",
        "Europe/Oslo",
        "Europe/Paris",
        "Europe/Podgorica",
        "Europe/Prague",
        "Europe/Riga",
        "Europe/Rome",
        "Europe/Samara",
        "Europe/San_Marino",
        "Europe/Sarajevo",
        "Europe/Saratov",
        "Europe/Simferopol",
        "Europe/Skopje",
        "Europe/Sofia",
        "Europe/Stockholm",
        "Europe/Tallinn",
        "Europe/Tirane",
        "Europe/Ulyanovsk",
        "Europe/Vaduz",
        "Europe/Vatican",
        "Europe/Vienna",
        "Europe/Vilnius",
        "Europe/Volgograd",
        "Europe/Warsaw",
        "Europe/Zagreb",
        "Europe/Zurich",
        "GMT",
        "Indian/Antananarivo",
        "Indian/Chagos",
        "Indian/Christmas",
        "Indian/Cocos",
        "Indian/Comoro",
        "Indian/Kerguelen",
        "Indian/Mahe",
        "Indian/Maldives",
        "Indian/Mauritius",
        "Indian/Mayotte",
        "Indian/Reunion",
        "Pacific/Apia",
        "Pacific/Auckland",
        "Pacific/Bougainville",
        "Pacific/Chatham",
        "Pacific/Chuuk",
        "Pacific/Easter",
        "Pacific/Efate",
        "Pacific/Fakaofo",
        "Pacific/Fiji",
        "Pacific/Funafuti",
        "Pacific/Galapagos",
        "Pacific/Gambier",
        "Pacific/Guadalcanal",
        "Pacific/Guam",
        "Pacific/Honolulu",
        "Pacific/Kanton",
        "Pacific/Kiritimati",
        "Pacific/Kosrae",
        "Pacific/Kwajalein",
        "Pacific/Majuro",
        "Pacific/Marquesas",
        "Pacific/Midway",
        "Pacific/Nauru",
        "Pacific/Niue",
        "Pacific/Norfolk",
        "Pacific/Noumea",
        "Pacific/Pago_Pago",
        "Pacific/Palau",
        "Pacific/Pitcairn",
        "Pacific/Pohnpei",
        "Pacific/Port_Moresby",
        "Pacific/Rarotonga",
        "Pacific/Saipan",
        "Pacific/Tahiti",
        "Pacific/Tarawa",
        "Pacific/Tongatapu",
        "Pacific/Wake",
        "Pacific/Wallis",
        "US/Alaska",
        "US/Arizona",
        "US/Central",
        "US/Eastern",
        "US/Hawaii",
        "US/Mountain",
        "US/Pacific",
        "UTC"
      ]
    },
    "industries": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "real_estate",
          "mortgage",
          "software",
          "solar",
          "insurance",
          "travel",
          "automotive",
          "support",
          "home_services",
          "financial_services",
          "recruiting",
          "other"
        ]
      }
    },
    "leadTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "buyer",
          "seller",
          "renter",
          "rent_to_own",
          "new_home_loan",
          "home_refinance",
          "auto_insurance",
          "crop_insurance",
          "home_insurance",
          "life_insurance",
          "long_term_disability_insurance",
          "mortgage_insurance",
          "pet_insurance",
          "recruiting_insurance",
          "renters_insurance",
          "travel_insurance",
          "umbrella_insurance",
          "bathroom",
          "deck",
          "door",
          "flooring",
          "gutter_guard",
          "gutters",
          "patio",
          "roofing",
          "screened_porch_sunroom",
          "siding",
          "solar",
          "windows",
          "wealth_management",
          "used_vehicle",
          "new_vehicle",
          "inbound_recruit",
          "outbound_recruit"
        ]
      }
    },
    "fauxAgentsInheritHoursOfOperation": {
      "type": "boolean"
    },
    "allowMultiConversations": {
      "type": "boolean"
    },
    "appointmentScheduling": {
      "$ref": "#/components/schemas/PatchAccountAppointmentScheduling"
    }
  }
}
```

## Security

### `bearer-access-token`

```json
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT"
}
```