Checking authentication...

Properties

Discover and create HubSpot object properties

2 tools

Get Properties

Read Idempotent

POST /v1/tools/hubspot/getProperties

List all properties (fields) for a HubSpot object type. Use this to discover property names, types, and valid options before creating or updating records. Returns property name, label, type, fieldType, and options (for enumeration types). object_type must be one of: contacts, companies, deals, tickets.

Parameters

NameTypeRequiredDescription
object_typestringrequiredThe object type: "contacts", "companies", "deals", or "tickets"
Values: contacts, companies, deals, tickets

Request

curl -X POST https://api.syncello.io/v1/tools/hubspot/getProperties \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "object_type": "contacts"
}'

Response

{
  "objectType": "contacts",
  "count": 400,
  "properties": [
    {
      "name": "email",
      "label": "Email",
      "type": "string",
      "fieldType": "text",
      "groupName": "contactinformation"
    },
    {
      "name": "firstname",
      "label": "First Name",
      "type": "string",
      "fieldType": "text",
      "groupName": "contactinformation"
    }
  ]
}

Try It

Try it

Sign in to execute this tool

Create Property

Write

POST /v1/tools/hubspot/createProperty

Create a custom property on a HubSpot object type. Property names must be lowercase, no spaces (use underscores). Type must be one of: string, number, date, datetime, enumeration, bool. group_name defaults to "contactinformation" for contacts, "companyinformation" for companies, "dealinformation" for deals, "ticketinformation" for tickets. For enumeration type, provide options array with label and value for each option.

Parameters

NameTypeRequiredDescription
object_typestringrequiredObject type: "contacts", "companies", "deals", or "tickets"
Values: contacts, companies, deals, tickets
namestringrequiredInternal name (lowercase, underscores, no spaces). E.g., "custom_score"
labelstringrequiredDisplay label. E.g., "Custom Score"
typestringrequiredProperty type: string, number, date, datetime, enumeration, bool
field_typestringrequiredUI field type: text, textarea, number, date, select, radio, checkbox, booleancheckbox
group_namestringoptionalProperty group (optional, defaults to object_type + "information")
optionsarrayoptionalFor enumeration type: [{ label: "Display", value: "internal_value" }]

Request

curl -X POST https://api.syncello.io/v1/tools/hubspot/createProperty \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "object_type": "contacts",
  "name": "example",
  "label": "example",
  "type": "example",
  "field_type": "example"
}'

Response

{
  "created": true,
  "property": "preferred_language"
}

Try It

Try it

Sign in to execute this tool