Go to appAcademyWhat's new?
Back
Artisan IMG > HubSpot (hubspot) (e4d5dcb5-2d04-460d-9091-e98e8c18e614)
HubSpot
OverviewAuthenticationTriggerNotes on using HubSpotExamplesNotes for Embedded customersOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Add contact to company
Copy

Add contact to company.

Sample Input

1
{
2
    "contact_id": "12345",
3
    "company_id": 67890
4
}

Sample Output

1
{
2
    "fromObjectTypeId": "0-1",
3
    "fromObjectId": 12345,
4
    "toObjectTypeId": "0-2",
5
    "toObjectId": 67890,
6
    "labels": [
7
        "employee_of"
8
    ]
9
}

Add contact to list
Copy

Add contact records that have already been created in the system to a contact list. You can either specify their email addresses or their IDs.

Sample Input

1
{
2
    "contact_list_id": "123",
3
    "contact_ids": [
4
        456,
5
        789,
6
        "1011"
7
    ],
8
    "emails": [
9
        "john.doe@example.com",
10
        "jane.smith@example.com"
11
    ]
12
}

Sample Output

1
{
2
    "updated": [
3
        456,
4
        789,
5
        1011
6
    ],
7
    "discarded": [],
8
    "invalidVids": [],
9
    "invalidEmails": []
10
}

Archive property
Copy

Move a specified property to the recycling bin.

Sample Input

1
{
2
    "object_type": "contact",
3
    "property_name": "custom_field_1"
4
}

Sample Output

1
{
2
    "success": true
3
}

Archive property group
Copy

Move a specified property group to the recycling bin.

Sample Input

1
{
2
    "object_type": "contacts",
3
    "property_group_name": "Customer Information"
4
}

Sample Output

1
{
2
    "success": true
3
}

Associate crm objects
Copy

Associates two CRM objects.

Sample Input

1
{
2
    "object_type": "Contacts",
3
    "object_id": "51",
4
    "to_object_type": "Deals",
5
    "to_object_id": "1001",
6
    "association_category": "HUBSPOT_DEFINED",
7
    "association_type_id": "3"
8
}

Sample Output

1
{
2
    "fromObjectTypeId": "0-1",
3
    "fromObjectId": 51,
4
    "toObjectTypeId": "0-3",
5
    "toObjectId": 1001,
6
    "labels": [
7
        "contact_to_deal"
8
    ],
9
    "objectType": "Contacts",
10
    "toObjectType": "Deals"
11
}

Associate custom object
Copy

Associate a custom object with another object.

Sample Input

1
{
2
    "custom_object_type": "2-12345678",
3
    "object_id": "987654",
4
    "to_object_type": "Deals",
5
    "to_object_id": "123456",
6
    "associated_objects": [
7
        "custom_object_to_deal"
8
    ]
9
}

Sample Output

1
{
2
    "id": "987654",
3
    "properties": {
4
        "hs_createdate": "2023-05-15T10:30:00Z",
5
        "hs_lastmodifieddate": "2023-05-15T10:30:00Z",
6
        "hs_object_id": "987654"
7
    },
8
    "createdAt": "2023-05-15T10:30:00Z",
9
    "updatedAt": "2023-05-15T10:30:00Z",
10
    "archived": false,
11
    "associations": {
12
        "contacts": {
13
            "results": [
14
                {
15
                    "id": "123456",
16
                    "type": "deal_to_custom_object"
17
                }
18
            ]
19
        }
20
    }
21
}

Batch create line items
Copy

Create a group of line items in your HubSpot account.

Sample Input

1
{
2
    "line_items": [
3
        {
4
            "properties": [
5
                {
6
                    "name": "name",
7
                    "value": "Premium Software License"
8
                },
9
                {
10
                    "name": "amount",
11
                    "value": 1000
12
                },
13
                {
14
                    "name": "price",
15
                    "value": 500
16
                },
17
                {
18
                    "name": "quantity",
19
                    "value": 2
20
                },
21
                {
22
                    "name": "description",
23
                    "value": "Annual subscription for premium software"
24
                }
25
            ]
26
        },
27
        {
28
            "properties": [
29
                {
30
                    "name": "name",
31
                    "value": "Consulting Services"
32
                },
33
                {
34
                    "name": "amount",
35
                    "value": 2500
36
                },
37
                {
38
                    "name": "price",
39
                    "value": 250
40
                },
41
                {
42
                    "name": "quantity",
43
                    "value": 10
44
                },
45
                {
46
                    "name": "description",
47
                    "value": "10 hours of expert consulting"
48
                }
49
            ]
50
        }
51
    ]
52
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "12345",
6
            "properties": {
7
                "amount": "1000",
8
                "createdate": "2023-06-15T10:30:00Z",
9
                "description": "Annual subscription for premium software",
10
                "hs_acv": "1000",
11
                "hs_arr": "1000",
12
                "hs_lastmodifieddate": "2023-06-15T10:30:00Z",
13
                "hs_margin": "500",
14
                "hs_margin_acv": "500",
15
                "hs_margin_arr": "500",
16
                "hs_margin_mrr": "41.67",
17
                "hs_margin_tcv": "500",
18
                "hs_mrr": "83.33",
19
                "hs_object_id": "12345",
20
                "hs_pre_discount_amount": "1000",
21
                "hs_recurring_billing_number_of_payments": "12",
22
                "hs_tcv": "1000",
23
                "hs_total_discount": "0",
24
                "name": "Premium Software License",
25
                "price": "500"
26
            },
27
            "createdAt": "2023-06-15T10:30:00Z",
28
            "updatedAt": "2023-06-15T10:30:00Z",
29
            "archived": false
30
        },
31
        {
32
            "id": "67890",
33
            "properties": {
34
                "amount": "2500",
35
                "createdate": "2023-06-15T10:30:00Z",
36
                "description": "10 hours of expert consulting",
37
                "hs_acv": "2500",
38
                "hs_arr": "0",
39
                "hs_lastmodifieddate": "2023-06-15T10:30:00Z",
40
                "hs_margin": "1250",
41
                "hs_margin_acv": "1250",
42
                "hs_margin_arr": "0",
43
                "hs_margin_mrr": "0",
44
                "hs_margin_tcv": "1250",
45
                "hs_mrr": "0",
46
                "hs_object_id": "67890",
47
                "hs_pre_discount_amount": "2500",
48
                "hs_recurring_billing_number_of_payments": "1",
49
                "hs_tcv": "2500",
50
                "hs_total_discount": "0",
51
                "name": "Consulting Services",
52
                "price": "250"
53
            },
54
            "createdAt": "2023-06-15T10:30:00Z",
55
            "updatedAt": "2023-06-15T10:30:00Z",
56
            "archived": false
57
        }
58
    ],
59
    "startedAt": "2023-06-15T10:30:00Z",
60
    "completedAt": "2023-06-15T10:30:05Z"
61
}

Batch create products
Copy

Create a group of products in your HubSpot account.

Sample Input

1
{
2
    "products": [
3
        {
4
            "product_properties": [
5
                {
6
                    "name": "name",
7
                    "value": "Premium Widget"
8
                },
9
                {
10
                    "name": "description",
11
                    "value": "High-quality widget for professional use"
12
                },
13
                {
14
                    "name": "price",
15
                    "value": 99.99
16
                },
17
                {
18
                    "name": "hs_sku",
19
                    "value": "PREM-WDG-001"
20
                },
21
                {
22
                    "name": "hs_cost_of_goods_sold",
23
                    "value": 49.99
24
                },
25
                {
26
                    "name": "hs_recurring_billing_period",
27
                    "value": "monthly"
28
                }
29
            ]
30
        },
31
        {
32
            "product_properties": [
33
                {
34
                    "name": "name",
35
                    "value": "Basic Gadget"
36
                },
37
                {
38
                    "name": "description",
39
                    "value": "Entry-level gadget for everyday use"
40
                },
41
                {
42
                    "name": "price",
43
                    "value": 29.99
44
                },
45
                {
46
                    "name": "hs_sku",
47
                    "value": "BASIC-GDG-001"
48
                },
49
                {
50
                    "name": "hs_cost_of_goods_sold",
51
                    "value": 15.99
52
                }
53
            ]
54
        }
55
    ]
56
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "1234567",
6
            "properties": {
7
                "createdate": "2023-05-15T10:30:00.000Z",
8
                "description": "High-quality widget for professional use",
9
                "hs_cost_of_goods_sold": "49.99",
10
                "hs_lastmodifieddate": "2023-05-15T10:30:00.000Z",
11
                "hs_recurring_billing_period": "monthly",
12
                "hs_sku": "PREM-WDG-001",
13
                "name": "Premium Widget",
14
                "price": "99.99"
15
            },
16
            "createdAt": "2023-05-15T10:30:00.000Z",
17
            "updatedAt": "2023-05-15T10:30:00.000Z",
18
            "archived": false
19
        },
20
        {
21
            "id": "7654321",
22
            "properties": {
23
                "createdate": "2023-05-15T10:30:00.000Z",
24
                "description": "Entry-level gadget for everyday use",
25
                "hs_cost_of_goods_sold": "15.99",
26
                "hs_lastmodifieddate": "2023-05-15T10:30:00.000Z",
27
                "hs_sku": "BASIC-GDG-001",
28
                "name": "Basic Gadget",
29
                "price": "29.99"
30
            },
31
            "createdAt": "2023-05-15T10:30:00.000Z",
32
            "updatedAt": "2023-05-15T10:30:00.000Z",
33
            "archived": false
34
        }
35
    ],
36
    "requestedAt": "2023-05-15T10:29:55.000Z",
37
    "startedAt": "2023-05-15T10:29:56.000Z",
38
    "completedAt": "2023-05-15T10:30:01.000Z",
39
    "links": {
40
        "self": "https://api.hubapi.com/crm/v3/objects/products/batch/create"
41
    }
42
}

Batch create/update contact
Copy

If multiple contacts already exist update their data. Create new contacts if they do not i.e. Upsert

Sample Input

1
{
2
    "contacts": [
3
        {
4
            "contact_identifier": {
5
                "email": "john.doe@example.com"
6
            },
7
            "properties": [
8
                {
9
                    "property": "firstname",
10
                    "value": "John"
11
                },
12
                {
13
                    "property": "lastname",
14
                    "value": "Doe"
15
                },
16
                {
17
                    "property": "phone",
18
                    "value": "+1234567890"
19
                },
20
                {
21
                    "property": "company",
22
                    "value": "Acme Inc."
23
                }
24
            ]
25
        },
26
        {
27
            "contact_identifier": {
28
                "vid": 12345
29
            },
30
            "properties": [
31
                {
32
                    "property": "job_title",
33
                    "value": "Marketing Manager"
34
                },
35
                {
36
                    "property": "annual_revenue",
37
                    "value": 500000
38
                },
39
                {
40
                    "property": "is_customer",
41
                    "value": true
42
                }
43
            ]
44
        }
45
    ]
46
}

Sample Output

1
{
2
    "message": "Successfully processed 2 contacts."
3
}

Batch delete line items
Copy

Delete a group of line items from your HubSpot account.

Sample Input

1
{
2
    "line_items": [
3
        "12345678",
4
        "23456789",
5
        "34567890"
6
    ]
7
}

Sample Output

1
{
2
    "success": true
3
}

Batch delete products
Copy

Delete a group of products from your HubSpot account.

Sample Input

1
{
2
    "product_ids": [
3
        "1234567",
4
        "2345678",
5
        "3456789"
6
    ]
7
}

Sample Output

1
{
2
    "success": true
3
}

Batch update companies
Copy

Update a batch of companies.

Sample Input

1
{
2
    "companies": [
3
        {
4
            "company_id": "1234567",
5
            "company_properties": [
6
                {
7
                    "name": "name",
8
                    "value": "Acme Corporation"
9
                },
10
                {
11
                    "name": "industry",
12
                    "value": "Technology"
13
                },
14
                {
15
                    "name": "lifecyclestage",
16
                    "value": "Customer"
17
                }
18
            ]
19
        },
20
        {
21
            "company_id": "7654321",
22
            "company_properties": [
23
                {
24
                    "name": "name",
25
                    "value": "Global Innovations Inc."
26
                },
27
                {
28
                    "name": "industry",
29
                    "value": "Manufacturing"
30
                },
31
                {
32
                    "name": "hs_pipeline",
33
                    "value": "default"
34
                }
35
            ]
36
        }
37
    ]
38
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "1234567",
6
            "properties": {
7
                "createdate": "2023-05-15T10:30:00Z",
8
                "hs_lastmodifieddate": "2023-05-20T14:45:00Z",
9
                "hs_object_id": "1234567",
10
                "hs_pipeline": "default",
11
                "industry": "Technology",
12
                "lifecyclestage": "Customer",
13
                "name": "Acme Corporation"
14
            },
15
            "createdAt": "2023-05-15T10:30:00Z",
16
            "updatedAt": "2023-05-20T14:45:00Z",
17
            "archived": false
18
        },
19
        {
20
            "id": "7654321",
21
            "properties": {
22
                "createdate": "2023-05-10T09:15:00Z",
23
                "hs_lastmodifieddate": "2023-05-20T14:45:00Z",
24
                "hs_object_id": "7654321",
25
                "hs_pipeline": "default",
26
                "industry": "Manufacturing",
27
                "lifecyclestage": "Lead",
28
                "name": "Global Innovations Inc."
29
            },
30
            "createdAt": "2023-05-10T09:15:00Z",
31
            "updatedAt": "2023-05-20T14:45:00Z",
32
            "archived": false
33
        }
34
    ],
35
    "startedAt": "2023-05-20T14:44:55Z",
36
    "completedAt": "2023-05-20T14:45:05Z"
37
}

Batch update deals
Copy

Update a group of deals in your HubSpot account.

Sample Input

1
{
2
    "deals": [
3
        {
4
            "deal_id": 123456,
5
            "properties": [
6
                {
7
                    "name": "dealname",
8
                    "value": "Updated Deal Name"
9
                },
10
                {
11
                    "name": "amount",
12
                    "value": 50000
13
                },
14
                {
15
                    "name": "dealstage",
16
                    "value": "closedwon"
17
                }
18
            ]
19
        },
20
        {
21
            "deal_id": 789012,
22
            "properties": [
23
                {
24
                    "name": "pipeline",
25
                    "value": "default"
26
                },
27
                {
28
                    "name": "hs_deal_stage_probability",
29
                    "value": 0.8
30
                }
31
            ]
32
        }
33
    ]
34
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "123456",
6
            "properties": {
7
                "amount": "50000",
8
                "amount_in_home_currency": "50000",
9
                "createdate": "2023-05-01T10:30:00Z",
10
                "days_to_close": "30",
11
                "dealname": "Updated Deal Name",
12
                "dealstage": "closedwon",
13
                "hs_closed_amount": "50000",
14
                "hs_closed_amount_in_home_currency": "50000",
15
                "hs_deal_stage_probability": "1.0",
16
                "hs_deal_stage_probability_shadow": "1.0",
17
                "hs_forecast_amount": "50000",
18
                "hs_is_closed": "true",
19
                "hs_is_closed_won": "true",
20
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
21
                "hs_object_id": "123456",
22
                "hs_projected_amount": "50000",
23
                "hs_projected_amount_in_home_currency": "50000",
24
                "pipeline": "default"
25
            },
26
            "createdAt": "2023-05-01T10:30:00Z",
27
            "updatedAt": "2023-05-15T14:45:00Z",
28
            "archived": false
29
        },
30
        {
31
            "id": "789012",
32
            "properties": {
33
                "amount": "25000",
34
                "amount_in_home_currency": "25000",
35
                "createdate": "2023-04-15T09:00:00Z",
36
                "days_to_close": "45",
37
                "dealname": "Existing Deal Name",
38
                "dealstage": "presentationscheduled",
39
                "hs_closed_amount": "0",
40
                "hs_closed_amount_in_home_currency": "0",
41
                "hs_deal_stage_probability": "0.8",
42
                "hs_deal_stage_probability_shadow": "0.8",
43
                "hs_forecast_amount": "20000",
44
                "hs_is_closed": "false",
45
                "hs_is_closed_won": "false",
46
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
47
                "hs_object_id": "789012",
48
                "hs_projected_amount": "20000",
49
                "hs_projected_amount_in_home_currency": "20000",
50
                "pipeline": "default"
51
            },
52
            "createdAt": "2023-04-15T09:00:00Z",
53
            "updatedAt": "2023-05-15T14:45:00Z",
54
            "archived": false
55
        }
56
    ],
57
    "startedAt": "2023-05-15T14:45:00Z",
58
    "completedAt": "2023-05-15T14:45:05Z"
59
}

Batch update line items
Copy

Update a group of line items in your HubSpot account.

Sample Input

1
{
2
    "line_items": [
3
        {
4
            "line_item_id": "1234567",
5
            "properties": [
6
                {
7
                    "name": "quantity",
8
                    "value": 5
9
                },
10
                {
11
                    "name": "price",
12
                    "value": 99.99
13
                },
14
                {
15
                    "name": "description",
16
                    "value": "Updated product description"
17
                }
18
            ]
19
        },
20
        {
21
            "line_item_id": "7654321",
22
            "properties": [
23
                {
24
                    "name": "quantity",
25
                    "value": 2
26
                },
27
                {
28
                    "name": "price",
29
                    "value": 149.99
30
                },
31
                {
32
                    "name": "name",
33
                    "value": "Premium Package"
34
                }
35
            ]
36
        }
37
    ]
38
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "1234567",
6
            "properties": {
7
                "amount": "499.95",
8
                "createdate": "2023-05-01T10:30:00Z",
9
                "description": "Updated product description",
10
                "hs_acv": "499.95",
11
                "hs_arr": "499.95",
12
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
13
                "hs_margin": "250.00",
14
                "hs_margin_acv": "250.00",
15
                "hs_margin_arr": "250.00",
16
                "hs_margin_mrr": "20.83",
17
                "hs_margin_tcv": "250.00",
18
                "hs_mrr": "41.66",
19
                "hs_object_id": "1234567",
20
                "hs_pre_discount_amount": "499.95",
21
                "hs_tcv": "499.95",
22
                "hs_total_discount": "0.00",
23
                "name": "Standard Package",
24
                "price": "99.99",
25
                "quantity": "5"
26
            },
27
            "createdAt": "2023-05-01T10:30:00Z",
28
            "updatedAt": "2023-05-15T14:45:00Z",
29
            "archived": false
30
        },
31
        {
32
            "id": "7654321",
33
            "properties": {
34
                "amount": "299.98",
35
                "createdate": "2023-05-10T09:15:00Z",
36
                "description": "High-quality premium package",
37
                "hs_acv": "299.98",
38
                "hs_arr": "299.98",
39
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
40
                "hs_margin": "150.00",
41
                "hs_margin_acv": "150.00",
42
                "hs_margin_arr": "150.00",
43
                "hs_margin_mrr": "12.50",
44
                "hs_margin_tcv": "150.00",
45
                "hs_mrr": "24.99",
46
                "hs_object_id": "7654321",
47
                "hs_pre_discount_amount": "299.98",
48
                "hs_tcv": "299.98",
49
                "hs_total_discount": "0.00",
50
                "name": "Premium Package",
51
                "price": "149.99",
52
                "quantity": "2"
53
            },
54
            "createdAt": "2023-05-10T09:15:00Z",
55
            "updatedAt": "2023-05-15T14:45:00Z",
56
            "archived": false
57
        }
58
    ],
59
    "startedAt": "2023-05-15T14:44:55Z",
60
    "completedAt": "2023-05-15T14:45:00Z"
61
}

Batch update products
Copy

Update a group of products in your HubSpot account

Sample Input

1
{
2
    "products": [
3
        {
4
            "product_id": "1234567",
5
            "product_properties": [
6
                {
7
                    "name": "name",
8
                    "value": "Updated Product Name"
9
                },
10
                {
11
                    "name": "description",
12
                    "value": "This is an updated product description."
13
                },
14
                {
15
                    "name": "price",
16
                    "value": 99.99
17
                },
18
                {
19
                    "name": "hs_sku",
20
                    "value": "UPD-123"
21
                }
22
            ]
23
        },
24
        {
25
            "product_id": "7654321",
26
            "product_properties": [
27
                {
28
                    "name": "name",
29
                    "value": "Another Updated Product"
30
                },
31
                {
32
                    "name": "hs_cost_of_goods_sold",
33
                    "value": 50
34
                },
35
                {
36
                    "name": "hs_recurring_billing_period",
37
                    "value": "MONTHLY"
38
                }
39
            ]
40
        }
41
    ]
42
}

Sample Output

1
{
2
    "status": "COMPLETE",
3
    "results": [
4
        {
5
            "id": "1234567",
6
            "properties": {
7
                "createdate": "2023-05-01T10:00:00Z",
8
                "description": "This is an updated product description.",
9
                "hs_cost_of_goods_sold": "75.00",
10
                "hs_lastmodifieddate": "2023-05-15T14:30:00Z",
11
                "hs_recurring_billing_period": "",
12
                "hs_sku": "UPD-123",
13
                "name": "Updated Product Name",
14
                "price": "99.99"
15
            },
16
            "createdAt": "2023-05-01T10:00:00Z",
17
            "updatedAt": "2023-05-15T14:30:00Z",
18
            "archived": false
19
        },
20
        {
21
            "id": "7654321",
22
            "properties": {
23
                "createdate": "2023-04-15T09:00:00Z",
24
                "description": "Original product description",
25
                "hs_cost_of_goods_sold": "50.00",
26
                "hs_lastmodifieddate": "2023-05-15T14:30:00Z",
27
                "hs_recurring_billing_period": "MONTHLY",
28
                "hs_sku": "PROD-789",
29
                "name": "Another Updated Product",
30
                "price": "129.99"
31
            },
32
            "createdAt": "2023-04-15T09:00:00Z",
33
            "updatedAt": "2023-05-15T14:30:00Z",
34
            "archived": false
35
        }
36
    ],
37
    "requestedAt": "2023-05-15T14:29:55Z",
38
    "startedAt": "2023-05-15T14:29:56Z",
39
    "completedAt": "2023-05-15T14:30:00Z",
40
    "links": {
41
        "self": "https://api.hubapi.com/crm/v3/objects/products/batch/update"
42
    }
43
}

