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

# HubSpot: Create Property

> Create a custom property (field) on HubSpot contacts, companies, deals, or another object type. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Create a custom property (field) on HubSpot contacts, companies, deals, or another object type.

> [!NOTE]
>
> Tool ID: `hubspot_create_property`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'hubspot_create_property',
  {
    "objectType": "example",
    "data": {
      "label": "example",
      "type": "datetime",
      "groupName": "Example",
      "name": "Example",
      "fieldType": "textarea"
    }
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute hubspot_create_property --input '{
  "objectType": "example",
  "data": {
    "label": "example",
    "type": "datetime",
    "groupName": "Example",
    "name": "Example",
    "fieldType": "textarea"
  }
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "createdUserId": "created_user_123",
    "hidden": true,
    "modificationMetadata": {
      "readOnlyValue": true,
      "readOnlyDefinition": true,
      "archivable": true
    },
    "displayOrder": 123,
    "description": "Example description",
    "label": "example",
    "type": "example",
    "formField": true,
    "createdAt": "2026-01-15T12:00:00Z",
    "archived": true,
    "groupName": "Example",
    "name": "Example",
    "options": [
      {
        "hidden": true,
        "displayOrder": 123,
        "description": "Example description",
        "label": "example",
        "value": "example"
      }
    ],
    "hasUniqueValue": true,
    "fieldType": "example",
    "updatedUserId": "updated_user_123",
    "calculated": true,
    "externalOptions": true,
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}
```

Use `deepline describe hubspot_create_property --json` for the latest machine-readable contract.

## Input reference

Create a custom HubSpot property on an object schema.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.objectType` | `string` | Yes | — | — |
| `payload.data` | `object` | Yes | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Create a custom HubSpot property on an object schema.",
    "properties": {
      "objectType": {
        "type": "string"
      },
      "data": {
        "type": "object",
        "properties": {
          "hidden": {
            "type": "boolean"
          },
          "displayOrder": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "datetime",
              "string",
              "number",
              "date",
              "enumeration",
              "bool"
            ]
          },
          "formField": {
            "type": "boolean"
          },
          "groupName": {
            "type": "string"
          },
          "referencedObjectType": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "hidden": {
                  "type": "boolean"
                },
                "displayOrder": {
                  "type": "number"
                },
                "description": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "hidden",
                "label",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "calculationFormula": {
            "type": "string"
          },
          "hasUniqueValue": {
            "type": "boolean"
          },
          "fieldType": {
            "type": "string",
            "enum": [
              "textarea",
              "text",
              "date",
              "file",
              "number",
              "select",
              "radio",
              "checkbox",
              "booleancheckbox",
              "calculation_equation"
            ]
          },
          "externalOptions": {
            "type": "boolean"
          }
        },
        "required": [
          "label",
          "type",
          "groupName",
          "name",
          "fieldType"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "objectType",
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.createdUserId` | `string` | Yes | — | — |
| `result.data.hidden` | `boolean` | Yes | — | — |
| `result.data.modificationMetadata` | `object` | Yes | — | — |
| `result.data.modificationMetadata.readOnlyOptions` | `boolean` | No | — | — |
| `result.data.modificationMetadata.readOnlyValue` | `boolean` | Yes | — | — |
| `result.data.modificationMetadata.readOnlyDefinition` | `boolean` | Yes | — | — |
| `result.data.modificationMetadata.archivable` | `boolean` | Yes | — | — |
| `result.data.displayOrder` | `number` | Yes | — | — |
| `result.data.description` | `string` | Yes | — | — |
| `result.data.showCurrencySymbol` | `boolean` | No | — | — |
| `result.data.label` | `string` | Yes | — | — |
| `result.data.type` | `string` | Yes | — | — |
| `result.data.hubspotDefined` | `boolean` | No | — | — |
| `result.data.formField` | `boolean` | Yes | — | — |
| `result.data.dataSensitivity` | `string` | No | — | — |
| `result.data.createdAt` | `string` | Yes | — | — |
| `result.data.archivedAt` | `string` | No | — | — |
| `result.data.archived` | `boolean` | Yes | — | — |
| `result.data.groupName` | `string` | Yes | — | — |
| `result.data.referencedObjectType` | `string` | No | — | — |
| `result.data.name` | `string` | Yes | — | — |
| `result.data.options` | `array` | Yes | — | — |
| `result.data.options[].hidden` | `boolean` | Yes | — | — |
| `result.data.options[].displayOrder` | `number` | Yes | — | — |
| `result.data.options[].description` | `string` | Yes | — | — |
| `result.data.options[].label` | `string` | Yes | — | — |
| `result.data.options[].value` | `string` | Yes | — | — |
| `result.data.calculationFormula` | `string` | No | — | — |
| `result.data.hasUniqueValue` | `boolean` | Yes | — | — |
| `result.data.fieldType` | `string` | Yes | — | — |
| `result.data.updatedUserId` | `string` | Yes | — | — |
| `result.data.calculated` | `boolean` | Yes | — | — |
| `result.data.externalOptions` | `boolean` | Yes | — | — |
| `result.data.updatedAt` | `string` | Yes | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "createdUserId": {
            "type": "string"
          },
          "hidden": {
            "type": "boolean"
          },
          "modificationMetadata": {
            "type": "object",
            "properties": {
              "readOnlyOptions": {
                "type": "boolean"
              },
              "readOnlyValue": {
                "type": "boolean"
              },
              "readOnlyDefinition": {
                "type": "boolean"
              },
              "archivable": {
                "type": "boolean"
              }
            },
            "required": [
              "readOnlyValue",
              "readOnlyDefinition",
              "archivable"
            ],
            "additionalProperties": false
          },
          "displayOrder": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "showCurrencySymbol": {
            "type": "boolean"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "hubspotDefined": {
            "type": "boolean"
          },
          "formField": {
            "type": "boolean"
          },
          "dataSensitivity": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "archivedAt": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          },
          "groupName": {
            "type": "string"
          },
          "referencedObjectType": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "hidden": {
                  "type": "boolean"
                },
                "displayOrder": {
                  "type": "number"
                },
                "description": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "hidden",
                "displayOrder",
                "description",
                "label",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "calculationFormula": {
            "type": "string"
          },
          "hasUniqueValue": {
            "type": "boolean"
          },
          "fieldType": {
            "type": "string"
          },
          "updatedUserId": {
            "type": "string"
          },
          "calculated": {
            "type": "boolean"
          },
          "externalOptions": {
            "type": "boolean"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "createdUserId",
          "hidden",
          "modificationMetadata",
          "displayOrder",
          "description",
          "label",
          "type",
          "formField",
          "createdAt",
          "archived",
          "groupName",
          "name",
          "options",
          "hasUniqueValue",
          "fieldType",
          "updatedUserId",
          "calculated",
          "externalOptions",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [HubSpot provider guide](https://deepline.com/docs/providers/hubspot/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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