Calculate attendance duration at event for all attendees
Copy

Using the Event ID calculate the attendance duration for all attendees and update said attendees timeline entries.

Sample Input

1
{
2
    "external_account_id": "123456",
3
    "external_event_id": "EVENT-2023-001",
4
    "start_date_time": "2023-06-15T09:00:00Z",
5
    "end_date_time": "2023-06-15T17:00:00Z"
6
}

Sample Output

1
{
2
    "eventName": "Annual Tech Conference 2023",
3
    "eventType": "Conference",
4
    "startDateTime": "2023-06-15T09:00:00Z",
5
    "endDateTime": "2023-06-15T17:00:00Z",
6
    "eventOrganizer": "TechCorp Inc.",
7
    "eventDescription": "Join us for our annual tech conference featuring industry leaders and innovative workshops.",
8
    "eventUrl": "https://techcorp.com/annual-conference-2023",
9
    "eventCancelled": false,
10
    "customProperties": [
11
        {
12
            "name": "Venue",
13
            "value": "TechCenter Convention Hall",
14
            "sourceVid": [
15
                98765,
16
                87654
17
            ]
18
        },
19
        {
20
            "name": "Attendance Duration",
21
            "value": "8 hours",
22
            "sourceVid": [
23
                12345,
24
                23456,
25
                34567
26
            ]
27
        }
28
    ]
29
}

Cancel marketing event (beta)
Copy

Mark a marketing event as cancelled.

Sample Input

1
{
2
    "external_event_id": "EXT123456",
3
    "external_account_id": "ACC987654"
4
}

Sample Output

1
{
2
    "eventName": "Annual Tech Conference",
3
    "eventType": "CONFERENCE",
4
    "startDateTime": "2023-09-15T09:00:00Z",
5
    "endDateTime": "2023-09-17T18:00:00Z",
6
    "eventOrganizer": "TechCorp Inc.",
7
    "eventDescription": "Join us for our annual tech conference featuring industry leaders and innovative workshops.",
8
    "eventUrl": "https://techcorp.com/annual-conference-2023",
9
    "eventCancelled": true,
10
    "customProperties": [
11
        {
12
            "name": "Venue",
13
            "value": "Tech Convention Center",
14
            "sourceVid": [
15
                12345,
16
                67890
17
            ]
18
        },
19
        {
20
            "name": "Theme",
21
            "value": "AI and the Future of Technology",
22
            "sourceVid": [
23
                54321,
24
                98765
25
            ]
26
        }
27
    ],
28
    "externalEventId": "EXT123456",
29
    "registrants": 500,
30
    "attendees": 0,
31
    "cancellations": 500,
32
    "noShows": 0,
33
    "createdAt": "2023-03-01T10:30:00Z",
34
    "updatedAt": "2023-09-01T14:45:00Z",
35
    "id": "HUB987654321"
36
}

Contact exists with email?
Copy

Check if a contact with an email address exists.

Sample Input

1
{
2
    "email": "john.doe@example.com"
3
}

Sample Output

1
{
2
    "exists": true
3
}

Create blog post
Copy

Create a new blog post.

Sample Input

1
{
2
    "blog_post": "{\"name\":\"The Ultimate Guide to Content Marketing\",\"contentGroupId\":\"12345678\",\"state\":\"DRAFT\",\"blogAuthorId\":\"87654321\",\"postBody\":\"<p>Content marketing is a strategic approach focused on creating and distributing valuable, relevant, and consistent content to attract and retain a clearly defined audience — and, ultimately, to drive profitable customer action.</p><h2>Key Elements of Content Marketing</h2><ul><li>Understanding your target audience</li><li>Creating valuable and relevant content</li><li>Consistent publishing</li><li>Measuring and analyzing results</li></ul>\",\"metaDescription\":\"Learn the fundamentals of content marketing and how to create a successful strategy for your business.\",\"featuredImage\":\"https://example.com/content-marketing-image.jpg\",\"tagIds\":[1234, 5678],\"publishDate\":\"2023-06-15T10:00:00Z\"}"
3
}

Sample Output

1
{
2
    "id": "9876543210",
3
    "slug": "the-ultimate-guide-to-content-marketing",
4
    "contentGroupId": "12345678",
5
    "state": "DRAFT",
6
    "name": "The Ultimate Guide to Content Marketing",
7
    "authorName": "John Doe",
8
    "blogAuthorId": "87654321",
9
    "postBody": "<p>Content marketing is a strategic approach focused on creating and distributing valuable, relevant, and consistent content to attract and retain a clearly defined audience — and, ultimately, to drive profitable customer action.</p><h2>Key Elements of Content Marketing</h2><ul><li>Understanding your target audience</li><li>Creating valuable and relevant content</li><li>Consistent publishing</li><li>Measuring and analyzing results</li></ul>",
10
    "metaDescription": "Learn the fundamentals of content marketing and how to create a successful strategy for your business.",
11
    "featuredImage": "https://example.com/content-marketing-image.jpg",
12
    "tagIds": [
13
        1234,
14
        5678
15
    ],
16
    "publishDate": "2023-06-15T10:00:00Z",
17
    "url": "https://example.com/blog/the-ultimate-guide-to-content-marketing",
18
    "published": false,
19
    "createdAt": "2023-06-01T14:30:00Z",
20
    "updatedAt": "2023-06-01T14:30:00Z"
21
}

Create call engagement
Copy

Create a call with the given properties.

Sample Input

1
{
2
    "timestamp": "2023-05-15T14:30:00Z",
3
    "title": "Follow-up call with potential client",
4
    "body": "Discussed product features and pricing. Client showed interest in our enterprise package.",
5
    "status": "COMPLETED",
6
    "hubspot_owner_id": "51",
7
    "recording_url": "https://example.com/call-recordings/123456.mp3",
8
    "from_number": "+14155552671",
9
    "to_number": "+14085559876",
10
    "direction": "OUTBOUND",
11
    "call_disposition": "INTERESTED",
12
    "call_duration": "1800000",
13
    "callee_object_id": "3001",
14
    "callee_object_type_id": "0-1",
15
    "call_type": "SALES_CALL",
16
    "attachment_ids": [
17
        "789",
18
        "790"
19
    ]
20
}

Sample Output

1
{
2
    "id": "1234567890",
3
    "properties": {
4
        "hs_all_owner_ids": "51",
5
        "hs_attachment_ids": "789;790",
6
        "hs_body_preview": "Discussed product features and pricing. Client showed interest in our enterprise package.",
7
        "hs_body_preview_html": "<p>Discussed product features and pricing. Client showed interest in our enterprise package.</p>",
8
        "hs_body_preview_is_truncated": "false",
9
        "hs_call_body": "Discussed product features and pricing. Client showed interest in our enterprise package.",
10
        "hs_call_direction": "OUTBOUND",
11
        "hs_call_disposition": "INTERESTED",
12
        "hs_call_duration": "1800000",
13
        "hs_call_recording_url": "https://example.com/call-recordings/123456.mp3",
14
        "hs_call_status": "COMPLETED",
15
        "hs_call_title": "Follow-up call with potential client",
16
        "hs_call_to_number": "+14085559876",
17
        "hs_createdate": "2023-05-15T14:30:00.000Z",
18
        "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z",
19
        "hs_object_id": "1234567890",
20
        "hs_timestamp": "2023-05-15T14:30:00.000Z",
21
        "hs_user_ids_of_all_owners": "51",
22
        "hubspot_owner_assigneddate": "2023-05-15T14:30:00.000Z",
23
        "hubspot_owner_id": "51"
24
    },
25
    "createdAt": "2023-05-15T14:30:00.000Z",
26
    "updatedAt": "2023-05-15T14:30:00.000Z",
27
    "archived": false
28
}

Create company
Copy

Create a company.

Sample Input

1
{
2
    "properties": [
3
        {
4
            "name": "name",
5
            "value": "Acme Corporation"
6
        },
7
        {
8
            "name": "description",
9
            "value": "A leading provider of innovative solutions"
10
        },
11
        {
12
            "name": "industry",
13
            "value": "Technology"
14
        },
15
        {
16
            "name": "numberOfEmployees",
17
            "value": 500
18
        },
19
        {
20
            "name": "annualRevenue",
21
            "value": 10000000
22
        },
23
        {
24
            "name": "city",
25
            "value": "San Francisco"
26
        },
27
        {
28
            "name": "state",
29
            "value": "CA"
30
        },
31
        {
32
            "name": "country",
33
            "value": "United States"
34
        }
35
    ]
36
}

Sample Output

1
{
2
    "id": "1234567890",
3
    "properties": {
4
        "createdate": "2023-05-15T14:30:00.000Z",
5
        "description": "A leading provider of innovative solutions",
6
        "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z",
7
        "hs_object_id": "1234567890",
8
        "hs_pipeline": "default",
9
        "lifecyclestage": "lead",
10
        "name": "Acme Corporation"
11
    },
12
    "createdAt": "2023-05-15T14:30:00.000Z",
13
    "updatedAt": "2023-05-15T14:30:00.000Z",
14
    "archived": false
15
}

Create contact
Copy

Create a new contact in HubSpot.

Sample Input

1
{
2
    "properties": [
3
        {
4
            "name": "email",
5
            "value": "john.doe@example.com"
6
        },
7
        {
8
            "name": "firstname",
9
            "value": "John"
10
        },
11
        {
12
            "name": "lastname",
13
            "value": "Doe"
14
        },
15
        {
16
            "name": "phone",
17
            "value": "+1 (555) 123-4567"
18
        },
19
        {
20
            "name": "company",
21
            "value": "Acme Inc."
22
        },
23
        {
24
            "name": "website",
25
            "value": "https://www.acmeinc.com"
26
        },
27
        {
28
            "name": "address",
29
            "value": "123 Main St"
30
        },
31
        {
32
            "name": "city",
33
            "value": "New York"
34
        },
35
        {
36
            "name": "state",
37
            "value": "NY"
38
        },
39
        {
40
            "name": "zip",
41
            "value": "10001"
42
        }
43
    ]
44
}

Sample Output

1
{
2
    "id": "51",
3
    "properties": {
4
        "address": "123 Main St",
5
        "city": "New York",
6
        "company": "Acme Inc.",
7
        "createdate": "2023-05-15T14:30:00.000Z",
8
        "email": "john.doe@example.com",
9
        "firstname": "John",
10
        "hs_all_contact_vids": "51",
11
        "hs_email_domain": "example.com",
12
        "hs_is_contact": "true",
13
        "hs_is_unworked": "true",
14
        "hs_lifecyclestage_lead_date": "2023-05-15T14:30:00.000Z",
15
        "hs_marketable_status": "true",
16
        "hs_marketable_until_renewal": "2024-05-15T14:30:00.000Z",
17
        "hs_object_id": "51",
18
        "hs_pipeline": "default",
19
        "hs_searchable_calculated_phone_number": "+15551234567",
20
        "lastmodifieddate": "2023-05-15T14:30:00.000Z",
21
        "lastname": "Doe",
22
        "lifecyclestage": "lead",
23
        "phone": "+1 (555) 123-4567",
24
        "state": "NY",
25
        "website": "https://www.acmeinc.com",
26
        "zip": "10001"
27
    },
28
    "createdAt": "2023-05-15T14:30:00.000Z",
29
    "updatedAt": "2023-05-15T14:30:00.000Z",
30
    "archived": false
31
}

Create contact list
Copy

Create new contact list.

Sample Input

1
{
2
    "list_name": "VIP Customers",
3
    "dynamic": true,
4
    "filters": [
5
        [
6
            {
7
                "propertyName": "total_revenue",
8
                "operator": "GT",
9
                "value": "10000"
10
            },
11
            {
12
                "propertyName": "lifecyclestage",
13
                "operator": "EQ",
14
                "value": "customer"
15
            }
16
        ],
17
        [
18
            {
19
                "propertyName": "last_meeting_date",
20
                "operator": "WITHIN_TIME",
21
                "value": "last_30_days"
22
            }
23
        ]
24
    ]
25
}

Sample Output

1
{
2
    "portalId": 6789012,
3
    "listId": 123456,
4
    "internalListId": 789012,
5
    "createdAt": 1623456789000,
6
    "updatedAt": 1623456789000,
7
    "name": "VIP Customers",
8
    "listType": "DYNAMIC",
9
    "authorId": 45678,
10
    "filters": [
11
        [
12
            {
13
                "propertyName": "total_revenue",
14
                "operator": "GT",
15
                "value": "10000"
16
            },
17
            {
18
                "propertyName": "lifecyclestage",
19
                "operator": "EQ",
20
                "value": "customer"
21
            }
22
        ],
23
        [
24
            {
25
                "propertyName": "last_meeting_date",
26
                "operator": "WITHIN_TIME",
27
                "value": "last_30_days"
28
            }
29
        ]
30
    ],
31
    "metaData": {
32
        "size": 0,
33
        "lastSizeChangeAt": 1623456789000,
34
        "processing": "DONE",
35
        "lastProcessingStateChangeAt": 1623456789000,
36
        "error": "",
37
        "listReferencesCount": 0,
38
        "parentFolderId": "1234"
39
    },
40
    "archived": false,
41
    "teamIds": [
42
        1234,
43
        5678
44
    ],
45
    "dynamic": true
46
}

Create custom object
Copy

Create a CRM object with the given properties and return a copy of the object, including the ID. Please define a schema in advance using the 'Create object schema' operation.

Sample Input

1
{
2
    "custom_object_type": "2-123456",
3
    "custom_object_properties": {
4
        "name": "Fluffy",
5
        "species": "Cat",
6
        "age": "3",
7
        "color": "Orange",
8
        "favorite_toy": "Laser pointer"
9
    }
10
}

Sample Output

1
{
2
    "id": "3456789",
3
    "properties": {
4
        "hs_createdate": "2023-05-15T14:30:00.000Z",
5
        "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z",
6
        "hs_object_id": "3456789",
7
        "name": "Fluffy",
8
        "species": "Cat"
9
    },
10
    "createdAt": "2023-05-15T14:30:00.000Z",
11
    "updatedAt": "2023-05-15T14:30:00.000Z",
12
    "archived": false
13
}

Create deal
Copy

Creates and tracks deals in HubSpot. It also allows you to connect HubSpot with an external CRM or other sales management software.

Sample Input

1
{
2
    "properties": [
3
        {
4
            "name": "dealname",
5
            "value": "New Software License Deal"
6
        },
7
        {
8
            "name": "amount",
9
            "value": 50000
10
        },
11
        {
12
            "name": "dealstage",
13
            "value": "appointmentscheduled"
14
        },
15
        {
16
            "name": "pipeline",
17
            "value": "default"
18
        },
19
        {
20
            "name": "closedate",
21
            "value": "2023-12-31"
22
        }
23
    ]
24
}

Sample Output

1
{
2
    "id": "3456789",
3
    "properties": {
4
        "amount": "50000",
5
        "amount_in_home_currency": "50000",
6
        "closedate": "2023-12-31",
7
        "createdate": "2023-06-15T14:30:00.000Z",
8
        "days_to_close": "199",
9
        "dealname": "New Software License Deal",
10
        "dealstage": "appointmentscheduled",
11
        "dealtype": "newbusiness",
12
        "hs_closed_amount": "0",
13
        "hs_closed_amount_in_home_currency": "0",
14
        "hs_createdate": "2023-06-15T14:30:00.000Z",
15
        "hs_deal_stage_probability_shadow": "20",
16
        "hs_forecast_amount": "10000",
17
        "hs_is_closed": "false",
18
        "hs_is_closed_won": "false",
19
        "hs_is_deal_split": "false",
20
        "hs_lastmodifieddate": "2023-06-15T14:30:00.000Z",
21
        "hs_object_id": "3456789",
22
        "hs_projected_amount": "50000",
23
        "hs_projected_amount_in_home_currency": "50000",
24
        "pipeline": "default"
25
    },
26
    "createdAt": "2023-06-15T14:30:00.000Z",
27
    "updatedAt": "2023-06-15T14:30:00.000Z",
28
    "archived": false
29
}

Create email engagement
Copy

Create an email with the given properties.

Sample Input

1
{
2
    "timestamp": "2023-05-15T10:30:00Z",
3
    "direction": "EMAIL",
4
    "hubspot_owner_id": "12345",
5
    "status": "SENT",
6
    "subject": "Follow-up on our recent conversation",
7
    "text": "Dear John,\n\nThank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...\n\nBest regards,\nJane Smith",
8
    "email_html": "<html><body><p>Dear John,</p><p>Thank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...</p><p>Best regards,<br>Jane Smith</p></body></html>",
9
    "headers": {
10
        "from": {
11
            "email": "jane.smith@example.com",
12
            "first_name": "Jane",
13
            "last_name": "Smith"
14
        },
15
        "to": [
16
            {
17
                "email": "john.doe@company.com",
18
                "first_name": "John",
19
                "last_name": "Doe"
20
            }
21
        ],
22
        "cc": [
23
            {
24
                "email": "sarah.johnson@example.com",
25
                "first_name": "Sarah",
26
                "last_name": "Johnson"
27
            }
28
        ],
29
        "bcc": []
30
    },
31
    "attachment_ids": [
32
        "67890",
33
        "12345"
34
    ]
35
}

Sample Output

1
{
2
    "id": "987654321",
3
    "properties": {
4
        "hs_all_owner_ids": "12345",
5
        "hs_attachment_ids": "67890;12345",
6
        "hs_body_preview": "Dear John, Thank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...",
7
        "hs_body_preview_html": "<p>Dear John,</p><p>Thank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...</p>",
8
        "hs_body_preview_is_truncated": "false",
9
        "hs_createdate": "2023-05-15T10:30:00Z",
10
        "hs_email_direction": "EMAIL",
11
        "hs_email_from_email": "jane.smith@example.com",
12
        "hs_email_from_firstname": "Jane",
13
        "hs_email_from_lastname": "Smith",
14
        "hs_email_headers": "{\"from\":{\"email\":\"jane.smith@example.com\",\"first_name\":\"Jane\",\"last_name\":\"Smith\"},\"to\":[{\"email\":\"john.doe@company.com\",\"first_name\":\"John\",\"last_name\":\"Doe\"}],\"cc\":[{\"email\":\"sarah.johnson@example.com\",\"first_name\":\"Sarah\",\"last_name\":\"Johnson\"}],\"bcc\":[]}",
15
        "hs_email_html": "<html><body><p>Dear John,</p><p>Thank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...</p><p>Best regards,<br>Jane Smith</p></body></html>",
16
        "hs_email_status": "SENT",
17
        "hs_email_subject": "Follow-up on our recent conversation",
18
        "hs_email_text": "Dear John,\n\nThank you for taking the time to speak with me yesterday. I wanted to follow up on a few points we discussed...\n\nBest regards,\nJane Smith",
19
        "hs_email_to_email": "john.doe@company.com",
20
        "hs_email_to_firstname": "John",
21
        "hs_email_to_lastname": "Doe",
22
        "hs_lastmodifieddate": "2023-05-15T10:30:05Z",
23
        "hs_object_id": "987654321",
24
        "hs_timestamp": "2023-05-15T10:30:00Z",
25
        "hs_user_ids_of_all_owners": "12345",
26
        "hubspot_owner_assigneddate": "2023-05-15T10:30:00Z",
27
        "hubspot_owner_id": "12345"
28
    },
29
    "createdAt": "2023-05-15T10:30:00Z",
30
    "updatedAt": "2023-05-15T10:30:05Z",
31
    "archived": false
32
}

Create line item
Copy

Create a line item in your HubSpot account.

Sample Input

1
{
2
    "properties": [
3
        {
4
            "name": "name",
5
            "value": "Premium Software License"
6
        },
7
        {
8
            "name": "amount",
9
            "value": 1000
10
        },
11
        {
12
            "name": "price",
13
            "value": 500
14
        },
15
        {
16
            "name": "description",
17
            "value": "Annual subscription for premium software package"
18
        },
19
        {
20
            "name": "hs_recurring_billing_number_of_payments",
21
            "value": 12
22
        }
23
    ]
24
}

Sample Output

1
{
2
    "id": "123456",
3
    "properties": {
4
        "amount": "1000",
5
        "createdate": "2023-05-15T10:30:00.000Z",
6
        "description": "Annual subscription for premium software package",
7
        "hs_acv": "6000",
8
        "hs_arr": "6000",
9
        "hs_lastmodifieddate": "2023-05-15T10:30:00.000Z",
10
        "hs_margin": "50",
11
        "hs_margin_acv": "3000",
12
        "hs_margin_arr": "3000",
13
        "hs_margin_mrr": "250",
14
        "hs_margin_tcv": "3000",
15
        "hs_mrr": "500",
16
        "hs_object_id": "123456",
17
        "hs_pre_discount_amount": "1000",
18
        "hs_recurring_billing_number_of_payments": "12",
19
        "hs_tcv": "6000",
20
        "hs_total_discount": "0",
21
        "name": "Premium Software License",
22
        "price": "500"
23
    },
24
    "createdAt": "2023-05-15T10:30:00.000Z",
25
    "updatedAt": "2023-05-15T10:30:00.000Z",
26
    "archived": false
27
}

Create marketing event (beta)
Copy

Create a new marketing event in HubSpot.

Sample Input

1
{
2
    "external_account_id": "123456",
3
    "external_event_id": "WEBINAR2023",
4
    "event_name": "Advanced Marketing Strategies Webinar",
5
    "event_organizer": "HubSpot Marketing Team",
6
    "event_type": "WEBINAR",
7
    "start_date_time": "2023-09-15T14:00:00Z",
8
    "end_date_time": "2023-09-15T16:00:00Z",
9
    "event_description": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.",
10
    "event_url": "https://www.hubspot.com/webinars/advanced-marketing-strategies",
11
    "event_cancelled": false,
12
    "custom_properties": [
13
        {
14
            "name": "max_attendees",
15
            "value": "500"
16
        },
17
        {
18
            "name": "target_audience",
19
            "value": "Marketing Professionals"
20
        }
21
    ]
22
}

Sample Output

1
{
2
    "eventName": "Advanced Marketing Strategies Webinar",
3
    "eventType": "WEBINAR",
4
    "startDateTime": "2023-09-15T14:00:00Z",
5
    "endDateTime": "2023-09-15T16:00:00Z",
6
    "eventOrganizer": "HubSpot Marketing Team",
7
    "eventDescription": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.",
8
    "eventUrl": "https://www.hubspot.com/webinars/advanced-marketing-strategies",
9
    "eventCancelled": false,
10
    "customProperties": [
11
        {
12
            "name": "max_attendees",
13
            "value": "500",
14
            "timestamp": 1631707200000,
15
            "sourceId": "WEBINAR2023",
16
            "sourceLabel": "HubSpot",
17
            "source": "API",
18
            "selectedByUser": false,
19
            "selectedByUserTimestamp": 1631707200000,
20
            "sourceVid": [
21
                123456
22
            ],
23
            "sourceMetadata": "",
24
            "requestId": "abc123def456"
25
        },
26
        {
27
            "name": "target_audience",
28
            "value": "Marketing Professionals",
29
            "timestamp": 1631707200000,
30
            "sourceId": "WEBINAR2023",
31
            "sourceLabel": "HubSpot",
32
            "source": "API",
33
            "selectedByUser": false,
34
            "selectedByUserTimestamp": 1631707200000,
35
            "sourceVid": [
36
                123456
37
            ],
38
            "sourceMetadata": "",
39
            "requestId": "abc123def456"
40
        }
41
    ]
42
}

Create meeting engagement
Copy

Create a meeting with the given properties.

Sample Input

1
{
2
    "timestamp": "2023-05-15T14:30:00Z",
3
    "title": "Product Demo with Acme Corp",
4
    "body": "Demonstration of our new software features to Acme Corp team.",
5
    "internal_meeting_notes": "Prepare slides for new analytics dashboard",
6
    "hubspot_owner_id": "12345",
7
    "external_url": "https://meet.google.com/abc-defg-hij",
8
    "location": "Google Meet",
9
    "start_time": "2023-05-15T14:30:00Z",
10
    "end_time": "2023-05-15T15:30:00Z",
11
    "meeting_outcome": "SCHEDULED",
12
    "meeting_type": "Product Demo",
13
    "attachment_ids": [
14
        "67890",
15
        "54321"
16
    ]
17
}

Sample Output

1
{
2
    "id": "987654321",
3
    "properties": {
4
        "hs_attachment_ids": "67890;54321",
5
        "hs_body_preview": "Demonstration of our new software features to Acme Corp team.",
6
        "hs_body_preview_html": "<p>Demonstration of our new software features to Acme Corp team.</p>",
7
        "hs_body_preview_is_truncated": "false",
8
        "hs_createdate": "2023-05-15T14:30:00Z",
9
        "hs_internal_meeting_notes": "Prepare slides for new analytics dashboard",
10
        "hs_lastmodifieddate": "2023-05-15T14:30:00Z",
11
        "hs_meeting_body": "Demonstration of our new software features to Acme Corp team.",
12
        "hs_meeting_end_time": "2023-05-15T15:30:00Z",
13
        "hs_meeting_external_url": "https://meet.google.com/abc-defg-hij",
14
        "hs_meeting_location": "Google Meet",
15
        "hs_meeting_outcome": "SCHEDULED",
16
        "hs_meeting_source": "API",
17
        "hs_meeting_start_time": "2023-05-15T14:30:00Z",
18
        "hs_meeting_title": "Product Demo with Acme Corp",
19
        "hs_object_id": "987654321",
20
        "hs_timestamp": "2023-05-15T14:30:00Z"
21
    },
22
    "createdAt": "2023-05-15T14:30:00Z",
23
    "updatedAt": "2023-05-15T14:30:00Z",
24
    "archived": false
25
}

Create note engagement
Copy

Create a note with the given properties.

Sample Input

1
{
2
    "timestamp": "2023-05-15T14:30:00Z",
3
    "note_body": "Had a great call with the client today. They're interested in our premium package and would like a follow-up demo next week.",
4
    "hubspot_owner_id": "51",
5
    "attachment_ids": [
6
        "1234",
7
        "5678"
8
    ]
9
}

Sample Output

1
{
2
    "id": "987654321",
3
    "properties": {
4
        "hs_all_owner_ids": "51",
5
        "hs_attachment_ids": "1234;5678",
6
        "hs_body_preview": "Had a great call with the client today. They're interested in our premium package and would like a follow-up demo next week.",
7
        "hs_body_preview_html": "<p>Had a great call with the client today. They're interested in our premium package and would like a follow-up demo next week.</p>",
8
        "hs_body_preview_is_truncated": "false",
9
        "hs_createdate": "2023-05-15T14:30:00.000Z",
10
        "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z",
11
        "hs_note_body": "Had a great call with the client today. They're interested in our premium package and would like a follow-up demo next week.",
12
        "hs_object_id": "987654321",
13
        "hs_timestamp": "2023-05-15T14:30:00.000Z",
14
        "hs_user_ids_of_all_owners": "51",
15
        "hubspot_owner_assigneddate": "2023-05-15T14:30:00.000Z",
16
        "hubspot_owner_id": "51"
17
    },
18
    "createdAt": "2023-05-15T14:30:00.000Z",
19
    "updatedAt": "2023-05-15T14:30:00.000Z",
20
    "archived": false
21
}

Create object schema
Copy

Define a new object schema, along with custom properties and associations.

Sample Input

1
{
2
    "custom_object_name": "Project",
3
    "custom_object_schema_properties": [
4
        {
5
            "name": "project_name",
6
            "label": "Project Name",
7
            "type": "string",
8
            "field_type": "text",
9
            "group_name": "project_info",
10
            "description": "The name of the project",
11
            "display_order": 1,
12
            "has_unique_value": true,
13
            "hidden": false
14
        },
15
        {
16
            "name": "start_date",
17
            "label": "Start Date",
18
            "type": "date",
19
            "field_type": "date",
20
            "group_name": "project_info",
21
            "description": "The start date of the project",
22
            "display_order": 2,
23
            "has_unique_value": false,
24
            "hidden": false
25
        },
26
        {
27
            "name": "budget",
28
            "label": "Budget",
29
            "type": "number",
30
            "field_type": "number",
31
            "group_name": "project_info",
32
            "description": "The budget allocated for the project",
33
            "display_order": 3,
34
            "has_unique_value": false,
35
            "hidden": false
36
        },
37
        {
38
            "name": "status",
39
            "label": "Status",
40
            "type": "enumeration",
41
            "field_type": "select",
42
            "group_name": "project_info",
43
            "description": "The current status of the project",
44
            "display_order": 4,
45
            "has_unique_value": false,
46
            "hidden": false
47
        }
48
    ],
49
    "labels": {
50
        "singular": "Project",
51
        "plural": "Projects"
52
    },
53
    "primary_display_property": "project_name",
54
    "secondary_display_properties": [
55
        "start_date",
56
        "status"
57
    ],
58
    "required_properties": [
59
        "project_name",
60
        "start_date"
61
    ],
62
    "searchable_properties": [
63
        "project_name",
64
        "status"
65
    ],
66
    "associated_objects": [
67
        "contacts",
68
        "companies"
69
    ],
70
    "meta_type": "PORTAL_SPECIFIC"
71
}

Sample Output

1
{
2
    "labels": {
3
        "singular": "Project",
4
        "plural": "Projects"
5
    },
6
    "requiredProperties": [
7
        "project_name",
8
        "start_date"
9
    ],
10
    "searchableProperties": [
11
        "project_name",
12
        "status"
13
    ],
14
    "primaryDisplayProperty": "project_name",
15
    "secondaryDisplayProperties": [
16
        "start_date",
17
        "status"
18
    ],
19
    "archived": false,
20
    "restorable": true,
21
    "metaType": "PORTAL_SPECIFIC",
22
    "id": "2-12345678",
23
    "fullyQualifiedName": "p12345678.Project",
24
    "createdAt": "2023-06-15T10:30:00.000Z",
25
    "updatedAt": "2023-06-15T10:30:00.000Z",
26
    "objectTypeId": "2-12345678",
27
    "properties": [
28
        {
29
            "updatedAt": "2023-06-15T10:30:00.000Z",
30
            "createdAt": "2023-06-15T10:30:00.000Z",
31
            "name": "project_name",
32
            "label": "Project Name",
33
            "type": "string",
34
            "fieldType": "text",
35
            "description": "The name of the project",
36
            "groupName": "project_info",
37
            "displayOrder": 1,
38
            "calculated": false,
39
            "externalOptions": false,
40
            "archived": false,
41
            "hasUniqueValue": true,
42
            "hidden": false,
43
            "modificationMetadata": {
44
                "archivable": true,
45
                "readOnlyDefinition": false,
46
                "readOnlyValue": false
47
            },
48
            "formField": true
49
        },
50
        {
51
            "updatedAt": "2023-06-15T10:30:00.000Z",
52
            "createdAt": "2023-06-15T10:30:00.000Z",
53
            "name": "start_date",
54
            "label": "Start Date",
55
            "type": "date",
56
            "fieldType": "date",
57
            "description": "The start date of the project",
58
            "groupName": "project_info",
59
            "displayOrder": 2,
60
            "calculated": false,
61
            "externalOptions": false,
62
            "archived": false,
63
            "hasUniqueValue": false,
64
            "hidden": false,
65
            "modificationMetadata": {
66
                "archivable": true,
67
                "readOnlyDefinition": false,
68
                "readOnlyValue": false
69
            },
70
            "formField": true
71
        },
72
        {
73
            "updatedAt": "2023-06-15T10:30:00.000Z",
74
            "createdAt": "2023-06-15T10:30:00.000Z",
75
            "name": "budget",
76
            "label": "Budget",
77
            "type": "number",
78
            "fieldType": "number",
79
            "description": "The budget allocated for the project",
80
            "groupName": "project_info",
81
            "displayOrder": 3,
82
            "calculated": false,
83
            "externalOptions": false,
84
            "archived": false,
85
            "hasUniqueValue": false,
86
            "hidden": false,
87
            "modificationMetadata": {
88
                "archivable": true,
89
                "readOnlyDefinition": false,
90
                "readOnlyValue": false
91
            },
92
            "formField": true
93
        },
94
        {
95
            "updatedAt": "2023-06-15T10:30:00.000Z",
96
            "createdAt": "2023-06-15T10:30:00.000Z",
97
            "name": "status",
98
            "label": "Status",
99
            "type": "enumeration",
100
            "fieldType": "select",
101
            "description": "The current status of the project",
102
            "groupName": "project_info",
103
            "options": [
104
                "Not Started",
105
                "In Progress",
106
                "Completed",
107
                "On Hold"
108
            ],
109
            "displayOrder": 4,
110
            "calculated": false,
111
            "externalOptions": false,
112
            "archived": false,
113
            "hasUniqueValue": false,
114
            "hidden": false,
115
            "modificationMetadata": {
116
                "archivable": true,
117
                "readOnlyDefinition": false,
118
                "readOnlyValue": false
119
            },
120
            "formField": true
121
        }
122
    ],
123
    "associations": [
124
        {
125
            "fromObjectTypeId": "2-12345678",
126
            "toObjectTypeId": "0-1",
127
            "name": "project_to_contact",
128
            "cardinality": "MANY_TO_MANY",
129
            "inverseCardinality": "MANY_TO_MANY",
130
            "id": "3-12345678",
131
            "createdAt": "2023-06-15T10:30:00.000Z",
132
            "updatedAt": "2023-06-15T10:30:00.000Z"
133
        },
134
        {
135
            "fromObjectTypeId": "2-12345678",
136
            "toObjectTypeId": "0-2",
137
            "name": "project_to_company",
138
            "cardinality": "MANY_TO_MANY",
139
            "inverseCardinality": "MANY_TO_MANY",
140
            "id": "3-87654321",
141
            "createdAt": "2023-06-15T10:30:00.000Z",
142
            "updatedAt": "2023-06-15T10:30:00.000Z"
143
        }
144
    ],
145
    "name": "Project"
146
}

Create product
Copy

Create a product in your Hubspot account.

Sample Input

1
{
2
    "properties": [
3
        {
4
            "name": "name",
5
            "value": "Premium Widget"
6
        },
7
        {
8
            "name": "description",
9
            "value": "High-quality widget with advanced features"
10
        },
11
        {
12
            "name": "price",
13
            "value": 99.99
14
        },
15
        {
16
            "name": "hs_cost_of_goods_sold",
17
            "value": 49.99
18
        }
19
    ]
20
}

Sample Output

1
{
2
    "id": "1234567",
3
    "properties": {
4
        "createdate": "2023-05-15T10:30:00.000Z",
5
        "description": "High-quality widget with advanced features",
6
        "hs_cost_of_goods_sold": "49.99",
7
        "hs_lastmodifieddate": "2023-05-15T10:30:00.000Z",
8
        "hs_object_id": "1234567",
9
        "name": "Premium Widget",
10
        "price": "99.99"
11
    },
12
    "createdAt": "2023-05-15T10:30:00.000Z",
13
    "updatedAt": "2023-05-15T10:30:00.000Z",
14
    "archived": false
15
}

Create property
Copy

Create a property on an object type.

Sample Input

1
{
2
    "object_type": "contacts",
3
    "properties": {
4
        "name": "customer_satisfaction_score",
5
        "data_type": "number",
6
        "field_type": "number",
7
        "group_name": "customer_data",
8
        "label": "Customer Satisfaction Score",
9
        "description": "The customer's satisfaction score on a scale of 1-10",
10
        "hidden": false,
11
        "display_order": 1
12
    }
13
}

Sample Output

1
{
2
    "name": "customer_satisfaction_score",
3
    "label": "Customer Satisfaction Score",
4
    "description": "The customer's satisfaction score on a scale of 1-10",
5
    "groupName": "customer_data",
6
    "type": "number",
7
    "fieldType": "number",
8
    "hidden": false,
9
    "options": [],
10
    "deleted": false,
11
    "createdAt": 1623456789000,
12
    "formField": true,
13
    "displayOrder": 1,
14
    "readOnlyValue": false,
15
    "readOnlyDefinition": false,
16
    "mutableDefinitionNotDeletable": false,
17
    "favorited": false,
18
    "calculated": false,
19
    "externalOptions": false,
20
    "displayMode": "default",
21
    "showCurrencySymbol": false,
22
    "hubspotDefined": false,
23
    "updatedAt": 1623456789000,
24
    "hasUniqueValue": false,
25
    "createdUserId": 12345,
26
    "updatedUserId": 12345,
27
    "searchableInGlobalSearch": true,
28
    "numberDisplayHint": "decimal"
29
}

Create property group
Copy

Create a new property group for an object type.

Sample Input

1
{
2
    "object_type": "contacts",
3
    "properties": {
4
        "internal_name": "social_media_info",
5
        "display_name": "Social Media Information",
6
        "display_order": 2,
7
        "additional_properties": {
8
            "description": "Group for social media related properties"
9
        }
10
    }
11
}

Sample Output

1
{
2
    "portalId": 6789012,
3
    "name": "social_media_info",
4
    "displayName": "Social Media Information",
5
    "displayOrder": 2
6
}

Create task engagement
Copy

Create a task with the given properties.

Sample Input

1
{
2
    "timestamp": "2023-05-15T14:30:00Z",
3
    "subject": "Follow up with client",
4
    "body": "Discuss project timeline and next steps",
5
    "hubspot_owner_id": "12345",
6
    "status": "NOT_STARTED",
7
    "priority": "HIGH",
8
    "type": "CALL"
9
}

Sample Output

1
{
2
    "id": "987654321",
3
    "properties": {
4
        "hs_all_owner_ids": "12345",
5
        "hs_body_preview": "Discuss project timeline and next steps",
6
        "hs_body_preview_html": "<p>Discuss project timeline and next steps</p>",
7
        "hs_body_preview_is_truncated": "false",
8
        "hs_createdate": "2023-05-15T14:30:00Z",
9
        "hs_lastmodifieddate": "2023-05-15T14:30:00Z",
10
        "hs_object_id": "987654321",
11
        "hs_task_body": "Discuss project timeline and next steps",
12
        "hs_task_for_object_type": "CONTACT",
13
        "hs_task_is_all_day": "false",
14
        "hs_task_priority": "HIGH",
15
        "hs_task_status": "NOT_STARTED",
16
        "hs_task_subject": "Follow up with client",
17
        "hs_task_type": "CALL",
18
        "hs_timestamp": "2023-05-15T14:30:00Z",
19
        "hs_user_ids_of_all_owners": "12345",
20
        "hubspot_owner_assigneddate": "2023-05-15T14:30:00Z",
21
        "hubspot_owner_id": "12345"
22
    },
23
    "createdAt": "2023-05-15T14:30:00Z",
24
    "updatedAt": "2023-05-15T14:30:00Z",
25
    "archived": false
26
}

Create ticket
Copy

Create a ticket in your Hubspot account.

Sample Input

1
{
2
    "ticket_pipeline_id": "123456",
3
    "ticket_pipeline_stage": "new",
4
    "properties": [
5
        {
6
            "name": "subject",
7
            "value": "Website issue - Unable to login"
8
        },
9
        {
10
            "name": "content",
11
            "value": "Customer reported inability to log in to their account on our website."
12
        },
13
        {
14
            "name": "hs_pipeline",
15
            "value": "123456"
16
        },
17
        {
18
            "name": "hs_pipeline_stage",
19
            "value": "new"
20
        },
21
        {
22
            "name": "hs_ticket_priority",
23
            "value": "HIGH"
24
        }
25
    ]
26
}

Sample Output

1
{
2
    "id": "987654",
3
    "properties": {
4
        "createdate": "2023-05-15T14:30:00.000Z",
5
        "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z",
6
        "hs_object_id": "987654",
7
        "hs_pipeline": "123456",
8
        "hs_pipeline_stage": "new",
9
        "hs_ticket_id": "987654",
10
        "subject": "Website issue - Unable to login"
11
    },
12
    "createdAt": "2023-05-15T14:30:00.000Z",
13
    "updatedAt": "2023-05-15T14:30:00.000Z",
14
    "archived": false
15
}

Create/update contact
Copy

If contact already exists update their data. Create a new contact if not i.e. Upsert

Sample Input

1
{
2
    "email": "john.doe@example.com",
3
    "properties": [
4
        {
5
            "property": "firstname",
6
            "value": "John"
7
        },
8
        {
9
            "property": "lastname",
10
            "value": "Doe"
11
        },
12
        {
13
            "property": "phone",
14
            "value": "+1 (555) 123-4567"
15
        },
16
        {
17
            "property": "company",
18
            "value": "Acme Inc."
19
        },
20
        {
21
            "property": "jobtitle",
22
            "value": "Software Engineer"
23
        }
24
    ]
25
}

Sample Output

1
{
2
    "vid": 12345678,
3
    "isNew": false
4
}

Create/update marketing event (beta)
Copy

If a marketing event already exists update the data. Create a new marketing event if it does not i.e. Upsert

Sample Input

1
{
2
    "external_account_id": "123456",
3
    "external_event_id": "WEBINAR2023",
4
    "event_name": "Advanced Marketing Strategies Webinar",
5
    "event_organizer": "HubSpot Academy",
6
    "event_type": "WEBINAR",
7
    "start_date_time": "2023-09-15T14:00:00Z",
8
    "end_date_time": "2023-09-15T16:00:00Z",
9
    "event_description": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.",
10
    "event_url": "https://hubspot.com/webinars/advanced-marketing-strategies",
11
    "event_cancelled": false,
12
    "custom_properties": [
13
        {
14
            "name": "max_attendees",
15
            "value": "500"
16
        },
17
        {
18
            "name": "target_audience",
19
            "value": "Marketing Professionals"
20
        }
21
    ]
22
}

Sample Output

1
{
2
    "eventName": "Advanced Marketing Strategies Webinar",
3
    "eventType": "WEBINAR",
4
    "startDateTime": "2023-09-15T14:00:00Z",
5
    "endDateTime": "2023-09-15T16:00:00Z",
6
    "eventOrganizer": "HubSpot Academy",
7
    "eventDescription": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.",
8
    "eventUrl": "https://hubspot.com/webinars/advanced-marketing-strategies",
9
    "eventCancelled": false,
10
    "customProperties": [
11
        {
12
            "name": "max_attendees",
13
            "value": "500",
14
            "timestamp": 1631721600000,
15
            "sourceId": "WEBINAR2023",
16
            "sourceLabel": "HubSpot",
17
            "source": "API",
18
            "selectedByUser": false,
19
            "selectedByUserTimestamp": 1631721600000,
20
            "sourceVid": [
21
                123456
22
            ],
23
            "sourceMetadata": "",
24
            "requestId": "abc123def456"
25
        },
26
        {
27
            "name": "target_audience",
28
            "value": "Marketing Professionals",
29
            "timestamp": 1631721600000,
30
            "sourceId": "WEBINAR2023",
31
            "sourceLabel": "HubSpot",
32
            "source": "API",
33
            "selectedByUser": false,
34
            "selectedByUserTimestamp": 1631721600000,
35
            "sourceVid": [
36
                123456
37
            ],
38
            "sourceMetadata": "",
39
            "requestId": "abc123def456"
40
        }
41
    ]
42
}

Delete associations from CRM objects
Copy

Delete all associations between two records.

Sample Input

1
{
2
    "object_type": "Contacts",
3
    "object_id": "51",
4
    "to_object_type": "Deals",
5
    "to_object_id": "1001"
6
}

Sample Output

1
{
2
    "success": true
3
}

Delete blog post
Copy

Delete a specified blog post.

Sample Input

1
{
2
    "blog_id": "12345678",
3
    "archived": false
4
}

Sample Output

1
{
2
    "success": true
3
}

Delete comment
Copy

Mark the comment as deleted.

Sample Input

1
{
2
    "comment_id": "123456789"
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete company
Copy

Delete a company by the given ID.

Sample Input

1
{
2
    "company_id": "1234567"
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete contact
Copy

Delete contact.

Sample Input

1
{
2
    "contact_id": "51"
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete contact list
Copy

Delete a contact list.

Sample Input

1
{
2
    "contact_list_id": "1234"
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete custom object association
Copy

Delete a custom object association.

Sample Input

1
{
2
    "custom_object_type": "2-12345678",
3
    "object_id": "3456789",
4
    "to_object_type": "Deals",
5
    "to_object_id": "7890123",
6
    "associated_objects": [
7
        "custom_object_to_deal"
8
    ]
9
}

Sample Output

1
{
2
    "success": true
3
}

Delete deal
Copy

Delete a deal by the given ID.

Sample Input

1
{
2
    "deal_id": 123456789
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete line item
Copy

Delete a line item by the given ID.

Sample Input

1
{
2
    "line_item_id": "1234567890"
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete object schema
Copy

Delete a schema. NB: Any existing records of this schema must be deleted first, otherwise this request will fail.

Sample Input

1
{
2
    "custom_object_type": "2-12345678",
3
    "archived": false
4
}

Sample Output

1
{
2
    "success": true
3
}

Delete product
Copy

Delete a product by the given ID.

Sample Input

1
{
2
    "product_id": 12345
3
}

Sample Output

1
{
2
    "success": true
3
}

Delete ticket
Copy

Delete a ticket by the given ID.

Sample Input

1
{
2
    "ticket_id": "123456"
3
}

Sample Output

1
{
2
    "success": true
3
}

Get app settings (beta)
Copy

Retrieve the current settings for the application.

Sample Input

1
{
2
    "app_id": "123456"
3
}

Sample Output

1
{
2
    "appId": 123456,
3
    "eventDetailsUrl": "https://app.hubspot.com/developer-events/123456"
4
}

Get blog post
Copy

Retrieve a specified blog post.

Sample Input

1
{
2
    "blog_id": "12345678"
3
}

Sample Output

1
{
2
    "archived": false,
3
    "attachedStylesheets": [],
4
    "authorName": "John Doe",
5
    "blogAuthorId": "98765432",
6
    "categoryId": 1,
7
    "contentGroupId": "abcdef123456",
8
    "contentTypeCategory": 2,
9
    "created": "2023-05-15T10:30:00Z",
10
    "createdById": "user123",
11
    "currentState": "PUBLISHED",
12
    "currentlyPublished": true,
13
    "deletedAt": null,
14
    "domain": "https://www.example.com",
15
    "enableGoogleAmpOutputOverride": false,
16
    "featuredImage": "https://www.example.com/images/featured-image.jpg",
17
    "featuredImageAltText": "A person typing on a laptop",
18
    "htmlTitle": "10 Tips for Effective Content Marketing",
19
    "id": "87654321",
20
    "metaDescription": "Learn 10 essential tips for creating and implementing an effective content marketing strategy for your business.",
21
    "name": "10 Tips for Effective Content Marketing",
22
    "pageRedirected": false,
23
    "postBody": "<p>Content marketing is crucial for businesses looking to attract and engage their target audience. Here are 10 tips to help you create an effective content marketing strategy:</p><ol><li>Know your audience</li><li>Set clear goals</li><li>Create valuable content</li><li>Be consistent</li><li>Optimize for SEO</li><li>Use various content formats</li><li>Promote your content</li><li>Engage with your audience</li><li>Measure and analyze results</li><li>Continuously improve</li></ol>",
24
    "postSummary": "Discover 10 essential tips for creating and implementing an effective content marketing strategy that will help your business attract and engage your target audience.",
25
    "publicAccessRules": [],
26
    "publicAccessRulesEnabled": false,
27
    "publishDate": "2023-05-15T12:00:00Z",
28
    "publishImmediately": false,
29
    "rssBody": "Content marketing is crucial for businesses looking to attract and engage their target audience. Here are 10 tips to help you create an effective content marketing strategy...",
30
    "rssSummary": "Learn 10 essential tips for creating and implementing an effective content marketing strategy for your business.",
31
    "slug": "10-tips-for-effective-content-marketing",
32
    "state": "PUBLISHED",
33
    "subcategory": "Marketing Strategy",
34
    "tagIds": [
35
        "tag1",
36
        "tag2",
37
        "tag3"
38
    ],
39
    "templatePath": "blog-post-template",
40
    "updated": "2023-05-15T11:45:00Z",
41
    "updatedById": "user456",
42
    "url": "https://www.example.com/blog/10-tips-for-effective-content-marketing",
43
    "useFeaturedImage": true,
44
    "widgetContainers": {},
45
    "widgets": {}
46
}

Get company
Copy

Return a company by the given ID.

Sample Input

1
{
2
    "company_id": "1234567",
3
    "include_all_properties": true,
4
    "properties": [
5
        "name",
6
        "domain",
7
        "phone"
8
    ],
9
    "properties_with_history": [
10
        "revenue"
11
    ],
12
    "associations": [
13
        "contacts",
14
        "deals"
15
    ],
16
    "archived": false
17
}

Sample Output

1
{
2
    "id": "1234567",
3
    "properties": {
4
        "createdate": "2023-05-15T10:30:00Z",
5
        "domain": "example.com",
6
        "hs_lastmodifieddate": "2023-06-01T14:45:00Z",
7
        "hs_object_id": "1234567",
8
        "name": "Example Company",
9
        "phone": "+1 (555) 123-4567",
10
        "revenue": {
11
            "value": "1000000",
12
            "versions": [
13
                {
14
                    "value": "800000",
15
                    "timestamp": "2023-01-01T00:00:00Z"
16
                },
17
                {
18
                    "value": "900000",
19
                    "timestamp": "2023-03-15T00:00:00Z"
20
                },
21
                {
22
                    "value": "1000000",
23
                    "timestamp": "2023-06-01T00:00:00Z"
24
                }
25
            ]
26
        }
27
    },
28
    "createdAt": "2023-05-15T10:30:00Z",
29
    "updatedAt": "2023-06-01T14:45:00Z",
30
    "archived": false,
31
    "associations": {
32
        "contacts": [
33
            "2345678",
34
            "3456789"
35
        ],
36
        "deals": [
37
            "4567890",
38
            "5678901"
39
        ]
40
    }
41
}

Get company property
Copy

Get a specific company property by its (internal) name.

Sample Input

1
{
2
    "property_name": "industry"
3
}

Sample Output

1
{
2
    "name": "industry",
3
    "label": "Industry",
4
    "description": "The industry the company operates in",
5
    "groupName": "companyinformation",
6
    "type": "enumeration",
7
    "fieldType": "select",
8
    "createdUserId": 12345,
9
    "searchableInGlobalSearch": true,
10
    "referencedObjectType": null,
11
    "hasUniqueValue": false,
12
    "optionSortStrategy": "SORTED",
13
    "numberDisplayHint": null,
14
    "currencyPropertyName": null,
15
    "textDisplayHint": null,
16
    "optionsAreMutable": true,
17
    "isCustomizedDefault": false,
18
    "searchTextAnalysisMode": "EXACT_MATCH",
19
    "updatedUserId": 67890,
20
    "hidden": false,
21
    "options": [
22
        {
23
            "description": null,
24
            "label": "Technology",
25
            "displayOrder": 1,
26
            "hidden": false,
27
            "readOnly": false,
28
            "doubleData": false,
29
            "value": "TECHNOLOGY"
30
        },
31
        {
32
            "description": null,
33
            "label": "Healthcare",
34
            "displayOrder": 2,
35
            "hidden": false,
36
            "readOnly": false,
37
            "doubleData": false,
38
            "value": "HEALTHCARE"
39
        }
40
    ],
41
    "deleted": false,
42
    "createdAt": "2023-05-15T10:30:00Z",
43
    "formField": true,
44
    "displayOrder": 5,
45
    "readOnlyValue": false,
46
    "readOnlyDefinition": false,
47
    "mutableDefinitionNotDeletable": false,
48
    "favorited": true,
49
    "favoritedOrder": 1,
50
    "calculated": false,
51
    "externalOptions": false,
52
    "displayMode": "DROPDOWN",
53
    "showCurrencySymbol": null,
54
    "hubspotDefined": true,
55
    "updatedAt": "2023-05-16T14:45:00Z"
56
}

Get contact by email
Copy

Return a contact by the given email address.

Sample Input

1
{
2
    "email": "john.doe@example.com",
3
    "include_all_properties": true,
4
    "properties": [
5
        "firstname",
6
        "lastname",
7
        "phone"
8
    ]
9
}

Sample Output

1
{
2
    "id": "1234567",
3
    "properties": {
4
        "createdate": "2023-05-15T10:30:00Z",
5
        "firstname": "John",
6
        "hs_object_id": "1234567",
7
        "lastmodifieddate": "2023-05-20T14:45:00Z",
8
        "lastname": "Doe",
9
        "phone": "+1 (555) 123-4567"
10
    },
11
    "createdAt": "2023-05-15T10:30:00Z",
12
    "updatedAt": "2023-05-20T14:45:00Z",
13
    "archived": false
14
}

Get contact by ID
Copy

Return a contact by the given ID.

Sample Input

1
{
2
    "contact_id": "51",
3
    "include_all_properties": true,
4
    "properties": [
5
        "email",
6
        "firstname",
7
        "lastname"
8
    ],
9
    "properties_with_history": [
10
        "email"
11
    ],
12
    "associations": [
13
        "company",
14
        "deal"
15
    ],
16
    "archived": false
17
}

Sample Output

1
{
2
    "id": "51",
3
    "properties": {
4
        "createdate": "2023-05-15T10:30:00Z",
5
        "email": "john.doe@example.com",
6
        "firstname": "John",
7
        "hs_object_id": "51",
8
        "lastmodifieddate": "2023-05-20T14:45:00Z",
9
        "lastname": "Doe"
10
    },
11
    "createdAt": "2023-05-15T10:30:00Z",
12
    "updatedAt": "2023-05-20T14:45:00Z",
13
    "archived": false
14
}

Get contact list
Copy

Return a contact list with the given ID.

Sample Input

1
{
2
    "contact_list_id": "123456"
3
}

Sample Output

1
{
2
    "portalId": 987654,
3
    "listId": 123456,
4
    "internalListId": 789012,
5
    "createdAt": 1623456789000,
6
    "updatedAt": 1634567890000,
7
    "name": "Newsletter Subscribers",
8
    "listType": "STATIC",
9
    "authorId": 54321,
10
    "filters": [
11
        [
12
            {
13
                "filterFamily": "PropertyValue",
14
                "withinTimeMode": "PAST",
15
                "propertyName": "email",
16
                "operator": "HAS_PROPERTY"
17
            }
18
        ]
19
    ],
20
    "metaData": {
21
        "size": 1500,
22
        "lastSizeChangeAt": 1634567890000,
23
        "processing": "DONE",
24
        "lastProcessingStateChangeAt": 1634567890000,
25
        "error": null
26
    },
27
    "archived": false,
28
    "teamIds": [
29
        1234,
30
        5678
31
    ],
32
    "ilsFilterBranch": "AND",
33
    "limitExempt": false,
34
    "dynamic": false,
35
    "internal": false,
36
    "deleted": false,
37
    "readOnly": false
38
}

Get contact property
Copy

Retrieve contact property.

Sample Input

1
{
2
    "property_name": "email"
3
}

Sample Output

1
{
2
    "name": "email",
3
    "label": "Email",
4
    "description": "A contact's email address",
5
    "groupName": "contactinformation",
6
    "type": "string",
7
    "fieldType": "text",
8
    "deleted": false,
9
    "formField": true,
10
    "readOnlyValue": false,
11
    "mutableDefinitionNotDeletable": true,
12
    "favorited": true,
13
    "favoritedOrder": 1,
14
    "calculated": false,
15
    "externalOptions": false,
16
    "displayMode": "simple",
17
    "showCurrencySymbol": false,
18
    "textDisplayHint": "default",
19
    "optionsAreMutable": false,
20
    "searchTextAnalysisMode": false,
21
    "optionSortStrategy": "alphabetical",
22
    "updatedAt": 1623456789000,
23
    "displayOrder": 2,
24
    "hubspotDefined": true,
25
    "hidden": false,
26
    "isCustomizedDefault": false,
27
    "updatedUserId": "12345",
28
    "createdAt": 1600000000000,
29
    "createdUserId": "67890",
30
    "referencedObjectType": null,
31
    "externalOptionsReferenceType": null,
32
    "searchableInGlobalSearch": true,
33
    "hasUniqueValue": true,
34
    "options": [],
35
    "numberDisplayHint": null,
36
    "readOnlyDefinition": true
37
}

Get deal
Copy

Retrieve a deal by the given ID.

Sample Input

1
{
2
    "deal_id": 12345,
3
    "include_all_properties": true,
4
    "properties": [
5
        "amount",
6
        "dealname",
7
        "closedate"
8
    ],
9
    "properties_with_history": [
10
        "dealstage"
11
    ],
12
    "associations": [
13
        "company",
14
        "contact"
15
    ],
16
    "archived": false
17
}

Sample Output

1
{
2
    "id": "12345",
3
    "properties": {
4
        "amount": "10000",
5
        "createdate": "2023-05-15T14:30:00.000Z",
6
        "dealstage": "closedwon",
7
        "hs_lastmodifieddate": "2023-05-20T09:45:00.000Z",
8
        "hs_object_id": "12345"
9
    },
10
    "propertiesWithHistory": {
11
        "dealname": [
12
            {
13
                "value": "Big Sale Q2",
14
                "timestamp": "2023-05-15T14:30:00.000Z",
15
                "sourceType": "CRM_UI",
16
                "sourceId": "user@example.com"
17
            }
18
        ],
19
        "dealstage": [
20
            {
21
                "value": "qualifiedtobuy",
22
                "timestamp": "2023-05-15T14:30:00.000Z",
23
                "sourceType": "CRM_UI",
24
                "sourceId": "user@example.com"
25
            },
26
            {
27
                "value": "presentationscheduled",
28
                "timestamp": "2023-05-17T10:00:00.000Z",
29
                "sourceType": "CRM_UI",
30
                "sourceId": "user@example.com"
31
            },
32
            {
33
                "value": "closedwon",
34
                "timestamp": "2023-05-20T09:45:00.000Z",
35
                "sourceType": "CRM_UI",
36
                "sourceId": "user@example.com"
37
            }
38
        ]
39
    },
40
    "createdAt": "2023-05-15T14:30:00.000Z",
41
    "updatedAt": "2023-05-20T09:45:00.000Z",
42
    "archived": false
43
}

Get file import status
Copy

Retrieve the status of a file import.

Sample Input

1
{
2
    "task_id": "123e4567-e89b-12d3-a456-426614174000"
3
}

Sample Output

1
{
2
    "status": "COMPLETED",
3
    "result": {
4
        "id": "987654321",
5
        "createdAt": "2023-05-15T10:30:00Z",
6
        "updatedAt": "2023-05-15T10:35:00Z",
7
        "archived": false,
8
        "parentFolderId": "folder_123",
9
        "name": "product_catalog.pdf",
10
        "path": "/marketing/catalogs/product_catalog.pdf",
11
        "size": 2048000,
12
        "height": 842,
13
        "width": 595,
14
        "encoding": "utf-8",
15
        "type": "application/pdf",
16
        "extension": "pdf",
17
        "defaultHostingUrl": "https://cdn.hubspot.com/hubfs/123456/product_catalog.pdf",
18
        "url": "https://www.example.com/product_catalog.pdf",
19
        "isUsableInContent": true,
20
        "access": "PUBLIC_INDEXABLE"
21
    },
22
    "startedAt": "2023-05-15T10:29:55Z",
23
    "completedAt": "2023-05-15T10:35:00Z",
24
    "taskId": "123e4567-e89b-12d3-a456-426614174000"
25
}

Get line item
Copy

Return a line item by the given ID.

Sample Input

1
{
2
    "line_item_id": "123456",
3
    "include_all_properties": true,
4
    "properties": [
5
        "amount",
6
        "quantity",
7
        "hs_product_id"
8
    ],
9
    "properties_with_history": [
10
        "amount"
11
    ],
12
    "associations": [
13
        "deal",
14
        "product"
15
    ],
16
    "archived": false
17
}

Sample Output

1
{
2
    "id": "123456",
3
    "properties": {
4
        "amount": "500.00",
5
        "createdate": "2023-05-15T10:30:00Z",
6
        "hs_lastmodifieddate": "2023-05-16T14:45:00Z",
7
        "hs_object_id": "123456",
8
        "hs_product_id": "789012",
9
        "quantity": "2"
10
    },
11
    "createdAt": "2023-05-15T10:30:00Z",
12
    "updatedAt": "2023-05-16T14:45:00Z",
13
    "archived": false
14
}

Get marketing event
Copy

Retrieve details of the specified marketing event.

Sample Input

1
{
2
    "external_account_id": "123456",
3
    "external_event_id": "EVENT-2023-001"
4
}

Sample Output

1
{
2
    "eventName": "Annual Tech Conference 2023",
3
    "eventType": "Conference",
4
    "startDateTime": "2023-09-15T09:00:00Z",
5
    "endDateTime": "2023-09-17T18:00:00Z",
6
    "eventOrganizer": "TechCorp Inc.",
7
    "eventDescription": "Join us for our annual tech conference featuring industry leaders and innovative workshops.",
8
    "eventUrl": "https://techcorp.com/annual-conference-2023",
9
    "eventCancelled": false,
10
    "customProperties": [
11
        {
12
            "name": "Venue",
13
            "value": "San Francisco Convention Center",
14
            "sourceVid": [
15
                1234,
16
                5678
17
            ]
18
        },
19
        {
20
            "name": "Main Speaker",
21
            "value": "Jane Doe",
22
            "sourceVid": [
23
                9876
24
            ]
25
        }
26
    ],
27
    "externalEventId": "EVENT-2023-001",
28
    "registrants": 500,
29
    "attendees": 450,
30
    "cancellations": 30,
31
    "noShows": 20,
32
    "createdAt": "2023-03-01T10:30:00Z",
33
    "updatedAt": "2023-09-18T09:00:00Z",
34
    "id": "hubspot-event-id-12345"
35
}

Get owner
Copy

Read an owner by given ID or User ID.

Sample Input

1
{
2
    "owner_id": "12345"
3
}

Sample Output

1
{
2
    "id": "12345",
3
    "email": "johndoe@example.com",
4
    "firstName": "John",
5
    "lastName": "Doe",
6
    "userId": 67890,
7
    "createdAt": "2023-05-15T10:30:00Z",
8
    "updatedAt": "2023-05-20T14:45:00Z",
9
    "archived": false
10
}

Get product
Copy

Retrieve a product by the given ID.

Sample Input

1
{
2
    "product_id": "1234567",
3
    "properties": [
4
        "name",
5
        "description",
6
        "price"
7
    ],
8
    "properties_with_history": [
9
        "name"
10
    ],
11
    "associations": [
12
        "line_item"
13
    ],
14
    "archived": false
15
}

Sample Output

1
{
2
    "id": "1234567",
3
    "properties": {
4
        "createdate": "2023-05-15T10:30:00.000Z",
5
        "description": "High-quality wireless headphones with noise cancellation",
6
        "hs_lastmodifieddate": "2023-05-20T14:45:00.000Z",
7
        "hs_object_id": "1234567",
8
        "name": "Premium Wireless Headphones",
9
        "price": "199.99"
10
    },
11
    "propertiesWithHistory": {
12
        "name": [
13
            {
14
                "value": "Premium Wireless Headphones",
15
                "timestamp": "2023-05-20T14:45:00.000Z",
16
                "sourceType": "USER",
17
                "sourceId": "user@example.com"
18
            },
19
            {
20
                "value": "Wireless Headphones",
21
                "timestamp": "2023-05-15T10:30:00.000Z",
22
                "sourceType": "USER",
23
                "sourceId": "user@example.com"
24
            }
25
        ]
26
    },
27
    "createdAt": "2023-05-15T10:30:00.000Z",
28
    "updatedAt": "2023-05-20T14:45:00.000Z",
29
    "archived": false
30
}

Get subscription status
Copy

Retrieve the email subscription information for the given email address and portal.

Sample Input

1
{
2
    "email_address": "john.doe@example.com"
3
}

Sample Output

1
{
2
    "subscribed": true,
3
    "markedAsSpam": false,
4
    "unsubscribeFromPortal": false,
5
    "portalId": 123456,
6
    "bounced": false,
7
    "email": "john.doe@example.com",
8
    "subscriptionStatuses": [
9
        {
10
            "id": 1,
11
            "updatedAt": 1623456789000,
12
            "subscribed": true,
13
            "optState": "OPT_IN",
14
            "legalBasis": "CONSENT",
15
            "legalBasisExplanation": "User opted in through website form"
16
        },
17
        {
18
            "id": 2,
19
            "updatedAt": 1623456790000,
20
            "subscribed": true,
21
            "optState": "OPT_IN",
22
            "legalBasis": "CONSENT",
23
            "legalBasisExplanation": "User confirmed subscription via email"
24
        }
25
    ],
26
    "status": "ACTIVE"
27
}

Get subscriptions timeline
Copy

Retrieve a time-ordered list of subscription changes.

Sample Input

1
{
2
    "change_type": "SUBSCRIPTION_STATUS",
3
    "start_timestamp": "2023-01-01T00:00:00Z",
4
    "end_timestamp": "2023-06-30T23:59:59Z",
5
    "include_snapshots": true,
6
    "limit": 50,
7
    "offset": 0
8
}

Sample Output

1
{
2
    "hasMore": true,
3
    "offset": "50",
4
    "timeline": [
5
        {
6
            "timestamp": 1677123456789,
7
            "normalizedEmailId": "example@email.com",
8
            "recipient": "John Doe",
9
            "portalId": 123456,
10
            "changes": [
11
                {
12
                    "timestamp": 1677123456789,
13
                    "portalId": 123456,
14
                    "changeType": "SUBSCRIPTION_STATUS",
15
                    "causedByEvent": {
16
                        "id": "event-123-abc",
17
                        "created": 1677123456789
18
                    },
19
                    "change": "UNSUBSCRIBED",
20
                    "subscriptionId": 789012,
21
                    "source": "USER_PREFERENCE_CENTER"
22
                }
23
            ]
24
        },
25
        {
26
            "timestamp": 1677234567890,
27
            "normalizedEmailId": "another@email.com",
28
            "recipient": "Jane Smith",
29
            "portalId": 123456,
30
            "changes": [
31
                {
32
                    "timestamp": 1677234567890,
33
                    "portalId": 123456,
34
                    "changeType": "SUBSCRIPTION_STATUS",
35
                    "causedByEvent": {
36
                        "id": "event-456-def",
37
                        "created": 1677234567890
38
                    },
39
                    "change": "SUBSCRIBED",
40
                    "subscriptionId": 345678,
41
                    "source": "FORM_SUBMISSION"
42
                }
43
            ]
44
        }
45
    ]
46
}

Get ticket
Copy

Retrieve a ticket by the given ID.

Sample Input

1
{
2
    "ticket_id": "123456",
3
    "properties": [
4
        "subject",
5
        "content",
6
        "hs_ticket_priority"
7
    ],
8
    "properties_with_history": [
9
        "hs_pipeline",
10
        "hs_pipeline_stage"
11
    ],
12
    "associations": [
13
        "contact",
14
        "company"
15
    ],
16
    "archived": false
17
}

Sample Output

1
{
2
    "id": "123456",
3
    "properties": {
4
        "subject": "Website is down",
5
        "content": "Our company website is not loading. Please investigate and fix the issue.",
6
        "hs_ticket_priority": "HIGH",
7
        "createdate": "2023-05-15T10:30:00Z",
8
        "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
9
        "hs_object_id": "123456",
10
        "hs_pipeline": "support",
11
        "hs_pipeline_stage": "in_progress",
12
        "hs_ticket_category": "technical_issue"
13
    },
14
    "propertiesWithHistory": {
15
        "hs_pipeline": [
16
            {
17
                "value": "support",
18
                "timestamp": "2023-05-15T10:30:00Z",
19
                "sourceType": "CRM_UI",
20
                "sourceId": "user@example.com"
21
            }
22
        ],
23
        "hs_pipeline_stage": [
24
            {
25
                "value": "new",
26
                "timestamp": "2023-05-15T10:30:00Z",
27
                "sourceType": "CRM_UI",
28
                "sourceId": "user@example.com"
29
            },
30
            {
31
                "value": "in_progress",
32
                "timestamp": "2023-05-15T11:15:00Z",
33
                "sourceType": "CRM_UI",
34
                "sourceId": "support@example.com"
35
            }
36
        ]
37
    },
38
    "createdAt": "2023-05-15T10:30:00Z",
39
    "updatedAt": "2023-05-15T14:45:00Z",
40
    "archived": false
41
}

List association definitions
Copy

List all association types between two object types.

Sample Input

1
{
2
    "object_type": "Contacts",
3
    "to_object_type": "Deals"
4
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "category": "HUBSPOT_DEFINED",
5
            "typeId": 4,
6
            "label": "Contact to deal"
7
        },
8
        {
9
            "category": "USER_DEFINED",
10
            "typeId": 1001,
11
            "label": "Primary contact"
12
        },
13
        {
14
            "category": "USER_DEFINED",
15
            "typeId": 1002,
16
            "label": "Decision maker"
17
        }
18
    ]
19
}

List authors
Copy

Retrieve a list of blog authors.

Sample Input

1
{
2
    "limit": 2,
3
    "sort": "name",
4
    "created_after": "2023-01-01T00:00:00Z",
5
    "updated_before": "2023-06-30T23:59:59Z"
6
}

Sample Output

1
{
2
    "total": 2,
3
    "results": [
4
        {
5
            "avatar": "https://example.com/avatars/jane-doe.jpg",
6
            "bio": "Jane Doe is a seasoned content writer with over 10 years of experience in digital marketing.",
7
            "created": "2023-02-15T10:30:00Z",
8
            "deletedAt": null,
9
            "displayName": "Jane Doe",
10
            "email": "jane.doe@example.com",
11
            "facebook": "https://www.facebook.com/janedoe",
12
            "id": "1234567890",
13
            "linkedin": "https://www.linkedin.com/in/janedoe",
14
            "twitter": "https://twitter.com/janedoe",
15
            "updated": "2023-05-20T14:45:00Z",
16
            "website": "https://www.janedoe.com"
17
        },
18
        {
19
            "avatar": "https://example.com/avatars/john-smith.jpg",
20
            "bio": "John Smith is a tech enthusiast and software developer who loves writing about the latest trends in AI and machine learning.",
21
            "created": "2023-03-10T09:15:00Z",
22
            "deletedAt": null,
23
            "displayName": "John Smith",
24
            "email": "john.smith@example.com",
25
            "facebook": "https://www.facebook.com/johnsmith",
26
            "id": "0987654321",
27
            "linkedin": "https://www.linkedin.com/in/johnsmith",
28
            "twitter": "https://twitter.com/johnsmith",
29
            "updated": "2023-06-05T11:20:00Z",
30
            "website": "https://www.johnsmith.dev"
31
        }
32
    ]
33
}

List blog posts
Copy

Retrieve a list of blog posts.

Sample Input

1
{
2
    "limit": 2,
3
    "created_after": "2023-01-01T00:00:00Z",
4
    "updated_before": "2023-06-30T23:59:59Z",
5
    "sort": "updatedAt",
6
    "archived": false
7
}

Sample Output

1
{
2
    "total": 2,
3
    "results": [
4
        {
5
            "archived": false,
6
            "authorName": "John Doe",
7
            "blogAuthorId": "12345",
8
            "categoryId": 1,
9
            "contentGroupId": "67890",
10
            "contentTypeCategory": 2,
11
            "created": "2023-02-15T10:30:00Z",
12
            "createdById": "user123",
13
            "currentState": "PUBLISHED",
14
            "currentlyPublished": true,
15
            "deletedAt": null,
16
            "domain": "blog.example.com",
17
            "enableGoogleAmpOutputOverride": false,
18
            "featuredImage": "https://example.com/images/featured1.jpg",
19
            "featuredImageAltText": "A laptop on a desk",
20
            "htmlTitle": "10 Tips for Productive Remote Work",
21
            "id": "post1",
22
            "metaDescription": "Discover 10 essential tips for maximizing productivity while working remotely.",
23
            "name": "10 Tips for Productive Remote Work",
24
            "pageRedirected": false,
25
            "postBody": "<p>Working remotely has become increasingly common...</p>",
26
            "postSummary": "Learn how to stay productive while working from home with these 10 tips.",
27
            "publicAccessRulesEnabled": true,
28
            "publishDate": "2023-02-16T09:00:00Z",
29
            "publishImmediately": false,
30
            "rssBody": "Working remotely has become increasingly common...",
31
            "rssSummary": "Learn how to stay productive while working from home with these 10 tips.",
32
            "slug": "10-tips-productive-remote-work",
33
            "state": "PUBLISHED",
34
            "subcategory": "Productivity",
35
            "templatePath": "/blog-post-template",
36
            "updated": "2023-03-01T14:45:00Z",
37
            "updatedById": "user456",
38
            "url": "https://blog.example.com/10-tips-productive-remote-work",
39
            "useFeaturedImage": true
40
        },
41
        {
42
            "archived": false,
43
            "authorName": "Jane Smith",
44
            "blogAuthorId": "67890",
45
            "categoryId": 2,
46
            "contentGroupId": "54321",
47
            "contentTypeCategory": 1,
48
            "created": "2023-04-02T08:15:00Z",
49
            "createdById": "user789",
50
            "currentState": "PUBLISHED",
51
            "currentlyPublished": true,
52
            "deletedAt": null,
53
            "domain": "blog.example.com",
54
            "enableGoogleAmpOutputOverride": true,
55
            "featuredImage": "https://example.com/images/featured2.jpg",
56
            "featuredImageAltText": "A group of people in a meeting",
57
            "htmlTitle": "5 Strategies for Effective Team Communication",
58
            "id": "post2",
59
            "metaDescription": "Learn 5 powerful strategies to improve communication within your team and boost productivity.",
60
            "name": "5 Strategies for Effective Team Communication",
61
            "pageRedirected": false,
62
            "postBody": "<p>Effective communication is the cornerstone of any successful team...</p>",
63
            "postSummary": "Discover 5 strategies to enhance team communication and collaboration.",
64
            "publicAccessRulesEnabled": true,
65
            "publishDate": "2023-04-05T10:00:00Z",
66
            "publishImmediately": false,
67
            "rssBody": "Effective communication is the cornerstone of any successful team...",
68
            "rssSummary": "Discover 5 strategies to enhance team communication and collaboration.",
69
            "slug": "5-strategies-effective-team-communication",
70
            "state": "PUBLISHED",
71
            "subcategory": "Team Management",
72
            "templatePath": "/blog-post-template",
73
            "updated": "2023-05-20T11:30:00Z",
74
            "updatedById": "user101",
75
            "url": "https://blog.example.com/5-strategies-effective-team-communication",
76
            "useFeaturedImage": true
77
        }
78
    ]
79
}

List call engagement dispositions
Copy

Return all possible dispositions for sales calls.

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1",
5
            "label": "Interested",
6
            "deleted": false
7
        },
8
        {
9
            "id": "2",
10
            "label": "Not Interested",
11
            "deleted": false
12
        },
13
        {
14
            "id": "3",
15
            "label": "No Answer",
16
            "deleted": false
17
        },
18
        {
19
            "id": "4",
20
            "label": "Left Voicemail",
21
            "deleted": false
22
        },
23
        {
24
            "id": "5",
25
            "label": "Wrong Number",
26
            "deleted": false
27
        },
28
        {
29
            "id": "6",
30
            "label": "Call Back Later",
31
            "deleted": false
32
        },
33
        {
34
            "id": "7",
35
            "label": "Scheduled Meeting",
36
            "deleted": false
37
        },
38
        {
39
            "id": "8",
40
            "label": "Busy",
41
            "deleted": true
42
        }
43
    ]
44
}

List call engagements
Copy

Return a list of call engagements.

Sample Input

1
{
2
    "properties": [
3
        "hs_call_title",
4
        "hs_call_body",
5
        "hs_call_duration",
6
        "hs_call_status"
7
    ],
8
    "properties_with_history": [
9
        "hs_timestamp"
10
    ],
11
    "associations": [
12
        "contact",
13
        "deal"
14
    ],
15
    "after": "1234567890",
16
    "limit": 5
17
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "987654321",
5
            "properties": {
6
                "hs_activity_type": "CALL",
7
                "hs_call_title": "Follow-up call with John Doe",
8
                "hs_call_body": "Discussed product features and pricing options",
9
                "hs_call_duration": "15",
10
                "hs_call_status": "COMPLETED",
11
                "hs_timestamp": "2023-05-15T14:30:00Z",
12
                "hs_createdate": "2023-05-15T14:30:00Z",
13
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
14
                "hs_object_id": "987654321",
15
                "hubspot_owner_id": "12345"
16
            },
17
            "propertiesWithHistory": {
18
                "hs_timestamp": [
19
                    {
20
                        "value": "2023-05-15T14:30:00Z",
21
                        "timestamp": "2023-05-15T14:30:00Z",
22
                        "sourceType": "CRM_UI",
23
                        "sourceId": "user@example.com"
24
                    }
25
                ]
26
            },
27
            "createdAt": "2023-05-15T14:30:00Z",
28
            "updatedAt": "2023-05-15T14:45:00Z",
29
            "archived": false
30
        }
31
    ],
32
    "paging": {
33
        "next": {
34
            "after": "987654321",
35
            "link": "https://api.hubapi.com/engagements/v1/engagements/paged?after=987654321"
36
        }
37
    }
38
}

List changes for line items
Copy

Return a list of changes to line items.

Sample Input

1
{
2
    "line_item_id": 123456,
3
    "timestamp": "2023-05-01T12:00:00Z",
4
    "change_type": "UPDATED"
5
}

Sample Output

1
[
2
    {
3
        "timestamp": 1683028800000,
4
        "changeType": "UPDATED",
5
        "objectId": 123456,
6
        "changes": {
7
            "changedProperties": [
8
                "quantity",
9
                "price"
10
            ],
11
            "newAssociations": [
12
                "deal_123"
13
            ],
14
            "removedAssociations": [],
15
            "newListMemberships": [],
16
            "removedListMemberships": []
17
        }
18
    },
19
    {
20
        "timestamp": 1683029100000,
21
        "changeType": "UPDATED",
22
        "objectId": 123457,
23
        "changes": {
24
            "changedProperties": [
25
                "name",
26
                "description"
27
            ],
28
            "newAssociations": [],
29
            "removedAssociations": [
30
                "deal_456"
31
            ],
32
            "newListMemberships": [
33
                "list_789"
34
            ],
35
            "removedListMemberships": []
36
        }
37
    }
38
]

List changes for products
Copy

Return a list of changes to products.

Sample Input

1
{
2
    "timestamp": "2023-05-01T12:00:00Z",
3
    "object_id": "123456",
4
    "change_type": "UPDATED"
5
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "timestamp": 1683028800000,
5
            "changeType": "UPDATED",
6
            "objectId": 123456,
7
            "changes": {
8
                "changedProperties": [
9
                    "name",
10
                    "price",
11
                    "description"
12
                ],
13
                "newAssociations": [
14
                    "category_123"
15
                ],
16
                "removedAssociations": [
17
                    "category_456"
18
                ],
19
                "newListMemberships": [
20
                    "featured_products"
21
                ],
22
                "removedListMemberships": [
23
                    "clearance_items"
24
                ]
25
            }
26
        },
27
        {
28
            "timestamp": 1683029100000,
29
            "changeType": "CREATED",
30
            "objectId": 789012,
31
            "changes": {
32
                "changedProperties": [
33
                    "name",
34
                    "price",
35
                    "description",
36
                    "sku"
37
                ],
38
                "newAssociations": [
39
                    "category_789"
40
                ],
41
                "removedAssociations": [],
42
                "newListMemberships": [
43
                    "new_arrivals"
44
                ],
45
                "removedListMemberships": []
46
            }
47
        }
48
    ]
49
}

List comments
Copy

Retrieve the comments from your HubSpot blogs.

Sample Input

1
{
2
    "portal_id": "123456",
3
    "content_id": 7890123,
4
    "state": "APPROVED",
5
    "query": "great article",
6
    "reverse": false,
7
    "limit": 50,
8
    "offset": 0
9
}

Sample Output

1
{
2
    "objects": [
3
        {
4
            "id": 9876543,
5
            "portalId": 123456,
6
            "contentId": 7890123,
7
            "contentTitle": "10 Tips for Effective Marketing",
8
            "contentPermalink": "https://www.example.com/blog/10-tips-for-effective-marketing",
9
            "collectionId": 456789,
10
            "createdAt": 1623456789000,
11
            "deletedAt": null,
12
            "userName": "John Doe",
13
            "firstName": "John",
14
            "lastName": "Doe",
15
            "userEmail": "john.doe@example.com",
16
            "comment": "Great article! I especially liked the tip about social media marketing.",
17
            "userUrl": "https://www.johndoe.com",
18
            "state": "APPROVED",
19
            "userIp": "192.168.1.1",
20
            "userReferrer": "https://www.google.com",
21
            "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
22
            "contentAuthorEmail": "author@example.com",
23
            "contentAuthorName": "Jane Smith",
24
            "contentCreatedAt": 1623400000000,
25
            "threadId": "thread_123",
26
            "replyingTo": null,
27
            "parentId": null,
28
            "legacyId": 1234567,
29
            "extraContext": null,
30
            "parent": null
31
        }
32
    ],
33
    "total": 1,
34
    "limit": 50,
35
    "offset": 0
36
}

List companies
Copy

Return a list of companies in your Hubspot account.

Sample Input

1
{
2
    "include_all_properties": true,
3
    "properties": [
4
        "name",
5
        "domain",
6
        "hs_lastmodifieddate"
7
    ],
8
    "properties_with_history": [
9
        "name"
10
    ],
11
    "associations": [
12
        "contacts"
13
    ],
14
    "archived": false,
15
    "after": "1000",
16
    "limit": 5
17
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1234567",
5
            "properties": {
6
                "createdate": "2023-05-01T10:30:00Z",
7
                "domain": "example.com",
8
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
9
                "hs_object_id": "1234567",
10
                "name": "Example Company"
11
            },
12
            "createdAt": "2023-05-01T10:30:00Z",
13
            "updatedAt": "2023-05-15T14:45:00Z",
14
            "archived": false
15
        },
16
        {
17
            "id": "2345678",
18
            "properties": {
19
                "createdate": "2023-05-02T09:15:00Z",
20
                "domain": "anotherexample.com",
21
                "hs_lastmodifieddate": "2023-05-16T11:20:00Z",
22
                "hs_object_id": "2345678",
23
                "name": "Another Example Inc."
24
            },
25
            "createdAt": "2023-05-02T09:15:00Z",
26
            "updatedAt": "2023-05-16T11:20:00Z",
27
            "archived": false
28
        }
29
    ],
30
    "paging": {
31
        "next": {
32
            "after": "2345678",
33
            "link": "https://api.hubapi.com/crm/v3/objects/companies?after=2345678&limit=5"
34
        }
35
    }
36
}

List company properties
Copy

Return company properties.

Sample Input

1
{
2
    "archived": false
3
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "updatedAt": "2023-05-15T14:30:00.000Z",
5
            "createdAt": "2023-01-01T09:00:00.000Z",
6
            "name": "industry",
7
            "label": "Industry",
8
            "type": "string",
9
            "fieldType": "select",
10
            "description": "The industry the company operates in",
11
            "groupName": "companyinformation",
12
            "options": [
13
                {
14
                    "label": "Technology",
15
                    "value": "technology",
16
                    "displayOrder": 1,
17
                    "hidden": false
18
                },
19
                {
20
                    "label": "Healthcare",
21
                    "value": "healthcare",
22
                    "displayOrder": 2,
23
                    "hidden": false
24
                }
25
            ],
26
            "displayOrder": 3,
27
            "calculated": false,
28
            "externalOptions": false,
29
            "hasUniqueValue": false,
30
            "hidden": false,
31
            "hubspotDefined": true,
32
            "modificationMetadata": {
33
                "archivable": true,
34
                "readOnlyDefinition": false,
35
                "readOnlyValue": false
36
            },
37
            "formField": true
38
        },
39
        {
40
            "updatedAt": "2023-05-10T11:15:00.000Z",
41
            "createdAt": "2023-02-15T13:45:00.000Z",
42
            "name": "annual_revenue",
43
            "label": "Annual Revenue",
44
            "type": "number",
45
            "fieldType": "number",
46
            "description": "The company's annual revenue",
47
            "groupName": "companyfinancials",
48
            "options": [],
49
            "displayOrder": 5,
50
            "calculated": false,
51
            "externalOptions": false,
52
            "hasUniqueValue": false,
53
            "hidden": false,
54
            "hubspotDefined": false,
55
            "modificationMetadata": {
56
                "archivable": true,
57
                "readOnlyDefinition": false,
58
                "readOnlyValue": false
59
            },
60
            "formField": true
61
        }
62
    ]
63
}

List contact list contacts
Copy

Retrieve a list of contacts on a particular list.

Sample Input

1
{
2
    "contact_list_id": "1234",
3
    "property": [
4
        "firstname",
5
        "lastname",
6
        "email",
7
        "company"
8
    ],
9
    "property_mode": "value_only",
10
    "form_submission_mode": "newest",
11
    "show_list_memberships": true,
12
    "count": 50,
13
    "offset": 0
14
}

Sample Output

1
{
2
    "contacts": [
3
        {
4
            "addedAt": 1623456789000,
5
            "vid": 5678,
6
            "canonical-vid": 5678,
7
            "merged-vids": [],
8
            "portal-id": 9012,
9
            "is-contact": true,
10
            "properties": {
11
                "firstname": {
12
                    "value": "John"
13
                },
14
                "lastname": {
15
                    "value": "Doe"
16
                },
17
                "email": {
18
                    "value": "johndoe@example.com"
19
                },
20
                "company": {
21
                    "value": "Acme Inc."
22
                },
23
                "lastmodifieddate": {
24
                    "value": "2023-06-15T10:30:00Z"
25
                }
26
            },
27
            "form-submissions": [
28
                {
29
                    "conversion-id": "abc123",
30
                    "timestamp": 1623456789000,
31
                    "form-id": "form1",
32
                    "portal-id": 9012,
33
                    "page-url": "https://www.example.com/contact",
34
                    "title": "Contact Us Form",
35
                    "meta-data": []
36
                }
37
            ],
38
            "identity-profiles": [
39
                {
40
                    "vid": 5678,
41
                    "saved-at-timestamp": 1623456789000,
42
                    "deleted-changed-timestamp": 0,
43
                    "identities": [
44
                        {
45
                            "type": "EMAIL",
46
                            "value": "johndoe@example.com",
47
                            "timestamp": 1623456789000,
48
                            "is-primary": true
49
                        }
50
                    ]
51
                }
52
            ],
53
            "merge-audits": []
54
        }
55
    ],
56
    "has-more": true,
57
    "vid-offset": 5678
58
}

List contact lists
Copy

Retrieve contact lists for the account.

Sample Input

1
{
2
    "count": 50,
3
    "offset": 0
4
}

Sample Output

1
{
2
    "offset": 50,
3
    "lists": [
4
        {
5
            "portalId": 123456,
6
            "listId": 789,
7
            "internalListId": 1011,
8
            "createdAt": 1623456789000,
9
            "updatedAt": 1623567890000,
10
            "name": "Newsletter Subscribers",
11
            "listType": "STATIC",
12
            "authorId": 12345,
13
            "filters": [
14
                [
15
                    {
16
                        "propertyName": "email",
17
                        "operator": "HAS_PROPERTY"
18
                    },
19
                    {
20
                        "propertyName": "lifecycle_stage",
21
                        "operator": "EQ",
22
                        "value": "subscriber"
23
                    }
24
                ]
25
            ],
26
            "metaData": {
27
                "size": 1500,
28
                "lastSizeChangeAt": 1623567890000,
29
                "processing": "DONE",
30
                "lastProcessingStateChangeAt": 1623567890000,
31
                "error": "",
32
                "listReferencesCount": 2,
33
                "parentFolderId": 101
34
            },
35
            "archived": false,
36
            "teamIds": [
37
                1,
38
                2,
39
                3
40
            ],
41
            "dynamic": false
42
        }
43
    ],
44
    "has-more": true
45
}

List contact properties
Copy

Return contact properties.

Sample Input

1
{
2
    "archived": false
3
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "updatedAt": "2023-06-15T14:30:00.000Z",
5
            "createdAt": "2023-01-01T09:00:00.000Z",
6
            "name": "email",
7
            "label": "Email",
8
            "type": "string",
9
            "fieldType": "text",
10
            "description": "Contact's email address",
11
            "groupName": "contactinformation",
12
            "options": [],
13
            "displayOrder": 1,
14
            "calculated": false,
15
            "externalOptions": false,
16
            "hasUniqueValue": true,
17
            "hidden": false,
18
            "hubspotDefined": true,
19
            "modificationMetadata": {
20
                "archivable": false,
21
                "readOnlyDefinition": true,
22
                "readOnlyValue": false
23
            },
24
            "formField": true
25
        },
26
        {
27
            "updatedAt": "2023-06-10T11:15:00.000Z",
28
            "createdAt": "2023-01-01T09:00:00.000Z",
29
            "name": "firstname",
30
            "label": "First Name",
31
            "type": "string",
32
            "fieldType": "text",
33
            "description": "Contact's first name",
34
            "groupName": "contactinformation",
35
            "options": [],
36
            "displayOrder": 2,
37
            "calculated": false,
38
            "externalOptions": false,
39
            "hasUniqueValue": false,
40
            "hidden": false,
41
            "hubspotDefined": true,
42
            "modificationMetadata": {
43
                "archivable": false,
44
                "readOnlyDefinition": true,
45
                "readOnlyValue": false
46
            },
47
            "formField": true
48
        },
49
        {
50
            "updatedAt": "2023-06-20T16:45:00.000Z",
51
            "createdAt": "2023-03-15T13:30:00.000Z",
52
            "name": "lead_source",
53
            "label": "Lead Source",
54
            "type": "enumeration",
55
            "fieldType": "select",
56
            "description": "Source of the lead",
57
            "groupName": "marketing",
58
            "options": [
59
                {
60
                    "label": "Website",
61
                    "value": "website",
62
                    "description": "Lead came from the website",
63
                    "displayOrder": 1,
64
                    "hidden": false
65
                },
66
                {
67
                    "label": "Referral",
68
                    "value": "referral",
69
                    "description": "Lead came from a referral",
70
                    "displayOrder": 2,
71
                    "hidden": false
72
                },
73
                {
74
                    "label": "Social Media",
75
                    "value": "social_media",
76
                    "description": "Lead came from social media",
77
                    "displayOrder": 3,
78
                    "hidden": false
79
                }
80
            ],
81
            "displayOrder": 5,
82
            "calculated": false,
83
            "externalOptions": false,
84
            "hasUniqueValue": false,
85
            "hidden": false,
86
            "hubspotDefined": false,
87
            "modificationMetadata": {
88
                "archivable": true,
89
                "readOnlyDefinition": false,
90
                "readOnlyValue": false
91
            },
92
            "formField": true
93
        }
94
    ]
95
}

List contacts
Copy

Retrieve all the contacts that have been created in the account.

Sample Input

1
{
2
    "include_all_properties": true,
3
    "properties": [
4
        "email",
5
        "firstname",
6
        "lastname"
7
    ],
8
    "properties_with_history": [
9
        "email"
10
    ],
11
    "associations": [
12
        "company"
13
    ],
14
    "archived": false,
15
    "after": "1000",
16
    "limit": 50
17
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1",
5
            "properties": {
6
                "createdate": "2023-05-01T10:00:00Z",
7
                "email": "john.doe@example.com",
8
                "firstname": "John",
9
                "hs_object_id": "1",
10
                "lastmodifieddate": "2023-05-15T14:30:00Z",
11
                "lastname": "Doe"
12
            },
13
            "createdAt": "2023-05-01T10:00:00Z",
14
            "updatedAt": "2023-05-15T14:30:00Z",
15
            "archived": false
16
        },
17
        {
18
            "id": "2",
19
            "properties": {
20
                "createdate": "2023-05-02T09:15:00Z",
21
                "email": "jane.smith@example.com",
22
                "firstname": "Jane",
23
                "hs_object_id": "2",
24
                "lastmodifieddate": "2023-05-16T11:45:00Z",
25
                "lastname": "Smith"
26
            },
27
            "createdAt": "2023-05-02T09:15:00Z",
28
            "updatedAt": "2023-05-16T11:45:00Z",
29
            "archived": false
30
        }
31
    ],
32
    "paging": {
33
        "next": {
34
            "after": "2",
35
            "link": "https://api.hubapi.com/crm/v3/objects/contacts?limit=50&after=2"
36
        }
37
    }
38
}

List CRM object associations
Copy

List all associations of a CRM object by object type.

Sample Input

1
{
2
    "object_type": "Contacts",
3
    "object_id": "51",
4
    "to_object_type": "Deals",
5
    "limit": 10
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "toObjectId": 1001,
5
            "associationTypes": [
6
                {
7
                    "category": "HUBSPOT_DEFINED",
8
                    "typeId": 4,
9
                    "label": "contact_to_deal"
10
                }
11
            ]
12
        },
13
        {
14
            "toObjectId": 1002,
15
            "associationTypes": [
16
                {
17
                    "category": "HUBSPOT_DEFINED",
18
                    "typeId": 4,
19
                    "label": "contact_to_deal"
20
                }
21
            ]
22
        }
23
    ],
24
    "paging": {
25
        "next": {
26
            "after": "1002",
27
            "link": "https://api.hubapi.com/crm/v3/objects/contacts/51/associations/deals?limit=10&after=1002"
28
        }
29
    }
30
}

List custom objects
Copy

Retrieve a list of custom objects of a specified type.

Sample Input

1
{
2
    "custom_object_type": "2-12345678",
3
    "custom_object_properties": [
4
        "name",
5
        "description",
6
        "category"
7
    ],
8
    "associated_objects": [
9
        "website_activity_to_contact"
10
    ],
11
    "limit": 2,
12
    "after": "1234567890abcdef"
13
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "labels": {
5
                "singular": "Product",
6
                "plural": "Products"
7
            },
8
            "requiredProperties": [
9
                "name"
10
            ],
11
            "searchableProperties": [
12
                "name",
13
                "description"
14
            ],
15
            "primaryDisplayProperty": "name",
16
            "secondaryDisplayProperties": [
17
                "category"
18
            ],
19
            "archived": false,
20
            "restorable": true,
21
            "metaType": "CUSTOM_OBJECT",
22
            "id": "2-12345678",
23
            "fullyQualifiedName": "p12345.Product",
24
            "createdAt": "2023-05-15T10:30:00Z",
25
            "updatedAt": "2023-05-15T10:30:00Z",
26
            "objectTypeId": "2-12345678",
27
            "properties": [
28
                {
29
                    "name": "name",
30
                    "label": "Name",
31
                    "type": "string",
32
                    "fieldType": "text",
33
                    "description": "The name of the product",
34
                    "groupName": "productinformation",
35
                    "displayOrder": 1,
36
                    "calculated": false,
37
                    "externalOptions": false,
38
                    "hasUniqueValue": true,
39
                    "hidden": false,
40
                    "hubspotDefined": false,
41
                    "modificationMetadata": {
42
                        "archivable": true,
43
                        "readOnlyDefinition": false,
44
                        "readOnlyValue": false
45
                    },
46
                    "formField": true
47
                },
48
                {
49
                    "name": "description",
50
                    "label": "Description",
51
                    "type": "string",
52
                    "fieldType": "textarea",
53
                    "description": "A detailed description of the product",
54
                    "groupName": "productinformation",
55
                    "displayOrder": 2,
56
                    "calculated": false,
57
                    "externalOptions": false,
58
                    "hasUniqueValue": false,
59
                    "hidden": false,
60
                    "hubspotDefined": false,
61
                    "modificationMetadata": {
62
                        "archivable": true,
63
                        "readOnlyDefinition": false,
64
                        "readOnlyValue": false
65
                    },
66
                    "formField": true
67
                },
68
                {
69
                    "name": "category",
70
                    "label": "Category",
71
                    "type": "enumeration",
72
                    "fieldType": "select",
73
                    "description": "The category of the product",
74
                    "groupName": "productinformation",
75
                    "options": [
76
                        "Electronics",
77
                        "Clothing",
78
                        "Home & Garden",
79
                        "Books"
80
                    ],
81
                    "displayOrder": 3,
82
                    "calculated": false,
83
                    "externalOptions": false,
84
                    "hasUniqueValue": false,
85
                    "hidden": false,
86
                    "hubspotDefined": false,
87
                    "modificationMetadata": {
88
                        "archivable": true,
89
                        "readOnlyDefinition": false,
90
                        "readOnlyValue": false
91
                    },
92
                    "formField": true
93
                }
94
            ],
95
            "associations": [
96
                {
97
                    "fromObjectTypeId": "2-12345678",
98
                    "toObjectTypeId": "0-1",
99
                    "name": "website_activity_to_contact",
100
                    "cardinality": "MANY_TO_MANY",
101
                    "inverseCardinality": "MANY_TO_MANY",
102
                    "id": "3-12345678",
103
                    "createdAt": "2023-05-15T10:30:00Z",
104
                    "updatedAt": "2023-05-15T10:30:00Z"
105
                }
106
            ],
107
            "name": "Product"
108
        }
109
    ]
110
}

List email engagements
Copy

Return a list of email engagements.

Sample Input

1
{
2
    "properties": [
3
        "hs_email_subject",
4
        "hs_email_status",
5
        "hs_email_direction"
6
    ],
7
    "properties_with_history": [
8
        "hs_email_status"
9
    ],
10
    "associations": [
11
        "contact"
12
    ],
13
    "after": "1234567890",
14
    "limit": 5
15
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "987654321",
5
            "properties": {
6
                "hs_email_subject": "Follow-up on our recent conversation",
7
                "hs_email_status": "SENT",
8
                "hs_email_direction": "OUTBOUND"
9
            },
10
            "propertiesWithHistory": {
11
                "hs_email_status": [
12
                    {
13
                        "value": "SENT",
14
                        "timestamp": "2023-05-15T14:30:00Z",
15
                        "sourceType": "EMAIL",
16
                        "sourceId": "email_987654321"
17
                    },
18
                    {
19
                        "value": "DELIVERED",
20
                        "timestamp": "2023-05-15T14:30:05Z",
21
                        "sourceType": "EMAIL",
22
                        "sourceId": "email_987654321"
23
                    }
24
                ]
25
            },
26
            "createdAt": "2023-05-15T14:30:00Z",
27
            "updatedAt": "2023-05-15T14:30:05Z",
28
            "archived": false
29
        },
30
        {
31
            "id": "987654322",
32
            "properties": {
33
                "hs_email_subject": "Product demo invitation",
34
                "hs_email_status": "OPENED",
35
                "hs_email_direction": "OUTBOUND"
36
            },
37
            "propertiesWithHistory": {
38
                "hs_email_status": [
39
                    {
40
                        "value": "SENT",
41
                        "timestamp": "2023-05-14T10:15:00Z",
42
                        "sourceType": "EMAIL",
43
                        "sourceId": "email_987654322"
44
                    },
45
                    {
46
                        "value": "DELIVERED",
47
                        "timestamp": "2023-05-14T10:15:10Z",
48
                        "sourceType": "EMAIL",
49
                        "sourceId": "email_987654322"
50
                    },
51
                    {
52
                        "value": "OPENED",
53
                        "timestamp": "2023-05-14T11:30:00Z",
54
                        "sourceType": "EMAIL",
55
                        "sourceId": "email_987654322"
56
                    }
57
                ]
58
            },
59
            "createdAt": "2023-05-14T10:15:00Z",
60
            "updatedAt": "2023-05-14T11:30:00Z",
61
            "archived": false
62
        }
63
    ],
64
    "paging": {
65
        "next": {
66
            "after": "987654322",
67
            "link": "https://api.hubapi.com/engagements/v1/engagements/emails?limit=5&after=987654322"
68
        }
69
    }
70
}

List meeting engagements
Copy

Return a list of meeting engagements.

Sample Input

1
{
2
    "properties": [
3
        "hs_meeting_title",
4
        "hs_meeting_start_time",
5
        "hs_meeting_end_time"
6
    ],
7
    "properties_with_history": [
8
        "hs_timestamp"
9
    ],
10
    "associations": [
11
        "contact",
12
        "deal"
13
    ],
14
    "after": "1234567890",
15
    "limit": 5
16
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "12345",
5
            "properties": {
6
                "hs_meeting_title": "Project Kickoff Meeting",
7
                "hs_meeting_start_time": "2023-06-15T14:00:00Z",
8
                "hs_meeting_end_time": "2023-06-15T15:00:00Z",
9
                "hs_timestamp": "1623766800000"
10
            },
11
            "propertiesWithHistory": {
12
                "hs_timestamp": [
13
                    {
14
                        "value": "1623766800000",
15
                        "timestamp": "1623766800000",
16
                        "sourceType": "AUTOMATION",
17
                        "sourceId": "scheduler"
18
                    }
19
                ]
20
            },
21
            "createdAt": "2023-06-14T10:30:00Z",
22
            "updatedAt": "2023-06-14T10:30:00Z",
23
            "archived": false
24
        },
25
        {
26
            "id": "12346",
27
            "properties": {
28
                "hs_meeting_title": "Sales Demo",
29
                "hs_meeting_start_time": "2023-06-16T10:00:00Z",
30
                "hs_meeting_end_time": "2023-06-16T11:00:00Z",
31
                "hs_timestamp": "1623830400000"
32
            },
33
            "propertiesWithHistory": {
34
                "hs_timestamp": [
35
                    {
36
                        "value": "1623830400000",
37
                        "timestamp": "1623830400000",
38
                        "sourceType": "AUTOMATION",
39
                        "sourceId": "scheduler"
40
                    }
41
                ]
42
            },
43
            "createdAt": "2023-06-15T09:00:00Z",
44
            "updatedAt": "2023-06-15T09:00:00Z",
45
            "archived": false
46
        }
47
    ],
48
    "paging": {
49
        "next": {
50
            "after": "12346",
51
            "link": "https://api.hubapi.com/crm/v3/objects/meetings?after=12346&limit=5"
52
        }
53
    }
54
}

List note engagements
Copy

Return a list of note engagements.

Sample Input

1
{
2
    "properties": [
3
        "hs_attachment_ids",
4
        "hs_createdate",
5
        "hs_lastmodifieddate",
6
        "hubspot_owner_id"
7
    ],
8
    "properties_with_history": [
9
        "hs_timestamp"
10
    ],
11
    "associations": [
12
        "contact",
13
        "deal"
14
    ],
15
    "after": "1234567890",
16
    "limit": 5
17
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "987654321",
5
            "properties": {
6
                "hs_attachment_ids": "1234,5678",
7
                "hs_createdate": "2023-05-15T10:30:00Z",
8
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
9
                "hs_object_id": "987654321",
10
                "hs_timestamp": "2023-05-15T10:30:00Z",
11
                "hubspot_owner_id": "9876"
12
            },
13
            "propertiesWithHistory": {
14
                "hs_timestamp": [
15
                    {
16
                        "value": "2023-05-15T10:30:00Z",
17
                        "timestamp": "2023-05-15T10:30:00Z",
18
                        "sourceType": "CRM_UI",
19
                        "sourceId": "user@example.com"
20
                    },
21
                    {
22
                        "value": "2023-05-15T14:45:00Z",
23
                        "timestamp": "2023-05-15T14:45:00Z",
24
                        "sourceType": "CRM_UI",
25
                        "sourceId": "user@example.com"
26
                    }
27
                ]
28
            },
29
            "createdAt": "2023-05-15T10:30:00Z",
30
            "updatedAt": "2023-05-15T14:45:00Z",
31
            "archived": false
32
        }
33
    ],
34
    "paging": {
35
        "next": {
36
            "after": "987654321",
37
            "link": "https://api.hubapi.com/engagements/v1/engagements/paged?after=987654321"
38
        }
39
    }
40
}

List owners
Copy

Return all of the owners that exist inside of HubSpot.

Sample Input

1
{
2
    "email": "john.doe@example.com",
3
    "archived": false,
4
    "after": "1234567890",
5
    "limit": 50
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1",
5
            "email": "john.doe@example.com",
6
            "firstName": "John",
7
            "lastName": "Doe",
8
            "userId": 12345,
9
            "createdAt": "2023-05-01T10:00:00Z",
10
            "updatedAt": "2023-05-15T14:30:00Z",
11
            "archived": false
12
        },
13
        {
14
            "id": "2",
15
            "email": "jane.smith@example.com",
16
            "firstName": "Jane",
17
            "lastName": "Smith",
18
            "userId": 67890,
19
            "createdAt": "2023-04-15T09:00:00Z",
20
            "updatedAt": "2023-05-10T11:45:00Z",
21
            "archived": false
22
        }
23
    ],
24
    "paging": {
25
        "next": {
26
            "after": "2345678901",
27
            "link": "https://api.hubspot.com/crm/v3/owners?after=2345678901&limit=50"
28
        }
29
    }
30
}

List products
Copy

Return a list of products in your Hubspot account.

Sample Input

1
{
2
    "properties": [
3
        "name",
4
        "description",
5
        "price"
6
    ],
7
    "properties_with_history": [
8
        "price"
9
    ],
10
    "associations": [
11
        "line_item"
12
    ],
13
    "archived": false,
14
    "after": "1000",
15
    "limit": 2
16
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1234567",
5
            "properties": {
6
                "createdate": "2023-05-15T10:30:00Z",
7
                "description": "High-quality wireless headphones",
8
                "hs_lastmodifieddate": "2023-05-20T14:45:00Z",
9
                "hs_object_id": "1234567",
10
                "name": "Premium Wireless Headphones",
11
                "price": "199.99"
12
            },
13
            "propertiesWithHistory": {
14
                "price": [
15
                    {
16
                        "value": "199.99",
17
                        "timestamp": "2023-05-20T14:45:00Z"
18
                    },
19
                    {
20
                        "value": "179.99",
21
                        "timestamp": "2023-05-15T10:30:00Z"
22
                    }
23
                ]
24
            },
25
            "createdAt": "2023-05-15T10:30:00Z",
26
            "updatedAt": "2023-05-20T14:45:00Z",
27
            "archived": false
28
        },
29
        {
30
            "id": "1234568",
31
            "properties": {
32
                "createdate": "2023-05-16T09:15:00Z",
33
                "description": "Ergonomic office chair with lumbar support",
34
                "hs_lastmodifieddate": "2023-05-16T09:15:00Z",
35
                "hs_object_id": "1234568",
36
                "name": "Ergonomic Office Chair",
37
                "price": "299.99"
38
            },
39
            "propertiesWithHistory": {
40
                "price": [
41
                    {
42
                        "value": "299.99",
43
                        "timestamp": "2023-05-16T09:15:00Z"
44
                    }
45
                ]
46
            },
47
            "createdAt": "2023-05-16T09:15:00Z",
48
            "updatedAt": "2023-05-16T09:15:00Z",
49
            "archived": false
50
        }
51
    ],
52
    "paging": {
53
        "next": {
54
            "after": "1234568",
55
            "link": "https://api.hubapi.com/crm/v3/objects/products?limit=2&after=1234568"
56
        }
57
    }
58
}

List properties
Copy

List all properties for a given object type.

Sample Input

1
{
2
    "object_type": "contacts"
3
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "name": "firstname",
5
            "label": "First Name",
6
            "description": "A contact's first name",
7
            "groupName": "contactinformation",
8
            "type": "string",
9
            "fieldType": "text",
10
            "createdUserId": "215482",
11
            "searchableInGlobalSearch": true,
12
            "hasUniqueValue": false,
13
            "isCustomizedDefault": false,
14
            "updatedUserId": "215482",
15
            "hidden": false,
16
            "options": [],
17
            "createdAt": 1612345678901,
18
            "deleted": false,
19
            "formField": true,
20
            "displayOrder": 1,
21
            "readOnlyValue": false,
22
            "readOnlyDefinition": true,
23
            "mutableDefinitionNotDeletable": true,
24
            "favorited": true,
25
            "favoritedOrder": 1,
26
            "calculated": false,
27
            "externalOptions": false,
28
            "displayMode": "inline",
29
            "showCurrencySymbol": false,
30
            "hubspotDefined": true,
31
            "updatedAt": 1623456789012
32
        },
33
        {
34
            "name": "email",
35
            "label": "Email",
36
            "description": "A contact's email address",
37
            "groupName": "contactinformation",
38
            "type": "string",
39
            "fieldType": "email",
40
            "createdUserId": "215482",
41
            "searchableInGlobalSearch": true,
42
            "hasUniqueValue": true,
43
            "isCustomizedDefault": false,
44
            "updatedUserId": "215482",
45
            "hidden": false,
46
            "options": [],
47
            "createdAt": 1612345678902,
48
            "deleted": false,
49
            "formField": true,
50
            "displayOrder": 2,
51
            "readOnlyValue": false,
52
            "readOnlyDefinition": true,
53
            "mutableDefinitionNotDeletable": true,
54
            "favorited": true,
55
            "favoritedOrder": 2,
56
            "calculated": false,
57
            "externalOptions": false,
58
            "displayMode": "inline",
59
            "showCurrencySymbol": false,
60
            "hubspotDefined": true,
61
            "updatedAt": 1623456789013
62
        }
63
    ]
64
}

List property groups
Copy

List all property groups for a given object type.

Sample Input

1
{
2
    "object_type": "contacts",
3
    "include_properties": true
4
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "name": "contactinformation",
5
            "fulcrumPortalId": 123456,
6
            "displayName": "Contact Information",
7
            "displayOrder": 0,
8
            "hubspotDefined": true
9
        },
10
        {
11
            "name": "socialmedia",
12
            "fulcrumPortalId": 123456,
13
            "displayName": "Social Media Information",
14
            "displayOrder": 1,
15
            "hubspotDefined": false
16
        },
17
        {
18
            "name": "analytics",
19
            "fulcrumPortalId": 123456,
20
            "displayName": "Analytics",
21
            "displayOrder": 2,
22
            "hubspotDefined": true
23
        }
24
    ]
25
}

List recently modified deals
Copy

Retrieve a list of deals in Hubspot, sorted by last modified date.

Sample Input

1
{
2
    "properties": [
3
        "amount",
4
        "dealname",
5
        "dealstage",
6
        "pipeline"
7
    ],
8
    "after": "1234567890",
9
    "limit": 5
10
}

Sample Output

1
{
2
    "total": 100,
3
    "results": [
4
        {
5
            "id": "1001",
6
            "properties": {
7
                "amount": "10000",
8
                "dealname": "Enterprise Software Package",
9
                "dealstage": "qualifiedtobuy",
10
                "pipeline": "default"
11
            },
12
            "createdAt": "2023-05-01T10:30:00.000Z",
13
            "updatedAt": "2023-05-15T14:45:00.000Z",
14
            "archived": false
15
        },
16
        {
17
            "id": "1002",
18
            "properties": {
19
                "amount": "5000",
20
                "dealname": "Small Business Consultation",
21
                "dealstage": "presentationscheduled",
22
                "pipeline": "default"
23
            },
24
            "createdAt": "2023-05-02T09:15:00.000Z",
25
            "updatedAt": "2023-05-14T11:20:00.000Z",
26
            "archived": false
27
        },
28
        {
29
            "id": "1003",
30
            "properties": {
31
                "amount": "25000",
32
                "dealname": "Custom Integration Project",
33
                "dealstage": "contractsent",
34
                "pipeline": "enterprise"
35
            },
36
            "createdAt": "2023-05-03T13:45:00.000Z",
37
            "updatedAt": "2023-05-13T16:30:00.000Z",
38
            "archived": false
39
        },
40
        {
41
            "id": "1004",
42
            "properties": {
43
                "amount": "7500",
44
                "dealname": "Annual Support Contract",
45
                "dealstage": "closedwon",
46
                "pipeline": "default"
47
            },
48
            "createdAt": "2023-05-04T11:00:00.000Z",
49
            "updatedAt": "2023-05-12T09:45:00.000Z",
50
            "archived": false
51
        },
52
        {
53
            "id": "1005",
54
            "properties": {
55
                "amount": "15000",
56
                "dealname": "Product Upgrade Package",
57
                "dealstage": "decisionmakerboughtin",
58
                "pipeline": "upsell"
59
            },
60
            "createdAt": "2023-05-05T15:20:00.000Z",
61
            "updatedAt": "2023-05-11T13:10:00.000Z",
62
            "archived": false
63
        }
64
    ],
65
    "paging": {
66
        "next": {
67
            "after": "1005"
68
        }
69
    }
70
}

List tickets
Copy

Retrieve a list of all tickets.

Sample Input

1
{
2
    "properties": [
3
        "subject",
4
        "content",
5
        "hs_ticket_priority"
6
    ],
7
    "properties_with_history": [
8
        "hs_ticket_category"
9
    ],
10
    "associations": [
11
        "contacts",
12
        "companies"
13
    ],
14
    "archived": false,
15
    "after": "1234567890",
16
    "limit": 5
17
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "123456",
5
            "properties": {
6
                "subject": "Unable to access account",
7
                "content": "Customer reported issues logging into their account.",
8
                "hs_ticket_priority": "high",
9
                "hs_ticket_category": "technical_support",
10
                "createdate": "2023-05-15T10:30:00Z",
11
                "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
12
                "hs_object_id": "123456",
13
                "hs_pipeline": "support_pipeline",
14
                "hs_pipeline_stage": "new"
15
            },
16
            "createdAt": "2023-05-15T10:30:00Z",
17
            "updatedAt": "2023-05-15T14:45:00Z",
18
            "archived": false
19
        },
20
        {
21
            "id": "123457",
22
            "properties": {
23
                "subject": "Billing inquiry",
24
                "content": "Customer has questions about their recent invoice.",
25
                "hs_ticket_priority": "medium",
26
                "hs_ticket_category": "billing",
27
                "createdate": "2023-05-14T09:15:00Z",
28
                "hs_lastmodifieddate": "2023-05-14T11:20:00Z",
29
                "hs_object_id": "123457",
30
                "hs_pipeline": "support_pipeline",
31
                "hs_pipeline_stage": "in_progress"
32
            },
33
            "createdAt": "2023-05-14T09:15:00Z",
34
            "updatedAt": "2023-05-14T11:20:00Z",
35
            "archived": false
36
        }
37
    ]
38
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "GET",
3
    "url": {
4
        "endpoint": "/contacts"
5
    },
6
    "headers": [
7
        {
8
            "key": "Accept",
9
            "value": "application/json"
10
        }
11
    ],
12
    "query_parameters": [
13
        {
14
            "key": "limit",
15
            "value": "10"
16
        },
17
        {
18
            "key": "properties",
19
            "value": "firstname,lastname,email"
20
        }
21
    ],
22
    "body": {
23
        "none": null
24
    },
25
    "include_raw_body": false,
26
    "parse_response": "true"
27
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json;charset=utf-8",
6
            "X-HubSpot-RateLimit-Daily": "250000",
7
            "X-HubSpot-RateLimit-Daily-Remaining": "249999"
8
        },
9
        "body": {
10
            "results": [
11
                {
12
                    "id": "1",
13
                    "properties": {
14
                        "firstname": "John",
15
                        "lastname": "Doe",
16
                        "email": "john.doe@example.com"
17
                    },
18
                    "createdAt": "2023-05-01T10:00:00Z",
19
                    "updatedAt": "2023-05-01T10:00:00Z"
20
                },
21
                {
22
                    "id": "2",
23
                    "properties": {
24
                        "firstname": "Jane",
25
                        "lastname": "Smith",
26
                        "email": "jane.smith@example.com"
27
                    },
28
                    "createdAt": "2023-05-02T11:30:00Z",
29
                    "updatedAt": "2023-05-02T11:30:00Z"
30
                }
31
            ],
32
            "paging": {
33
                "next": {
34
                    "after": "2",
35
                    "link": "https://api.hubapi.com/crm/v3/objects/contacts?limit=10&properties=firstname,lastname,email&after=2"
36
                }
37
            }
38
        }
39
    }
40
}

Search companies by domain
Copy

Search for companies by domain name.

Sample Input

1
{
2
    "domain": "example.com",
3
    "properties": [
4
        "name",
5
        "domain",
6
        "createdate",
7
        "hs_lastmodifieddate"
8
    ],
9
    "limit": 2,
10
    "after": "1234567890"
11
}

Sample Output

1
{
2
    "total": 3,
3
    "results": [
4
        {
5
            "id": "987654321",
6
            "properties": {
7
                "createdate": "2023-05-15T10:30:00Z",
8
                "domain": "example.com",
9
                "hs_lastmodifieddate": "2023-06-01T14:45:00Z",
10
                "hs_object_id": "987654321",
11
                "name": "Example Company A"
12
            },
13
            "createdAt": "2023-05-15T10:30:00Z",
14
            "updatedAt": "2023-06-01T14:45:00Z",
15
            "archived": false
16
        },
17
        {
18
            "id": "987654322",
19
            "properties": {
20
                "createdate": "2023-05-20T09:15:00Z",
21
                "domain": "example.com",
22
                "hs_lastmodifieddate": "2023-05-25T11:20:00Z",
23
                "hs_object_id": "987654322",
24
                "name": "Example Company B"
25
            },
26
            "createdAt": "2023-05-20T09:15:00Z",
27
            "updatedAt": "2023-05-25T11:20:00Z",
28
            "archived": false
29
        }
30
    ]
31
}

Update blog post
Copy

Update a single blog post.

Sample Input

1
{
2
    "blog_id": "12345678",
3
    "blog_post": {
4
        "name": "Updated Blog Post Title",
5
        "postBody": "<p>This is the updated content of the blog post.</p>",
6
        "metaDescription": "An updated description for the blog post",
7
        "state": "PUBLISHED",
8
        "tagIds": [
9
            1234,
10
            5678
11
        ],
12
        "featuredImage": "https://example.com/updated-featured-image.jpg",
13
        "publishDate": "2023-06-15T10:00:00Z"
14
    },
15
    "archived": false
16
}

Sample Output

1
{
2
    "id": "87654321",
3
    "slug": "updated-blog-post-title",
4
    "contentGroupId": "98765432",
5
    "name": "Updated Blog Post Title",
6
    "state": "PUBLISHED",
7
    "authorName": "John Doe",
8
    "createdById": "1122334455",
9
    "updatedById": "1122334455",
10
    "postBody": "<p>This is the updated content of the blog post.</p>",
11
    "metaDescription": "An updated description for the blog post",
12
    "tagIds": [
13
        1234,
14
        5678
15
    ],
16
    "featuredImage": "https://example.com/updated-featured-image.jpg",
17
    "publishDate": "2023-06-15T10:00:00Z",
18
    "published": true,
19
    "url": "https://example.com/blog/updated-blog-post-title",
20
    "createdAt": "2023-06-01T09:00:00Z",
21
    "updatedAt": "2023-06-15T10:00:00Z"
22
}

Update call engagement
Copy

Update a call by ID.

Sample Input

1
{
2
    "call_id": "1234567890",
3
    "timestamp": "2023-05-15T14:30:00Z",
4
    "title": "Follow-up call with potential client",
5
    "body": "Discussed product features and pricing. Client showed interest in our premium package.",
6
    "status": "COMPLETED",
7
    "hubspot_owner_id": "5678",
8
    "recording_url": "https://example.com/call-recordings/1234567890.mp3",
9
    "from_number": "+14155551234",
10
    "to_number": "+14155555678",
11
    "direction": "OUTBOUND",
12
    "call_disposition": "Interested",
13
    "call_duration": "900000",
14
    "callee_object_id": "9876543210",
15
    "callee_object_type_id": "0-1",
16
    "call_type": "Sales call",
17
    "attachment_ids": [
18
        "att1",
19
        "att2"
20
    ]
21
}

Sample Output

1
{
2
    "id": "1234567890",
3
    "properties": {
4
        "hs_all_owner_ids": "5678",
5
        "hs_attachment_ids": "att1;att2",
6
        "hs_body_preview": "Discussed product features and pricing. Client showed interest in our premium package.",
7
        "hs_body_preview_html": "<p>Discussed product features and pricing. Client showed interest in our premium package.</p>",
8
        "hs_body_preview_is_truncated": "false",
9
        "hs_call_body": "Discussed product features and pricing. Client showed interest in our premium package.",
10
        "hs_call_callee_object_id": "9876543210",
11
        "hs_call_direction": "OUTBOUND",
12
        "hs_call_disposition": "Interested",
13
        "hs_call_duration": "900000",
14
        "hs_call_from_number": "+14155551234",
15
        "hs_call_status": "COMPLETED",
16
        "hs_call_title": "Follow-up call with potential client",
17
        "hs_call_to_number": "+14155555678",
18
        "hs_createdate": "2023-05-15T14:30:00Z",
19
        "hs_lastmodifieddate": "2023-05-15T14:45:00Z",
20
        "hs_object_id": "1234567890",
21
        "hs_timestamp": "2023-05-15T14:30:00Z",
22
        "hs_user_ids_of_all_owners": "5678",
23
        "hubspot_owner_assigneddate": "2023-05-15T14:30:00Z",
24
        "hubspot_owner_id": "5678"
25
    },
26
    "createdAt": "2023-05-15T14:30:00Z",
27
    "updatedAt": "2023-05-15T14:45:00Z",
28
    "archived": false
29
}

Update contact
Copy

Update contact by ID.

Sample Input

1
{
2
    "contact_id": "51",
3
    "properties": [
4
        {
5
            "name": "firstname",
6
            "value": "John"
7
        },
8
        {
9
            "name": "lastname",
10
            "value": "Doe"
11
        },
12
        {
13
            "name": "email",
14
            "value": "johndoe@example.com"
15
        },
16
        {
17
            "name": "phone",
18
            "value": "+1 (555) 123-4567"
19
        },
20
        {
21
            "name": "company",
22
            "value": "Acme Inc."
23
        }
24
    ]
25
}

Sample Output

1
{
2
    "id": "51",
3
    "properties": {
4
        "company": "Acme Inc.",
5
        "email": "johndoe@example.com",
6
        "firstname": "John",
7
        "hs_calculated_phone_number": "+15551234567",
8
        "hs_calculated_phone_number_country_code": "US",
9
        "hs_email_domain": "example.com",
10
        "hs_searchable_calculated_phone_number": "15551234567",
11
        "lastmodifieddate": "2023-05-15T14:30:00.000Z",
12
        "lastname": "Doe",
13
        "phone": "+1 (555) 123-4567",
14
        "website": "https://www.acmeinc.com"
15
    },
16
    "createdAt": "2023-01-01T10:00:00.000Z",
17
    "updatedAt": "2023-05-15T14:30:00.000Z",
18
    "archived": false
19
}

Update deal
Copy

Update a deal by the given ID.

Sample Input

1
{
2
    "deal_id": 123456,
3
    "properties": [
4
        {
5
            "name": "dealname",
6
            "value": "Updated Enterprise Software Deal"
7
        },
8
        {
9
            "name": "amount",
10
            "value": 75000
11
        },
12
        {
13
            "name": "dealstage",
14
            "value": "qualifiedtobuy"
15
        },
16
        {
17
            "name": "closedate",
18
            "value": "2023-12-31"
19
        }
20
    ]
21
}

Sample Output

1
{
2
    "id": "123456",
3
    "properties": {
4
        "amount": "75000",
5
        "amount_in_home_currency": "75000",
6
        "closedate": "2023-12-31",
7
        "createdate": "2023-05-15T10:30:00.000Z",
8
        "days_to_close": "230",
9
        "dealname": "Updated Enterprise Software Deal",
10
        "dealstage": "qualifiedtobuy",
11
        "dealtype": "newbusiness",
12
        "hs_closed_amount": "0",
13
        "hs_closed_amount_in_home_currency": "0",
14
        "hs_deal_stage_probability": "40",
15
        "hs_deal_stage_probability_shadow": "40",
16
        "hs_forecast_amount": "30000",
17
        "hs_is_closed": "false",
18
        "hs_is_closed_won": "false",
19
        "hs_lastmodifieddate": "2023-05-20T14:45:30.000Z",
20
        "hs_object_id": "123456",
21
        "hs_projected_amount": "75000",
22
        "hs_projected_amount_in_home_currency": "75000",
23
        "pipeline": "default"
24
    },
25
    "createdAt": "2023-05-15T10:30:00.000Z",
26
    "updatedAt": "2023-05-20T14:45:30.000Z",
27
    "archived": false
28
}

Update marketing event (beta)
Copy

Update an existing marketing event in HubSpot.

Sample Input

1
{
2
    "external_account_id": "12345",
3
    "external_event_id": "67890",
4
    "event_organizer": "TechCorp",
5
    "event_name": "Annual Tech Summit 2023",
6
    "event_type": "CONFERENCE",
7
    "start_date_time": "2023-09-15T09:00:00Z",
8
    "end_date_time": "2023-09-17T18:00:00Z",
9
    "event_description": "Join us for our annual tech conference featuring industry leaders and innovative workshops.",
10
    "event_url": "https://techcorp.com/tech-summit-2023",
11
    "event_cancelled": false,
12
    "custom_properties": [
13
        {
14
            "name": "venue",
15
            "value": "San Francisco Convention Center"
16
        },
17
        {
18
            "name": "expected_attendees",
19
            "value": "5000"
20
        }
21
    ]
22
}

Sample Output

1
{
2
    "eventName": "Annual Tech Summit 2023",
3
    "eventType": "CONFERENCE",
4
    "startDateTime": "2023-09-15T09:00:00Z",
5
    "endDateTime": "2023-09-17T18:00:00Z",
6
    "eventOrganizer": "TechCorp",
7
    "eventDescription": "Join us for our annual tech conference featuring industry leaders and innovative workshops.",
8
    "eventUrl": "https://techcorp.com/tech-summit-2023",
9
    "eventCancelled": false,
10
    "customProperties": [
11
        {
12
            "name": "venue",
13
            "value": "San Francisco Convention Center",
14
            "timestamp": 1631700000000,
15
            "sourceId": "update_marketing_event",
16
            "sourceLabel": "Tray.io",
17
            "source": "API",
18
            "selectedByUser": true,
19
            "selectedByUserTimestamp": 1631700000000,
20
            "sourceVid": [
21
                12345
22
            ],
23
            "sourceMetadata": "",
24
            "requestId": "abc123def456"
25
        },
26
        {
27
            "name": "expected_attendees",
28
            "value": "5000",
29
            "timestamp": 1631700000000,
30
            "sourceId": "update_marketing_event",
31
            "sourceLabel": "Tray.io",
32
            "source": "API",
33
            "selectedByUser": true,
34
            "selectedByUserTimestamp": 1631700000000,
35
            "sourceVid": [
36
                12345
37
            ],
38
            "sourceMetadata": "",
39
            "requestId": "abc123def456"
40
        }
41
    ]
42
}

Update object schema
Copy

Update the details for an existing object schema.

Sample Input

1
{
2
    "custom_object_type": "2-12345678",
3
    "custom_object_name": "Project",
4
    "labels": {
5
        "singular": "Project",
6
        "plural": "Projects"
7
    },
8
    "required_properties": [
9
        "project_name",
10
        "start_date"
11
    ],
12
    "searchable_properties": [
13
        "project_name",
14
        "client_name",
15
        "project_manager"
16
    ],
17
    "primary_display_property": "project_name",
18
    "secondary_display_properties": [
19
        "client_name",
20
        "status"
21
    ],
22
    "restorable": true
23
}

Sample Output

1
{
2
    "labels": {
3
        "singular": "Project",
4
        "plural": "Projects"
5
    },
6
    "requiredProperties": [
7
        "project_name",
8
        "start_date"
9
    ],
10
    "searchableProperties": [
11
        "project_name",
12
        "client_name",
13
        "project_manager"
14
    ],
15
    "primaryDisplayProperty": "project_name",
16
    "secondaryDisplayProperties": [
17
        "client_name",
18
        "status"
19
    ],
20
    "archived": false,
21
    "restorable": true,
22
    "metaType": "CUSTOM_OBJECT",
23
    "id": "2-12345678",
24
    "fullyQualifiedName": "p12345678.Project",
25
    "createdAt": "2023-05-15T10:30:00.000Z",
26
    "updatedAt": "2023-05-15T14:45:00.000Z",
27
    "objectTypeId": "2-12345678",
28
    "name": "Project",
29
    "portalId": 12345678
30
}

Update product
Copy

Update a product by the given ID.

Sample Input

1
{
2
    "product_id": "123456",
3
    "properties": [
4
        {
5
            "name": "name",
6
            "value": "Updated Product Name"
7
        },
8
        {
9
            "name": "description",
10
            "value": "This is an updated product description."
11
        },
12
        {
13
            "name": "price",
14
            "value": 99.99
15
        },
16
        {
17
            "name": "hs_cost_of_goods_sold",
18
            "value": "50.00"
19
        }
20
    ]
21
}

Sample Output

1
{
2
    "id": "123456",
3
    "properties": {
4
        "createdate": "2023-05-01T10:30:00.000Z",
5
        "description": "This is an updated product description.",
6
        "hs_cost_of_goods_sold": "50.00",
7
        "hs_lastmodifieddate": "2023-05-15T14:45:00.000Z",
8
        "hs_object_id": "123456",
9
        "name": "Updated Product Name",
10
        "price": "99.99"
11
    },
12
    "createdAt": "2023-05-01T10:30:00.000Z",
13
    "updatedAt": "2023-05-15T14:45:00.000Z",
14
    "archived": false
15
}

Update task engagement
Copy

Update a task by ID.

Sample Input

1
{
2
    "task_id": "1234567890",
3
    "timestamp": "2023-06-15T14:30:00Z",
4
    "subject": "Follow up with client",
5
    "body": "Discuss the new product features and gather feedback",
6
    "hubspot_owner_id": "5678",
7
    "status": "NOT_STARTED",
8
    "priority": "HIGH",
9
    "type": "CALL"
10
}

Sample Output

1
{
2
    "id": "1234567890",
3
    "properties": {
4
        "hs_all_owner_ids": "5678",
5
        "hs_body_preview": "Discuss the new product features and gather feedback",
6
        "hs_body_preview_html": "<p>Discuss the new product features and gather feedback</p>",
7
        "hs_body_preview_is_truncated": "false",
8
        "hs_createdate": "2023-06-10T09:00:00.000Z",
9
        "hs_lastmodifieddate": "2023-06-15T14:30:00.000Z",
10
        "hs_object_id": "1234567890",
11
        "hs_task_body": "Discuss the new product features and gather feedback",
12
        "hs_task_priority": "HIGH",
13
        "hs_task_status": "NOT_STARTED",
14
        "hs_task_subject": "Follow up with client",
15
        "hs_task_type": "CALL",
16
        "hs_timestamp": "2023-06-15T14:30:00.000Z",
17
        "hs_user_ids_of_all_owners": "5678",
18
        "hubspot_owner_assigneddate": "2023-06-10T09:00:00.000Z",
19
        "hubspot_owner_id": "5678"
20
    },
21
    "createdAt": "2023-06-10T09:00:00.000Z",
22
    "updatedAt": "2023-06-15T14:30:00.000Z",
23
    "archived": false
24
}

Upload file from URL
Copy

Asynchronously import a file at a given URL into the file manager.

Sample Input

1
{
2
    "access": "PUBLIC_INDEXABLE",
3
    "file_url": "https://example.com/sample-file.pdf",
4
    "duplicate_validation_strategy": "REJECT",
5
    "duplicate_validation_scope": "EXACT_FOLDER",
6
    "overwrite": false,
7
    "folder_id": "12345678",
8
    "file_name": "sample-file.pdf",
9
    "ttl": "2023-12-31T23:59:59Z"
10
}

Sample Output

1
{
2
    "id": "987654321",
3
    "links": {
4
        "status": "https://api.hubapi.com/files/v3/files/import/987654321/status"
5
    }
6
}

DDL operations
Copy

List association definitions (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1",
5
            "fromObjectTypeId": "0-1",
6
            "toObjectTypeId": "0-2",
7
            "name": "contact_to_company",
8
            "label": "Contact to Company",
9
            "cardinality": "MANY_TO_ONE"
10
        },
11
        {
12
            "id": "2",
13
            "fromObjectTypeId": "0-3",
14
            "toObjectTypeId": "0-1",
15
            "name": "deal_to_contact",
16
            "label": "Deal to Contact",
17
            "cardinality": "MANY_TO_MANY"
18
        },
19
        {
20
            "id": "3",
21
            "fromObjectTypeId": "0-4",
22
            "toObjectTypeId": "0-2",
23
            "name": "ticket_to_company",
24
            "label": "Ticket to Company",
25
            "cardinality": "MANY_TO_ONE"
26
        }
27
    ],
28
    "paging": {
29
        "next": {
30
            "after": "3",
31
            "link": "https://api.hubapi.com/crm/v3/associations/definitions?after=3"
32
        }
33
    }
34
}

List associations (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "fromObjectType": "CONTACT",
4
        "toObjectType": "COMPANY",
5
        "name": "contact_to_company",
6
        "label": "Contact to company"
7
    },
8
    {
9
        "fromObjectType": "DEAL",
10
        "toObjectType": "CONTACT",
11
        "name": "deal_to_contact",
12
        "label": "Deal to contact"
13
    },
14
    {
15
        "fromObjectType": "TICKET",
16
        "toObjectType": "CONTACT",
17
        "name": "ticket_to_contact",
18
        "label": "Ticket to contact"
19
    },
20
    {
21
        "fromObjectType": "DEAL",
22
        "toObjectType": "COMPANY",
23
        "name": "deal_to_company",
24
        "label": "Deal to company"
25
    },
26
    {
27
        "fromObjectType": "TICKET",
28
        "toObjectType": "COMPANY",
29
        "name": "ticket_to_company",
30
        "label": "Ticket to company"
31
    }
32
]

List blog posts (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "data": [
3
        {
4
            "id": "12345678",
5
            "title": "10 Tips for Effective Content Marketing",
6
            "slug": "10-tips-for-effective-content-marketing",
7
            "created": "2023-05-15T10:30:00Z",
8
            "updated": "2023-05-16T14:45:00Z",
9
            "state": "PUBLISHED",
10
            "author": {
11
                "id": "98765",
12
                "email": "john.doe@example.com",
13
                "fullName": "John Doe"
14
            },
15
            "blog": {
16
                "id": "54321",
17
                "name": "Marketing Insights"
18
            },
19
            "featuredImage": "https://example.com/images/content-marketing-tips.jpg",
20
            "metaDescription": "Learn 10 effective tips to improve your content marketing strategy and boost engagement.",
21
            "postBody": "<p>Content marketing is essential for businesses looking to attract and retain customers...</p>"
22
        },
23
        {
24
            "id": "87654321",
25
            "title": "The Future of AI in Customer Service",
26
            "slug": "future-of-ai-in-customer-service",
27
            "created": "2023-05-10T09:15:00Z",
28
            "updated": "2023-05-11T11:20:00Z",
29
            "state": "PUBLISHED",
30
            "author": {
31
                "id": "56789",
32
                "email": "jane.smith@example.com",
33
                "fullName": "Jane Smith"
34
            },
35
            "blog": {
36
                "id": "54321",
37
                "name": "Marketing Insights"
38
            },
39
            "featuredImage": "https://example.com/images/ai-customer-service.jpg",
40
            "metaDescription": "Explore how AI is transforming customer service and what it means for businesses.",
41
            "postBody": "<p>Artificial Intelligence is revolutionizing the way businesses interact with their customers...</p>"
42
        }
43
    ],
44
    "total": 2,
45
    "offset": 0,
46
    "limit": 20
47
}

List call engagement dispositions (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "label": "Completed",
5
            "value": "COMPLETED"
6
        },
7
        {
8
            "label": "No answer",
9
            "value": "NO_ANSWER"
10
        },
11
        {
12
            "label": "Busy",
13
            "value": "BUSY"
14
        },
15
        {
16
            "label": "Left voicemail",
17
            "value": "LEFT_VOICEMAIL"
18
        },
19
        {
20
            "label": "Wrong number",
21
            "value": "WRONG_NUMBER"
22
        }
23
    ]
24
}

List call engagement properties (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "name": "hs_call_body",
4
        "label": "Call notes",
5
        "description": "Notes for the call engagement",
6
        "groupName": "callInformation",
7
        "type": "string",
8
        "fieldType": "textarea",
9
        "createdAt": "2019-10-30T14:45:00.000Z",
10
        "updatedAt": "2019-10-30T14:45:00.000Z",
11
        "hasUniqueValue": false,
12
        "hidden": false,
13
        "formField": true
14
    },
15
    {
16
        "name": "hs_call_disposition",
17
        "label": "Call disposition",
18
        "description": "Outcome of the call",
19
        "groupName": "callInformation",
20
        "type": "enumeration",
21
        "fieldType": "select",
22
        "options": [
23
            {
24
                "label": "Answered",
25
                "value": "ANSWERED"
26
            },
27
            {
28
                "label": "Left voicemail",
29
                "value": "LEFT_VOICEMAIL"
30
            },
31
            {
32
                "label": "No answer",
33
                "value": "NO_ANSWER"
34
            }
35
        ],
36
        "createdAt": "2019-10-30T14:45:00.000Z",
37
        "updatedAt": "2019-10-30T14:45:00.000Z",
38
        "hasUniqueValue": false,
39
        "hidden": false,
40
        "formField": true
41
    },
42
    {
43
        "name": "hs_call_duration",
44
        "label": "Call duration",
45
        "description": "Duration of the call in seconds",
46
        "groupName": "callInformation",
47
        "type": "number",
48
        "fieldType": "number",
49
        "createdAt": "2019-10-30T14:45:00.000Z",
50
        "updatedAt": "2019-10-30T14:45:00.000Z",
51
        "hasUniqueValue": false,
52
        "hidden": false,
53
        "formField": true
54
    }
55
]

List call engagements (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1234567890",
5
            "type": "CALL",
6
            "timestamp": "2023-05-15T14:30:00Z",
7
            "duration": 600,
8
            "fromNumber": "+1234567890",
9
            "toNumber": "+9876543210",
10
            "status": "COMPLETED",
11
            "disposition": "CONNECTED",
12
            "recordingUrl": "https://example.com/recording/1234567890.mp3",
13
            "notes": "Discussed product features and pricing",
14
            "ownerId": "5678",
15
            "contactId": "9876",
16
            "dealId": "5432"
17
        },
18
        {
19
            "id": "2345678901",
20
            "type": "CALL",
21
            "timestamp": "2023-05-16T10:15:00Z",
22
            "duration": 300,
23
            "fromNumber": "+1234567890",
24
            "toNumber": "+1987654321",
25
            "status": "COMPLETED",
26
            "disposition": "LEFT_VOICEMAIL",
27
            "recordingUrl": null,
28
            "notes": "Left voicemail regarding follow-up meeting",
29
            "ownerId": "5678",
30
            "contactId": "8765",
31
            "dealId": null
32
        }
33
    ],
34
    "hasMore": true,
35
    "offset": "2345678901"
36
}

List comments (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "123456",
5
            "hs_timestamp": "2023-05-15T10:30:00Z",
6
            "hs_created_by": "user@example.com",
7
            "hs_object_id": "789012",
8
            "hs_association_source_type": "DEAL",
9
            "comment": "Called the client to discuss the proposal. They seem interested and requested a follow-up meeting next week.",
10
            "hs_attachment_ids": [
11
                "attachment1",
12
                "attachment2"
13
            ]
14
        },
15
        {
16
            "id": "234567",
17
            "hs_timestamp": "2023-05-14T15:45:00Z",
18
            "hs_created_by": "anotheruser@example.com",
19
            "hs_object_id": "345678",
20
            "hs_association_source_type": "CONTACT",
21
            "comment": "Updated contact information. New phone number: +1 (555) 123-4567",
22
            "hs_attachment_ids": []
23
        }
24
    ],
25
    "paging": {
26
        "next": {
27
            "after": "234567",
28
            "link": "https://api.hubapi.com/crm/v3/objects/comments?after=234567"
29
        }
30
    }
31
}

List companies (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "companies": [
3
        {
4
            "id": "1234567",
5
            "name": "Acme Corporation",
6
            "domain": "acme.com"
7
        },
8
        {
9
            "id": "2345678",
10
            "name": "Global Innovations Inc.",
11
            "domain": "globalinnovations.com"
12
        },
13
        {
14
            "id": "3456789",
15
            "name": "Tech Solutions Ltd.",
16
            "domain": "techsolutions.com"
17
        }
18
    ]
19
}

List company properties (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "label": "Company Name",
5
            "value": "name"
6
        },
7
        {
8
            "label": "Domain",
9
            "value": "domain"
10
        },
11
        {
12
            "label": "Industry",
13
            "value": "industry"
14
        },
15
        {
16
            "label": "Number of Employees",
17
            "value": "numberofemployees"
18
        },
19
        {
20
            "label": "Annual Revenue",
21
            "value": "annualrevenue"
22
        },
23
        {
24
            "label": "City",
25
            "value": "city"
26
        },
27
        {
28
            "label": "State/Region",
29
            "value": "state"
30
        },
31
        {
32
            "label": "Country",
33
            "value": "country"
34
        },
35
        {
36
            "label": "Phone Number",
37
            "value": "phone"
38
        },
39
        {
40
            "label": "Website URL",
41
            "value": "website"
42
        }
43
    ]
44
}

List contact lists (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "value": "1",
4
        "label": "Newsletter Subscribers"
5
    },
6
    {
7
        "value": "2",
8
        "label": "VIP Customers"
9
    },
10
    {
11
        "value": "3",
12
        "label": "Lead Nurturing Campaign"
13
    },
14
    {
15
        "value": "4",
16
        "label": "Webinar Attendees"
17
    },
18
    {
19
        "value": "5",
20
        "label": "Product Launch Interest"
21
    }
22
]

List contact properties (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "name": "firstname",
4
        "label": "First Name",
5
        "description": "A contact's first name",
6
        "groupName": "contactinformation",
7
        "type": "string",
8
        "fieldType": "text",
9
        "options": []
10
    },
11
    {
12
        "name": "lastname",
13
        "label": "Last Name",
14
        "description": "A contact's last name",
15
        "groupName": "contactinformation",
16
        "type": "string",
17
        "fieldType": "text",
18
        "options": []
19
    },
20
    {
21
        "name": "email",
22
        "label": "Email",
23
        "description": "A contact's email address",
24
        "groupName": "contactinformation",
25
        "type": "string",
26
        "fieldType": "text",
27
        "options": []
28
    },
29
    {
30
        "name": "phone",
31
        "label": "Phone Number",
32
        "description": "A contact's phone number",
33
        "groupName": "contactinformation",
34
        "type": "string",
35
        "fieldType": "text",
36
        "options": []
37
    },
38
    {
39
        "name": "company",
40
        "label": "Company Name",
41
        "description": "The company name of a contact",
42
        "groupName": "contactinformation",
43
        "type": "string",
44
        "fieldType": "text",
45
        "options": []
46
    }
47
]

List contacts (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "value": "1",
4
        "label": "John Doe"
5
    },
6
    {
7
        "value": "2",
8
        "label": "Jane Smith"
9
    },
10
    {
11
        "value": "3",
12
        "label": "Mike Johnson"
13
    },
14
    {
15
        "value": "4",
16
        "label": "Emily Brown"
17
    },
18
    {
19
        "value": "5",
20
        "label": "David Wilson"
21
    }
22
]

List crm object types (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "value": "contacts",
5
            "label": "Contacts"
6
        },
7
        {
8
            "value": "companies",
9
            "label": "Companies"
10
        },
11
        {
12
            "value": "deals",
13
            "label": "Deals"
14
        },
15
        {
16
            "value": "tickets",
17
            "label": "Tickets"
18
        },
19
        {
20
            "value": "products",
21
            "label": "Products"
22
        },
23
        {
24
            "value": "line_items",
25
            "label": "Line Items"
26
        },
27
        {
28
            "value": "quotes",
29
            "label": "Quotes"
30
        },
31
        {
32
            "value": "custom_object_1",
33
            "label": "Custom Object 1"
34
        },
35
        {
36
            "value": "custom_object_2",
37
            "label": "Custom Object 2"
38
        }
39
    ]
40
}

List deals (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "deals": [
3
        {
4
            "id": "1234567",
5
            "properties": {
6
                "dealname": "New Software Implementation",
7
                "amount": "50000",
8
                "dealstage": "presentationscheduled",
9
                "pipeline": "default",
10
                "closedate": "2023-06-30",
11
                "createdate": "2023-03-15T10:30:00Z",
12
                "hubspot_owner_id": "5678"
13
            },
14
            "associations": {
15
                "contacts": [
16
                    {
17
                        "id": "101"
18
                    },
19
                    {
20
                        "id": "102"
21
                    }
22
                ],
23
                "companies": [
24
                    {
25
                        "id": "201"
26
                    }
27
                ]
28
            }
29
        },
30
        {
31
            "id": "7654321",
32
            "properties": {
33
                "dealname": "Annual Contract Renewal",
34
                "amount": "75000",
35
                "dealstage": "contractsent",
36
                "pipeline": "default",
37
                "closedate": "2023-07-15",
38
                "createdate": "2023-04-01T09:15:00Z",
39
                "hubspot_owner_id": "9012"
40
            },
41
            "associations": {
42
                "contacts": [
43
                    {
44
                        "id": "303"
45
                    }
46
                ],
47
                "companies": [
48
                    {
49
                        "id": "404"
50
                    }
51
                ]
52
            }
53
        }
54
    ]
55
}

List folder IDs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "folderIds": [
3
        {
4
            "id": "12345",
5
            "name": "Marketing Campaigns"
6
        },
7
        {
8
            "id": "67890",
9
            "name": "Sales Collateral"
10
        },
11
        {
12
            "id": "24680",
13
            "name": "Customer Support"
14
        },
15
        {
16
            "id": "13579",
17
            "name": "Product Documentation"
18
        }
19
    ]
20
}

List folder paths (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "123456",
4
        "name": "Marketing Materials",
5
        "path": "/Marketing/Campaigns/2023/Q2"
6
    },
7
    {
8
        "id": "789012",
9
        "name": "Sales Presentations",
10
        "path": "/Sales/Presentations"
11
    },
12
    {
13
        "id": "345678",
14
        "name": "Customer Support",
15
        "path": "/Support/Documentation"
16
    }
17
]

List line items (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1234567",
5
            "name": "Product A",
6
            "quantity": 2,
7
            "price": 99.99,
8
            "hs_product_id": "987654",
9
            "hs_sku": "PROD-A-001",
10
            "hs_line_item_currency": "USD",
11
            "hs_line_item_discount_amount": 10,
12
            "hs_line_item_tax_amount": 8.5,
13
            "hs_line_item_total_amount": 198.48
14
        },
15
        {
16
            "id": "2345678",
17
            "name": "Service B",
18
            "quantity": 1,
19
            "price": 149.99,
20
            "hs_product_id": "876543",
21
            "hs_sku": "SERV-B-002",
22
            "hs_line_item_currency": "USD",
23
            "hs_line_item_discount_amount": 0,
24
            "hs_line_item_tax_amount": 12.75,
25
            "hs_line_item_total_amount": 162.74
26
        }
27
    ],
28
    "paging": {
29
        "next": {
30
            "after": "2345678",
31
            "link": "https://api.hubapi.com/crm/v3/objects/line_items?after=2345678"
32
        }
33
    }
34
}

List meeting engagement properties (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "name": "hs_meeting_body",
5
            "label": "Meeting Body",
6
            "description": "The body text of the meeting",
7
            "groupName": "meeting",
8
            "type": "string",
9
            "fieldType": "text",
10
            "options": []
11
        },
12
        {
13
            "name": "hs_meeting_title",
14
            "label": "Meeting Title",
15
            "description": "The title of the meeting",
16
            "groupName": "meeting",
17
            "type": "string",
18
            "fieldType": "text",
19
            "options": []
20
        },
21
        {
22
            "name": "hs_meeting_start_time",
23
            "label": "Meeting Start Time",
24
            "description": "The start time of the meeting",
25
            "groupName": "meeting",
26
            "type": "datetime",
27
            "fieldType": "date",
28
            "options": []
29
        },
30
        {
31
            "name": "hs_meeting_end_time",
32
            "label": "Meeting End Time",
33
            "description": "The end time of the meeting",
34
            "groupName": "meeting",
35
            "type": "datetime",
36
            "fieldType": "date",
37
            "options": []
38
        },
39
        {
40
            "name": "hs_meeting_location",
41
            "label": "Meeting Location",
42
            "description": "The location of the meeting",
43
            "groupName": "meeting",
44
            "type": "string",
45
            "fieldType": "text",
46
            "options": []
47
        }
48
    ]
49
}

List owner IDs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "label": "John Doe",
4
        "value": "1234567"
5
    },
6
    {
7
        "label": "Jane Smith",
8
        "value": "7654321"
9
    },
10
    {
11
        "label": "Mike Johnson",
12
        "value": "9876543"
13
    },
14
    {
15
        "label": "Sarah Williams",
16
        "value": "3456789"
17
    }
18
]

List property groups (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "label": "Contact Information",
5
            "value": "contactinformation"
6
        },
7
        {
8
            "label": "Social Media Information",
9
            "value": "socialmedia"
10
        },
11
        {
12
            "label": "Lead Information",
13
            "value": "leadinformation"
14
        },
15
        {
16
            "label": "Analytics Information",
17
            "value": "analyticsinformation"
18
        },
19
        {
20
            "label": "Sales Information",
21
            "value": "salesinformation"
22
        }
23
    ]
24
}

List task engagement properties (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "name": "hs_task_body",
4
        "label": "Task body",
5
        "description": "The body text of the task",
6
        "groupName": "taskengagement",
7
        "type": "string",
8
        "fieldType": "textarea",
9
        "formField": true,
10
        "modificationMetadata": {
11
            "archivable": false,
12
            "readOnlyDefinition": true,
13
            "readOnlyValue": false
14
        }
15
    },
16
    {
17
        "name": "hs_task_subject",
18
        "label": "Task subject",
19
        "description": "The subject of the task",
20
        "groupName": "taskengagement",
21
        "type": "string",
22
        "fieldType": "text",
23
        "formField": true,
24
        "modificationMetadata": {
25
            "archivable": false,
26
            "readOnlyDefinition": true,
27
            "readOnlyValue": false
28
        }
29
    },
30
    {
31
        "name": "hs_task_status",
32
        "label": "Task status",
33
        "description": "The current status of the task",
34
        "groupName": "taskengagement",
35
        "type": "enumeration",
36
        "fieldType": "select",
37
        "formField": true,
38
        "options": [
39
            {
40
                "label": "Not started",
41
                "value": "NOT_STARTED"
42
            },
43
            {
44
                "label": "In progress",
45
                "value": "IN_PROGRESS"
46
            },
47
            {
48
                "label": "Waiting",
49
                "value": "WAITING"
50
            },
51
            {
52
                "label": "Completed",
53
                "value": "COMPLETED"
54
            }
55
        ],
56
        "modificationMetadata": {
57
            "archivable": false,
58
            "readOnlyDefinition": true,
59
            "readOnlyValue": false
60
        }
61
    }
62
]

List task engagements (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "1234567",
5
            "type": "TASK",
6
            "timestamp": "2023-05-15T10:30:00Z",
7
            "ownerId": "9876",
8
            "title": "Follow up with client",
9
            "status": "COMPLETED",
10
            "dueDate": "2023-05-15",
11
            "taskType": "CALL",
12
            "priority": "HIGH",
13
            "description": "Call client to discuss proposal",
14
            "associations": {
15
                "contactIds": [
16
                    "5678"
17
                ],
18
                "companyIds": [
19
                    "9012"
20
                ],
21
                "dealIds": [
22
                    "3456"
23
                ]
24
            }
25
        },
26
        {
27
            "id": "2345678",
28
            "type": "TASK",
29
            "timestamp": "2023-05-16T14:00:00Z",
30
            "ownerId": "8765",
31
            "title": "Send contract",
32
            "status": "NOT_STARTED",
33
            "dueDate": "2023-05-18",
34
            "taskType": "EMAIL",
35
            "priority": "MEDIUM",
36
            "description": "Prepare and send contract to new client",
37
            "associations": {
38
                "contactIds": [
39
                    "7890"
40
                ],
41
                "companyIds": [
42
                    "1234"
43
                ],
44
                "dealIds": [
45
                    "5678"
46
                ]
47
            }
48
        }
49
    ],
50
    "paging": {
51
        "next": {
52
            "after": "2345678",
53
            "link": "https://api.hubapi.com/engagements/v1/engagements/paged?limit=2&after=2345678"
54
        }
55
    }
56
}

List ticket pipelines (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": "default",
5
            "label": "Support Pipeline",
6
            "active": true,
7
            "displayOrder": 0,
8
            "stages": [
9
                {
10
                    "id": "1",
11
                    "label": "New",
12
                    "displayOrder": 0
13
                },
14
                {
15
                    "id": "2",
16
                    "label": "In Progress",
17
                    "displayOrder": 1
18
                },
19
                {
20
                    "id": "3",
21
                    "label": "Waiting on Customer",
22
                    "displayOrder": 2
23
                },
24
                {
25
                    "id": "4",
26
                    "label": "Resolved",
27
                    "displayOrder": 3
28
                }
29
            ]
30
        },
31
        {
32
            "id": "custom_pipeline_1",
33
            "label": "IT Help Desk",
34
            "active": true,
35
            "displayOrder": 1,
36
            "stages": [
37
                {
38
                    "id": "5",
39
                    "label": "Submitted",
40
                    "displayOrder": 0
41
                },
42
                {
43
                    "id": "6",
44
                    "label": "Triaged",
45
                    "displayOrder": 1
46
                },
47
                {
48
                    "id": "7",
49
                    "label": "In Progress",
50
                    "displayOrder": 2
51
                },
52
                {
53
                    "id": "8",
54
                    "label": "Resolved",
55
                    "displayOrder": 3
56
                }
57
            ]
58
        }
59
    ]
60
}
Previous

Notes for Embedded customers

Next

Operations