@aifabrix/builder 2.32.3 → 2.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.cursor/rules/project-rules.mdc +8 -0
- package/README.md +36 -8
- package/bin/aifabrix.js +6 -8
- package/integration/hubspot/README.md +8 -7
- package/integration/hubspot/companies.json +2048 -0
- package/integration/hubspot/create-hubspot.js +665 -0
- package/integration/hubspot/{hubspot-deploy-company.json → hubspot-datasource-company.json} +1 -1
- package/integration/hubspot/{hubspot-deploy-contact.json → hubspot-datasource-contact.json} +1 -1
- package/integration/hubspot/{hubspot-deploy-deal.json → hubspot-datasource-deal.json} +1 -1
- package/integration/hubspot/hubspot-deploy.json +832 -81
- package/integration/hubspot/hubspot-system.json +99 -0
- package/integration/hubspot/test-artifacts/wizard-hubspot-credential-real.yaml +20 -0
- package/integration/hubspot/test-artifacts/wizard-hubspot-env-vars.yaml +9 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-add-datasource.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-app-name.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-credential-create.yaml +7 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-credential-select.yaml +7 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-known-platform.yaml +4 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-missing-app.yaml +4 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-missing-source.yaml +2 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-mode.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-openapi-file.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-openapi-url.yaml +4 -0
- package/integration/hubspot/test-artifacts/wizard-invalid-source.yaml +4 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-dimension-array-test.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-dimension-key-test.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-dimension-path-test.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-dimension-test.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-rbac-test.yaml +5 -0
- package/integration/hubspot/test-artifacts/wizard-valid-for-rbac-yaml-test.yaml +5 -0
- package/integration/hubspot/test-dataplane-down-helpers.js +246 -0
- package/integration/hubspot/test-dataplane-down-tests.js +419 -0
- package/integration/hubspot/test-dataplane-down.js +157 -0
- package/integration/hubspot/test.js +1517 -0
- package/integration/hubspot/variables.yaml +4 -4
- package/integration/hubspot/wizard-hubspot-e2e.yaml +16 -0
- package/integration/hubspot/wizard-hubspot-platform.yaml +8 -0
- package/lib/api/applications.api.js +1 -0
- package/lib/api/types/wizard.types.js +176 -38
- package/lib/api/wizard.api.js +161 -23
- package/lib/app/deploy.js +116 -54
- package/lib/app/display.js +6 -5
- package/lib/app/dockerfile.js +2 -1
- package/lib/app/list.js +17 -10
- package/lib/app/readme.js +41 -112
- package/lib/app/register.js +44 -9
- package/lib/app/rotate-secret.js +48 -31
- package/lib/cli.js +219 -70
- package/lib/commands/app.js +4 -9
- package/lib/commands/auth-config.js +125 -0
- package/lib/commands/auth-status.js +7 -8
- package/lib/commands/datasource.js +3 -6
- package/lib/commands/login-credentials.js +4 -4
- package/lib/commands/login-device.js +26 -17
- package/lib/commands/login.js +12 -10
- package/lib/commands/wizard-config-normalizer.js +92 -0
- package/lib/commands/wizard-core.js +515 -0
- package/lib/commands/wizard-dataplane.js +122 -0
- package/lib/commands/wizard-headless.js +115 -0
- package/lib/commands/wizard.js +110 -332
- package/lib/core/config.js +46 -0
- package/lib/core/secrets.js +3 -22
- package/lib/core/templates-env.js +1 -1
- package/lib/datasource/deploy.js +29 -21
- package/lib/datasource/list.js +8 -6
- package/lib/deployment/deployer.js +25 -0
- package/lib/deployment/environment.js +10 -13
- package/lib/external-system/delete.js +151 -0
- package/lib/external-system/deploy.js +53 -378
- package/lib/external-system/download-helpers.js +45 -65
- package/lib/external-system/download.js +33 -13
- package/lib/external-system/generator.js +11 -7
- package/lib/external-system/test-auth.js +4 -3
- package/lib/generator/builders.js +3 -1
- package/lib/generator/external-controller-manifest.js +157 -0
- package/lib/generator/external-schema-utils.js +236 -0
- package/lib/generator/external.js +55 -3
- package/lib/generator/index.js +22 -10
- package/lib/generator/wizard-prompts.js +33 -10
- package/lib/generator/wizard.js +69 -86
- package/lib/infrastructure/compose.js +100 -0
- package/lib/infrastructure/helpers.js +139 -0
- package/lib/infrastructure/index.js +52 -311
- package/lib/infrastructure/services.js +168 -0
- package/lib/schema/application-schema.json +23 -4
- package/lib/schema/external-datasource.schema.json +2 -2
- package/lib/schema/wizard-config.schema.json +234 -0
- package/lib/utils/api.js +32 -50
- package/lib/utils/app-existence.js +42 -0
- package/lib/utils/app-register-config.js +7 -2
- package/lib/utils/auth-config-validator.js +92 -0
- package/lib/utils/command-header.js +43 -0
- package/lib/utils/compose-generator.js +113 -70
- package/lib/utils/controller-url.js +65 -17
- package/lib/utils/dataplane-health.js +115 -0
- package/lib/utils/dataplane-resolver.js +29 -0
- package/lib/utils/dev-config.js +6 -2
- package/lib/utils/env-copy.js +2 -1
- package/lib/utils/env-ports.js +2 -1
- package/lib/utils/env-template.js +1 -1
- package/lib/utils/error-formatter.js +49 -0
- package/lib/utils/external-readme.js +125 -0
- package/lib/utils/help-builder.js +190 -0
- package/lib/utils/infra-status.js +13 -3
- package/lib/utils/paths.js +17 -2
- package/lib/utils/port-resolver.js +111 -0
- package/lib/utils/secrets-helpers.js +3 -15
- package/lib/utils/secrets-utils.js +2 -2
- package/lib/utils/token-manager.js +9 -4
- package/lib/utils/variable-transformer.js +7 -2
- package/lib/validation/external-manifest-validator.js +202 -0
- package/lib/validation/validate-display.js +406 -0
- package/lib/validation/validate.js +159 -123
- package/lib/validation/validator.js +36 -3
- package/lib/validation/wizard-config-validator.js +267 -0
- package/package.json +4 -2
- package/templates/applications/README.md.hbs +18 -16
- package/templates/applications/miso-controller/env.template +1 -1
- package/templates/applications/miso-controller/rbac.yaml +7 -7
- package/templates/external-system/README.md.hbs +99 -0
- package/templates/infra/compose.yaml.hbs +35 -0
- package/templates/python/docker-compose.hbs +26 -0
- package/templates/typescript/docker-compose.hbs +26 -0
|
@@ -0,0 +1,2048 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi" : "3.0.1",
|
|
3
|
+
"info" : {
|
|
4
|
+
"title" : "Companies",
|
|
5
|
+
"description" : "CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.\n\n## Supported Object Types\n\nThis API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).\n\n|Object Type |Properties returned by default |\n|--|--|\n| `companies` | `name`, `domain` |\n| `contacts` | `firstname`, `lastname`, `email` |\n| `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |\n| `products` | `name`, `description`, `price` |\n| `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |\n\nFind a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.",
|
|
6
|
+
"version" : "v3",
|
|
7
|
+
"x-hubspot-product-tier-requirements" : {
|
|
8
|
+
"marketing" : "FREE",
|
|
9
|
+
"sales" : "FREE",
|
|
10
|
+
"service" : "FREE",
|
|
11
|
+
"cms" : "FREE",
|
|
12
|
+
"commerce" : "FREE",
|
|
13
|
+
"crmHub" : "FREE",
|
|
14
|
+
"dataHub" : "FREE"
|
|
15
|
+
},
|
|
16
|
+
"x-hubspot-api-use-case" : "When a new customer signs up on your website with their business email address, create a company record to represent the relationship between the customer and the company they work for. A sales rep can later use this company record for outreach to find other potential sales opportunities. ",
|
|
17
|
+
"x-hubspot-related-documentation" : [ {
|
|
18
|
+
"name" : "Companies Guide",
|
|
19
|
+
"url" : "https://developers.hubspot.com/docs/guides/api/crm/objects/companies"
|
|
20
|
+
} ],
|
|
21
|
+
"x-hubspot-introduction" : "Use the companies API to create and manage CRM records that represent the companies and organizations that interact with your business."
|
|
22
|
+
},
|
|
23
|
+
"servers" : [ {
|
|
24
|
+
"url" : "https://api.hubapi.com"
|
|
25
|
+
} ],
|
|
26
|
+
"tags" : [ {
|
|
27
|
+
"name" : "Basic"
|
|
28
|
+
}, {
|
|
29
|
+
"name" : "Batch"
|
|
30
|
+
}, {
|
|
31
|
+
"name" : "GDPR"
|
|
32
|
+
}, {
|
|
33
|
+
"name" : "Public_Object"
|
|
34
|
+
}, {
|
|
35
|
+
"name" : "Public_Object__SE_PT_EM_BE_R_2025"
|
|
36
|
+
}, {
|
|
37
|
+
"name" : "Public_Object_Search_Post__SE_PT_EM_BE_R_2025"
|
|
38
|
+
}, {
|
|
39
|
+
"name" : "Search"
|
|
40
|
+
} ],
|
|
41
|
+
"paths" : {
|
|
42
|
+
"/crm/v3/objects/companies" : {
|
|
43
|
+
"get" : {
|
|
44
|
+
"tags" : [ "Basic" ],
|
|
45
|
+
"summary" : "Retrieve companies",
|
|
46
|
+
"description" : "Retrieve all companies, using query parameters to control the information that gets returned.",
|
|
47
|
+
"operationId" : "get-/crm/v3/objects/companies_getPage",
|
|
48
|
+
"parameters" : [ {
|
|
49
|
+
"name" : "after",
|
|
50
|
+
"in" : "query",
|
|
51
|
+
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
|
|
52
|
+
"required" : false,
|
|
53
|
+
"style" : "form",
|
|
54
|
+
"explode" : true,
|
|
55
|
+
"schema" : {
|
|
56
|
+
"type" : "string"
|
|
57
|
+
}
|
|
58
|
+
}, {
|
|
59
|
+
"name" : "archived",
|
|
60
|
+
"in" : "query",
|
|
61
|
+
"description" : "Whether to return only results that have been archived.",
|
|
62
|
+
"required" : false,
|
|
63
|
+
"style" : "form",
|
|
64
|
+
"explode" : true,
|
|
65
|
+
"schema" : {
|
|
66
|
+
"type" : "boolean",
|
|
67
|
+
"default" : false
|
|
68
|
+
}
|
|
69
|
+
}, {
|
|
70
|
+
"name" : "associations",
|
|
71
|
+
"in" : "query",
|
|
72
|
+
"description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
|
|
73
|
+
"required" : false,
|
|
74
|
+
"style" : "form",
|
|
75
|
+
"explode" : true,
|
|
76
|
+
"schema" : {
|
|
77
|
+
"type" : "array",
|
|
78
|
+
"items" : {
|
|
79
|
+
"type" : "string"
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}, {
|
|
83
|
+
"name" : "limit",
|
|
84
|
+
"in" : "query",
|
|
85
|
+
"description" : "The maximum number of results to display per page.",
|
|
86
|
+
"required" : false,
|
|
87
|
+
"style" : "form",
|
|
88
|
+
"explode" : true,
|
|
89
|
+
"schema" : {
|
|
90
|
+
"type" : "integer",
|
|
91
|
+
"format" : "int32",
|
|
92
|
+
"default" : 10
|
|
93
|
+
}
|
|
94
|
+
}, {
|
|
95
|
+
"name" : "objectType",
|
|
96
|
+
"in" : "path",
|
|
97
|
+
"required" : true,
|
|
98
|
+
"style" : "simple",
|
|
99
|
+
"explode" : false,
|
|
100
|
+
"schema" : {
|
|
101
|
+
"type" : "string"
|
|
102
|
+
}
|
|
103
|
+
}, {
|
|
104
|
+
"name" : "properties",
|
|
105
|
+
"in" : "query",
|
|
106
|
+
"description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
|
|
107
|
+
"required" : false,
|
|
108
|
+
"style" : "form",
|
|
109
|
+
"explode" : true,
|
|
110
|
+
"schema" : {
|
|
111
|
+
"type" : "array",
|
|
112
|
+
"items" : {
|
|
113
|
+
"type" : "string"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}, {
|
|
117
|
+
"name" : "propertiesWithHistory",
|
|
118
|
+
"in" : "query",
|
|
119
|
+
"description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of companies that can be read by a single request.",
|
|
120
|
+
"required" : false,
|
|
121
|
+
"style" : "form",
|
|
122
|
+
"explode" : true,
|
|
123
|
+
"schema" : {
|
|
124
|
+
"type" : "array",
|
|
125
|
+
"items" : {
|
|
126
|
+
"type" : "string"
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
} ],
|
|
130
|
+
"responses" : {
|
|
131
|
+
"200" : {
|
|
132
|
+
"description" : "successful operation",
|
|
133
|
+
"content" : {
|
|
134
|
+
"application/json" : {
|
|
135
|
+
"schema" : {
|
|
136
|
+
"$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociations"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"default" : {
|
|
142
|
+
"$ref" : "#/components/responses/Error"
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"security" : [ {
|
|
146
|
+
"oauth2" : [ "crm.objects.companies.read" ]
|
|
147
|
+
}, {
|
|
148
|
+
"oauth2_legacy" : [ ]
|
|
149
|
+
}, {
|
|
150
|
+
"private_apps" : [ "crm.objects.companies.read" ]
|
|
151
|
+
}, {
|
|
152
|
+
"private_apps_legacy" : [ ]
|
|
153
|
+
} ]
|
|
154
|
+
},
|
|
155
|
+
"post" : {
|
|
156
|
+
"tags" : [ "Basic" ],
|
|
157
|
+
"summary" : "Create a company",
|
|
158
|
+
"description" : "Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
|
|
159
|
+
"operationId" : "post-/crm/v3/objects/companies_create",
|
|
160
|
+
"parameters" : [ {
|
|
161
|
+
"name" : "objectType",
|
|
162
|
+
"in" : "path",
|
|
163
|
+
"description" : "The type of object.",
|
|
164
|
+
"required" : true,
|
|
165
|
+
"style" : "simple",
|
|
166
|
+
"explode" : false,
|
|
167
|
+
"schema" : {
|
|
168
|
+
"type" : "string"
|
|
169
|
+
}
|
|
170
|
+
} ],
|
|
171
|
+
"requestBody" : {
|
|
172
|
+
"content" : {
|
|
173
|
+
"application/json" : {
|
|
174
|
+
"schema" : {
|
|
175
|
+
"$ref" : "#/components/schemas/SimplePublicObjectInputForCreate"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"required" : true
|
|
180
|
+
},
|
|
181
|
+
"responses" : {
|
|
182
|
+
"200" : {
|
|
183
|
+
"description" : "successful operation",
|
|
184
|
+
"content" : {
|
|
185
|
+
"application/json" : {
|
|
186
|
+
"schema" : {
|
|
187
|
+
"$ref" : "#/components/schemas/CreatedResponseSimplePublicObject"
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
},
|
|
192
|
+
"default" : {
|
|
193
|
+
"$ref" : "#/components/responses/Error"
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
"security" : [ {
|
|
197
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
198
|
+
}, {
|
|
199
|
+
"oauth2_legacy" : [ ]
|
|
200
|
+
}, {
|
|
201
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
202
|
+
}, {
|
|
203
|
+
"private_apps_legacy" : [ ]
|
|
204
|
+
} ]
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"/crm/v3/objects/companies/batch/archive" : {
|
|
208
|
+
"post" : {
|
|
209
|
+
"tags" : [ "Batch" ],
|
|
210
|
+
"summary" : "Archive a batch of companies",
|
|
211
|
+
"description" : "Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).",
|
|
212
|
+
"operationId" : "post-/crm/v3/objects/companies/batch/archive_archive",
|
|
213
|
+
"parameters" : [ {
|
|
214
|
+
"name" : "objectType",
|
|
215
|
+
"in" : "path",
|
|
216
|
+
"required" : true,
|
|
217
|
+
"style" : "simple",
|
|
218
|
+
"explode" : false,
|
|
219
|
+
"schema" : {
|
|
220
|
+
"type" : "string"
|
|
221
|
+
}
|
|
222
|
+
} ],
|
|
223
|
+
"requestBody" : {
|
|
224
|
+
"content" : {
|
|
225
|
+
"application/json" : {
|
|
226
|
+
"schema" : {
|
|
227
|
+
"$ref" : "#/components/schemas/BatchInputSimplePublicObjectId"
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
},
|
|
231
|
+
"required" : true
|
|
232
|
+
},
|
|
233
|
+
"responses" : {
|
|
234
|
+
"204" : {
|
|
235
|
+
"description" : "No content",
|
|
236
|
+
"content" : { }
|
|
237
|
+
},
|
|
238
|
+
"default" : {
|
|
239
|
+
"$ref" : "#/components/responses/Error"
|
|
240
|
+
}
|
|
241
|
+
},
|
|
242
|
+
"security" : [ {
|
|
243
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
244
|
+
}, {
|
|
245
|
+
"oauth2_legacy" : [ ]
|
|
246
|
+
}, {
|
|
247
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
248
|
+
}, {
|
|
249
|
+
"private_apps_legacy" : [ ]
|
|
250
|
+
} ]
|
|
251
|
+
}
|
|
252
|
+
},
|
|
253
|
+
"/crm/v3/objects/companies/batch/create" : {
|
|
254
|
+
"post" : {
|
|
255
|
+
"tags" : [ "Batch" ],
|
|
256
|
+
"summary" : "Create a batch of companies",
|
|
257
|
+
"description" : "Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
|
|
258
|
+
"operationId" : "post-/crm/v3/objects/companies/batch/create_create",
|
|
259
|
+
"parameters" : [ {
|
|
260
|
+
"name" : "objectType",
|
|
261
|
+
"in" : "path",
|
|
262
|
+
"required" : true,
|
|
263
|
+
"style" : "simple",
|
|
264
|
+
"explode" : false,
|
|
265
|
+
"schema" : {
|
|
266
|
+
"type" : "string"
|
|
267
|
+
}
|
|
268
|
+
} ],
|
|
269
|
+
"requestBody" : {
|
|
270
|
+
"content" : {
|
|
271
|
+
"application/json" : {
|
|
272
|
+
"schema" : {
|
|
273
|
+
"$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate"
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
},
|
|
277
|
+
"required" : true
|
|
278
|
+
},
|
|
279
|
+
"responses" : {
|
|
280
|
+
"200" : {
|
|
281
|
+
"description" : "successful operation",
|
|
282
|
+
"content" : {
|
|
283
|
+
"application/json" : {
|
|
284
|
+
"schema" : {
|
|
285
|
+
"$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"default" : {
|
|
291
|
+
"$ref" : "#/components/responses/Error"
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"security" : [ {
|
|
295
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
296
|
+
}, {
|
|
297
|
+
"oauth2_legacy" : [ ]
|
|
298
|
+
}, {
|
|
299
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
300
|
+
}, {
|
|
301
|
+
"private_apps_legacy" : [ ]
|
|
302
|
+
} ]
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
"/crm/v3/objects/companies/batch/read" : {
|
|
306
|
+
"post" : {
|
|
307
|
+
"tags" : [ "Batch" ],
|
|
308
|
+
"summary" : "Retrieve a batch of companies",
|
|
309
|
+
"description" : "Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.",
|
|
310
|
+
"operationId" : "post-/crm/v3/objects/companies/batch/read_read",
|
|
311
|
+
"parameters" : [ {
|
|
312
|
+
"name" : "archived",
|
|
313
|
+
"in" : "query",
|
|
314
|
+
"description" : "Whether to return only results that have been archived.",
|
|
315
|
+
"required" : false,
|
|
316
|
+
"style" : "form",
|
|
317
|
+
"explode" : true,
|
|
318
|
+
"schema" : {
|
|
319
|
+
"type" : "boolean",
|
|
320
|
+
"default" : false
|
|
321
|
+
}
|
|
322
|
+
}, {
|
|
323
|
+
"name" : "objectType",
|
|
324
|
+
"in" : "path",
|
|
325
|
+
"required" : true,
|
|
326
|
+
"style" : "simple",
|
|
327
|
+
"explode" : false,
|
|
328
|
+
"schema" : {
|
|
329
|
+
"type" : "string"
|
|
330
|
+
}
|
|
331
|
+
} ],
|
|
332
|
+
"requestBody" : {
|
|
333
|
+
"content" : {
|
|
334
|
+
"application/json" : {
|
|
335
|
+
"schema" : {
|
|
336
|
+
"$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId"
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"required" : true
|
|
341
|
+
},
|
|
342
|
+
"responses" : {
|
|
343
|
+
"200" : {
|
|
344
|
+
"description" : "successful operation",
|
|
345
|
+
"content" : {
|
|
346
|
+
"application/json" : {
|
|
347
|
+
"schema" : {
|
|
348
|
+
"$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
},
|
|
353
|
+
"default" : {
|
|
354
|
+
"$ref" : "#/components/responses/Error"
|
|
355
|
+
}
|
|
356
|
+
},
|
|
357
|
+
"security" : [ {
|
|
358
|
+
"oauth2" : [ "crm.objects.companies.read" ]
|
|
359
|
+
}, {
|
|
360
|
+
"oauth2_legacy" : [ ]
|
|
361
|
+
}, {
|
|
362
|
+
"private_apps" : [ "crm.objects.companies.read" ]
|
|
363
|
+
}, {
|
|
364
|
+
"private_apps_legacy" : [ ]
|
|
365
|
+
} ]
|
|
366
|
+
}
|
|
367
|
+
},
|
|
368
|
+
"/crm/v3/objects/companies/batch/update" : {
|
|
369
|
+
"post" : {
|
|
370
|
+
"tags" : [ "Batch" ],
|
|
371
|
+
"summary" : "Update a batch of companies",
|
|
372
|
+
"description" : "Update a batch of companies by ID.",
|
|
373
|
+
"operationId" : "post-/crm/v3/objects/companies/batch/update_update",
|
|
374
|
+
"parameters" : [ {
|
|
375
|
+
"name" : "objectType",
|
|
376
|
+
"in" : "path",
|
|
377
|
+
"required" : true,
|
|
378
|
+
"style" : "simple",
|
|
379
|
+
"explode" : false,
|
|
380
|
+
"schema" : {
|
|
381
|
+
"type" : "string"
|
|
382
|
+
}
|
|
383
|
+
} ],
|
|
384
|
+
"requestBody" : {
|
|
385
|
+
"content" : {
|
|
386
|
+
"application/json" : {
|
|
387
|
+
"schema" : {
|
|
388
|
+
"$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput"
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"required" : true
|
|
393
|
+
},
|
|
394
|
+
"responses" : {
|
|
395
|
+
"200" : {
|
|
396
|
+
"description" : "successful operation",
|
|
397
|
+
"content" : {
|
|
398
|
+
"application/json" : {
|
|
399
|
+
"schema" : {
|
|
400
|
+
"$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
}
|
|
404
|
+
},
|
|
405
|
+
"default" : {
|
|
406
|
+
"$ref" : "#/components/responses/Error"
|
|
407
|
+
}
|
|
408
|
+
},
|
|
409
|
+
"security" : [ {
|
|
410
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
411
|
+
}, {
|
|
412
|
+
"oauth2_legacy" : [ ]
|
|
413
|
+
}, {
|
|
414
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
415
|
+
}, {
|
|
416
|
+
"private_apps_legacy" : [ ]
|
|
417
|
+
} ]
|
|
418
|
+
}
|
|
419
|
+
},
|
|
420
|
+
"/crm/v3/objects/companies/batch/upsert" : {
|
|
421
|
+
"post" : {
|
|
422
|
+
"tags" : [ "Batch" ],
|
|
423
|
+
"summary" : "Create or update a batch of companies by unique property values",
|
|
424
|
+
"description" : "Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.",
|
|
425
|
+
"operationId" : "post-/crm/v3/objects/companies/batch/upsert_upsert",
|
|
426
|
+
"parameters" : [ {
|
|
427
|
+
"name" : "objectType",
|
|
428
|
+
"in" : "path",
|
|
429
|
+
"required" : true,
|
|
430
|
+
"style" : "simple",
|
|
431
|
+
"explode" : false,
|
|
432
|
+
"schema" : {
|
|
433
|
+
"type" : "string"
|
|
434
|
+
}
|
|
435
|
+
} ],
|
|
436
|
+
"requestBody" : {
|
|
437
|
+
"content" : {
|
|
438
|
+
"application/json" : {
|
|
439
|
+
"schema" : {
|
|
440
|
+
"$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert"
|
|
441
|
+
}
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"required" : true
|
|
445
|
+
},
|
|
446
|
+
"responses" : {
|
|
447
|
+
"200" : {
|
|
448
|
+
"description" : "successful operation",
|
|
449
|
+
"content" : {
|
|
450
|
+
"application/json" : {
|
|
451
|
+
"schema" : {
|
|
452
|
+
"$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject"
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"default" : {
|
|
458
|
+
"$ref" : "#/components/responses/Error"
|
|
459
|
+
}
|
|
460
|
+
},
|
|
461
|
+
"security" : [ {
|
|
462
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
463
|
+
}, {
|
|
464
|
+
"oauth2_legacy" : [ ]
|
|
465
|
+
}, {
|
|
466
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
467
|
+
}, {
|
|
468
|
+
"private_apps_legacy" : [ ]
|
|
469
|
+
} ]
|
|
470
|
+
}
|
|
471
|
+
},
|
|
472
|
+
"/crm/v3/objects/companies/merge" : {
|
|
473
|
+
"post" : {
|
|
474
|
+
"tags" : [ "Public_Object" ],
|
|
475
|
+
"summary" : "Merge two companies",
|
|
476
|
+
"description" : "Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).",
|
|
477
|
+
"operationId" : "post-/crm/v3/objects/companies/merge_merge",
|
|
478
|
+
"parameters" : [ {
|
|
479
|
+
"name" : "objectType",
|
|
480
|
+
"in" : "path",
|
|
481
|
+
"required" : true,
|
|
482
|
+
"style" : "simple",
|
|
483
|
+
"explode" : false,
|
|
484
|
+
"schema" : {
|
|
485
|
+
"type" : "string"
|
|
486
|
+
}
|
|
487
|
+
} ],
|
|
488
|
+
"requestBody" : {
|
|
489
|
+
"content" : {
|
|
490
|
+
"application/json" : {
|
|
491
|
+
"schema" : {
|
|
492
|
+
"$ref" : "#/components/schemas/PublicMergeInput"
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"required" : true
|
|
497
|
+
},
|
|
498
|
+
"responses" : {
|
|
499
|
+
"200" : {
|
|
500
|
+
"description" : "successful operation",
|
|
501
|
+
"content" : {
|
|
502
|
+
"application/json" : {
|
|
503
|
+
"schema" : {
|
|
504
|
+
"$ref" : "#/components/schemas/SimplePublicObject"
|
|
505
|
+
}
|
|
506
|
+
}
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
"default" : {
|
|
510
|
+
"$ref" : "#/components/responses/Error"
|
|
511
|
+
}
|
|
512
|
+
},
|
|
513
|
+
"security" : [ {
|
|
514
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
515
|
+
}, {
|
|
516
|
+
"oauth2_legacy" : [ ]
|
|
517
|
+
}, {
|
|
518
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
519
|
+
}, {
|
|
520
|
+
"private_apps_legacy" : [ ]
|
|
521
|
+
} ]
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"/crm/v3/objects/companies/search" : {
|
|
525
|
+
"post" : {
|
|
526
|
+
"tags" : [ "Search" ],
|
|
527
|
+
"summary" : "Search for companies",
|
|
528
|
+
"description" : "Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).",
|
|
529
|
+
"operationId" : "post-/crm/v3/objects/companies/search_doSearch",
|
|
530
|
+
"parameters" : [ {
|
|
531
|
+
"name" : "objectType",
|
|
532
|
+
"in" : "path",
|
|
533
|
+
"required" : true,
|
|
534
|
+
"style" : "simple",
|
|
535
|
+
"explode" : false,
|
|
536
|
+
"schema" : {
|
|
537
|
+
"type" : "string"
|
|
538
|
+
}
|
|
539
|
+
} ],
|
|
540
|
+
"requestBody" : {
|
|
541
|
+
"content" : {
|
|
542
|
+
"application/json" : {
|
|
543
|
+
"schema" : {
|
|
544
|
+
"$ref" : "#/components/schemas/PublicObjectSearchRequest"
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"required" : true
|
|
549
|
+
},
|
|
550
|
+
"responses" : {
|
|
551
|
+
"200" : {
|
|
552
|
+
"description" : "successful operation",
|
|
553
|
+
"content" : {
|
|
554
|
+
"application/json" : {
|
|
555
|
+
"schema" : {
|
|
556
|
+
"$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject"
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
}
|
|
560
|
+
},
|
|
561
|
+
"default" : {
|
|
562
|
+
"$ref" : "#/components/responses/Error"
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
"security" : [ {
|
|
566
|
+
"oauth2" : [ "crm.objects.companies.read" ]
|
|
567
|
+
}, {
|
|
568
|
+
"oauth2_legacy" : [ ]
|
|
569
|
+
}, {
|
|
570
|
+
"private_apps" : [ "crm.objects.companies.read" ]
|
|
571
|
+
}, {
|
|
572
|
+
"private_apps_legacy" : [ ]
|
|
573
|
+
} ],
|
|
574
|
+
"x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ]
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
"/crm/v3/objects/companies/{companyId}" : {
|
|
578
|
+
"get" : {
|
|
579
|
+
"tags" : [ "Basic" ],
|
|
580
|
+
"summary" : "Retrieve a company",
|
|
581
|
+
"description" : "Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.",
|
|
582
|
+
"operationId" : "get-/crm/v3/objects/companies/{companyId}_getById",
|
|
583
|
+
"parameters" : [ {
|
|
584
|
+
"name" : "archived",
|
|
585
|
+
"in" : "query",
|
|
586
|
+
"description" : "Whether to return only results that have been archived.",
|
|
587
|
+
"required" : false,
|
|
588
|
+
"style" : "form",
|
|
589
|
+
"explode" : true,
|
|
590
|
+
"schema" : {
|
|
591
|
+
"type" : "boolean",
|
|
592
|
+
"default" : false
|
|
593
|
+
}
|
|
594
|
+
}, {
|
|
595
|
+
"name" : "associations",
|
|
596
|
+
"in" : "query",
|
|
597
|
+
"description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
|
|
598
|
+
"required" : false,
|
|
599
|
+
"style" : "form",
|
|
600
|
+
"explode" : true,
|
|
601
|
+
"schema" : {
|
|
602
|
+
"type" : "array",
|
|
603
|
+
"items" : {
|
|
604
|
+
"type" : "string"
|
|
605
|
+
}
|
|
606
|
+
}
|
|
607
|
+
}, {
|
|
608
|
+
"name" : "companyId",
|
|
609
|
+
"in" : "path",
|
|
610
|
+
"required" : true,
|
|
611
|
+
"style" : "simple",
|
|
612
|
+
"explode" : false,
|
|
613
|
+
"schema" : {
|
|
614
|
+
"pattern" : ".+",
|
|
615
|
+
"type" : "string"
|
|
616
|
+
}
|
|
617
|
+
}, {
|
|
618
|
+
"name" : "idProperty",
|
|
619
|
+
"in" : "query",
|
|
620
|
+
"description" : "The name of a property whose values are unique for this object",
|
|
621
|
+
"required" : false,
|
|
622
|
+
"style" : "form",
|
|
623
|
+
"explode" : true,
|
|
624
|
+
"schema" : {
|
|
625
|
+
"type" : "string"
|
|
626
|
+
}
|
|
627
|
+
}, {
|
|
628
|
+
"name" : "objectId",
|
|
629
|
+
"in" : "path",
|
|
630
|
+
"description" : "The ID of the company",
|
|
631
|
+
"required" : true,
|
|
632
|
+
"style" : "simple",
|
|
633
|
+
"explode" : false,
|
|
634
|
+
"schema" : {
|
|
635
|
+
"type" : "string"
|
|
636
|
+
}
|
|
637
|
+
}, {
|
|
638
|
+
"name" : "objectType",
|
|
639
|
+
"in" : "path",
|
|
640
|
+
"required" : true,
|
|
641
|
+
"style" : "simple",
|
|
642
|
+
"explode" : false,
|
|
643
|
+
"schema" : {
|
|
644
|
+
"type" : "string"
|
|
645
|
+
}
|
|
646
|
+
}, {
|
|
647
|
+
"name" : "properties",
|
|
648
|
+
"in" : "query",
|
|
649
|
+
"description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
|
|
650
|
+
"required" : false,
|
|
651
|
+
"style" : "form",
|
|
652
|
+
"explode" : true,
|
|
653
|
+
"schema" : {
|
|
654
|
+
"type" : "array",
|
|
655
|
+
"items" : {
|
|
656
|
+
"type" : "string"
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
}, {
|
|
660
|
+
"name" : "propertiesWithHistory",
|
|
661
|
+
"in" : "query",
|
|
662
|
+
"description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.",
|
|
663
|
+
"required" : false,
|
|
664
|
+
"style" : "form",
|
|
665
|
+
"explode" : true,
|
|
666
|
+
"schema" : {
|
|
667
|
+
"type" : "array",
|
|
668
|
+
"items" : {
|
|
669
|
+
"type" : "string"
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
} ],
|
|
673
|
+
"responses" : {
|
|
674
|
+
"200" : {
|
|
675
|
+
"description" : "successful operation",
|
|
676
|
+
"content" : {
|
|
677
|
+
"application/json" : {
|
|
678
|
+
"schema" : {
|
|
679
|
+
"$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
"default" : {
|
|
685
|
+
"$ref" : "#/components/responses/Error"
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
"security" : [ {
|
|
689
|
+
"oauth2" : [ "crm.objects.companies.read" ]
|
|
690
|
+
}, {
|
|
691
|
+
"oauth2_legacy" : [ ]
|
|
692
|
+
}, {
|
|
693
|
+
"private_apps" : [ "crm.objects.companies.read" ]
|
|
694
|
+
}, {
|
|
695
|
+
"private_apps_legacy" : [ ]
|
|
696
|
+
} ]
|
|
697
|
+
},
|
|
698
|
+
"delete" : {
|
|
699
|
+
"tags" : [ "Basic" ],
|
|
700
|
+
"summary" : "Archive a company",
|
|
701
|
+
"description" : "Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).",
|
|
702
|
+
"operationId" : "delete-/crm/v3/objects/companies/{companyId}_archive",
|
|
703
|
+
"parameters" : [ {
|
|
704
|
+
"name" : "companyId",
|
|
705
|
+
"in" : "path",
|
|
706
|
+
"required" : true,
|
|
707
|
+
"style" : "simple",
|
|
708
|
+
"explode" : false,
|
|
709
|
+
"schema" : {
|
|
710
|
+
"pattern" : ".+",
|
|
711
|
+
"type" : "string"
|
|
712
|
+
}
|
|
713
|
+
}, {
|
|
714
|
+
"name" : "objectId",
|
|
715
|
+
"in" : "path",
|
|
716
|
+
"required" : true,
|
|
717
|
+
"style" : "simple",
|
|
718
|
+
"explode" : false,
|
|
719
|
+
"schema" : {
|
|
720
|
+
"type" : "string"
|
|
721
|
+
}
|
|
722
|
+
}, {
|
|
723
|
+
"name" : "objectType",
|
|
724
|
+
"in" : "path",
|
|
725
|
+
"required" : true,
|
|
726
|
+
"style" : "simple",
|
|
727
|
+
"explode" : false,
|
|
728
|
+
"schema" : {
|
|
729
|
+
"type" : "string"
|
|
730
|
+
}
|
|
731
|
+
} ],
|
|
732
|
+
"responses" : {
|
|
733
|
+
"204" : {
|
|
734
|
+
"description" : "No content",
|
|
735
|
+
"content" : { }
|
|
736
|
+
},
|
|
737
|
+
"default" : {
|
|
738
|
+
"$ref" : "#/components/responses/Error"
|
|
739
|
+
}
|
|
740
|
+
},
|
|
741
|
+
"security" : [ {
|
|
742
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
743
|
+
}, {
|
|
744
|
+
"oauth2_legacy" : [ ]
|
|
745
|
+
}, {
|
|
746
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
747
|
+
}, {
|
|
748
|
+
"private_apps_legacy" : [ ]
|
|
749
|
+
} ]
|
|
750
|
+
},
|
|
751
|
+
"patch" : {
|
|
752
|
+
"tags" : [ "Basic" ],
|
|
753
|
+
"summary" : "Update a company",
|
|
754
|
+
"description" : "Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.",
|
|
755
|
+
"operationId" : "patch-/crm/v3/objects/companies/{companyId}_update",
|
|
756
|
+
"parameters" : [ {
|
|
757
|
+
"name" : "companyId",
|
|
758
|
+
"in" : "path",
|
|
759
|
+
"required" : true,
|
|
760
|
+
"style" : "simple",
|
|
761
|
+
"explode" : false,
|
|
762
|
+
"schema" : {
|
|
763
|
+
"pattern" : ".+",
|
|
764
|
+
"type" : "string"
|
|
765
|
+
}
|
|
766
|
+
}, {
|
|
767
|
+
"name" : "idProperty",
|
|
768
|
+
"in" : "query",
|
|
769
|
+
"description" : "The name of a property whose values are unique for this object",
|
|
770
|
+
"required" : false,
|
|
771
|
+
"style" : "form",
|
|
772
|
+
"explode" : true,
|
|
773
|
+
"schema" : {
|
|
774
|
+
"type" : "string"
|
|
775
|
+
}
|
|
776
|
+
}, {
|
|
777
|
+
"name" : "objectId",
|
|
778
|
+
"in" : "path",
|
|
779
|
+
"required" : true,
|
|
780
|
+
"style" : "simple",
|
|
781
|
+
"explode" : false,
|
|
782
|
+
"schema" : {
|
|
783
|
+
"type" : "string"
|
|
784
|
+
}
|
|
785
|
+
}, {
|
|
786
|
+
"name" : "objectType",
|
|
787
|
+
"in" : "path",
|
|
788
|
+
"required" : true,
|
|
789
|
+
"style" : "simple",
|
|
790
|
+
"explode" : false,
|
|
791
|
+
"schema" : {
|
|
792
|
+
"type" : "string"
|
|
793
|
+
}
|
|
794
|
+
} ],
|
|
795
|
+
"requestBody" : {
|
|
796
|
+
"content" : {
|
|
797
|
+
"application/json" : {
|
|
798
|
+
"schema" : {
|
|
799
|
+
"$ref" : "#/components/schemas/SimplePublicObjectInput"
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
"required" : true
|
|
804
|
+
},
|
|
805
|
+
"responses" : {
|
|
806
|
+
"200" : {
|
|
807
|
+
"description" : "successful operation",
|
|
808
|
+
"content" : {
|
|
809
|
+
"application/json" : {
|
|
810
|
+
"schema" : {
|
|
811
|
+
"$ref" : "#/components/schemas/SimplePublicObject"
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
}
|
|
815
|
+
},
|
|
816
|
+
"default" : {
|
|
817
|
+
"$ref" : "#/components/responses/Error"
|
|
818
|
+
}
|
|
819
|
+
},
|
|
820
|
+
"security" : [ {
|
|
821
|
+
"oauth2" : [ "crm.objects.companies.write" ]
|
|
822
|
+
}, {
|
|
823
|
+
"oauth2_legacy" : [ ]
|
|
824
|
+
}, {
|
|
825
|
+
"private_apps" : [ "crm.objects.companies.write" ]
|
|
826
|
+
}, {
|
|
827
|
+
"private_apps_legacy" : [ ]
|
|
828
|
+
} ]
|
|
829
|
+
}
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
"components" : {
|
|
833
|
+
"schemas" : {
|
|
834
|
+
"AssociatedId" : {
|
|
835
|
+
"required" : [ "id", "type" ],
|
|
836
|
+
"type" : "object",
|
|
837
|
+
"properties" : {
|
|
838
|
+
"id" : {
|
|
839
|
+
"type" : "string",
|
|
840
|
+
"description" : "The ID for the association type."
|
|
841
|
+
},
|
|
842
|
+
"type" : {
|
|
843
|
+
"type" : "string",
|
|
844
|
+
"description" : "The type of association.",
|
|
845
|
+
"example" : "deal_to_contact"
|
|
846
|
+
}
|
|
847
|
+
},
|
|
848
|
+
"description" : "Contains the id and type of an association"
|
|
849
|
+
},
|
|
850
|
+
"AssociationSpec" : {
|
|
851
|
+
"required" : [ "associationCategory", "associationTypeId" ],
|
|
852
|
+
"type" : "object",
|
|
853
|
+
"properties" : {
|
|
854
|
+
"associationCategory" : {
|
|
855
|
+
"type" : "string",
|
|
856
|
+
"description" : "For [labeled associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#associate-records-with-a-label), the category of the association.",
|
|
857
|
+
"enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ]
|
|
858
|
+
},
|
|
859
|
+
"associationTypeId" : {
|
|
860
|
+
"type" : "integer",
|
|
861
|
+
"description" : "The [association type ID](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#association-type-id-values) (e.g., `4` for contact-to-company associations).",
|
|
862
|
+
"format" : "int32"
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
"description" : "Defines the type, direction, and details of the relationship between two CRM objects."
|
|
866
|
+
},
|
|
867
|
+
"AssociationSpecWithLabel" : {
|
|
868
|
+
"required" : [ "category", "typeId" ],
|
|
869
|
+
"type" : "object",
|
|
870
|
+
"properties" : {
|
|
871
|
+
"category" : {
|
|
872
|
+
"type" : "string",
|
|
873
|
+
"enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ]
|
|
874
|
+
},
|
|
875
|
+
"label" : {
|
|
876
|
+
"type" : "string"
|
|
877
|
+
},
|
|
878
|
+
"typeId" : {
|
|
879
|
+
"type" : "integer",
|
|
880
|
+
"format" : "int32"
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
"BatchInputSimplePublicObjectBatchInput" : {
|
|
885
|
+
"required" : [ "inputs" ],
|
|
886
|
+
"type" : "object",
|
|
887
|
+
"properties" : {
|
|
888
|
+
"inputs" : {
|
|
889
|
+
"type" : "array",
|
|
890
|
+
"items" : {
|
|
891
|
+
"$ref" : "#/components/schemas/SimplePublicObjectBatchInput"
|
|
892
|
+
}
|
|
893
|
+
}
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
"BatchInputSimplePublicObjectBatchInputForCreate" : {
|
|
897
|
+
"required" : [ "inputs" ],
|
|
898
|
+
"type" : "object",
|
|
899
|
+
"properties" : {
|
|
900
|
+
"inputs" : {
|
|
901
|
+
"type" : "array",
|
|
902
|
+
"items" : {
|
|
903
|
+
"$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate"
|
|
904
|
+
}
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
},
|
|
908
|
+
"BatchInputSimplePublicObjectBatchInputUpsert" : {
|
|
909
|
+
"required" : [ "inputs" ],
|
|
910
|
+
"type" : "object",
|
|
911
|
+
"properties" : {
|
|
912
|
+
"inputs" : {
|
|
913
|
+
"type" : "array",
|
|
914
|
+
"items" : {
|
|
915
|
+
"$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
"BatchInputSimplePublicObjectId" : {
|
|
921
|
+
"required" : [ "inputs" ],
|
|
922
|
+
"type" : "object",
|
|
923
|
+
"properties" : {
|
|
924
|
+
"inputs" : {
|
|
925
|
+
"type" : "array",
|
|
926
|
+
"items" : {
|
|
927
|
+
"$ref" : "#/components/schemas/SimplePublicObjectId"
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
},
|
|
932
|
+
"BatchReadInputSimplePublicObjectId" : {
|
|
933
|
+
"required" : [ "inputs", "properties", "propertiesWithHistory" ],
|
|
934
|
+
"type" : "object",
|
|
935
|
+
"properties" : {
|
|
936
|
+
"idProperty" : {
|
|
937
|
+
"type" : "string",
|
|
938
|
+
"description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID."
|
|
939
|
+
},
|
|
940
|
+
"inputs" : {
|
|
941
|
+
"type" : "array",
|
|
942
|
+
"items" : {
|
|
943
|
+
"$ref" : "#/components/schemas/SimplePublicObjectId"
|
|
944
|
+
}
|
|
945
|
+
},
|
|
946
|
+
"properties" : {
|
|
947
|
+
"type" : "array",
|
|
948
|
+
"description" : "Key-value pairs for setting properties for the new object.",
|
|
949
|
+
"items" : {
|
|
950
|
+
"type" : "string"
|
|
951
|
+
}
|
|
952
|
+
},
|
|
953
|
+
"propertiesWithHistory" : {
|
|
954
|
+
"type" : "array",
|
|
955
|
+
"description" : "Key-value pairs for setting properties for the new object and their histories.",
|
|
956
|
+
"items" : {
|
|
957
|
+
"type" : "string"
|
|
958
|
+
}
|
|
959
|
+
}
|
|
960
|
+
},
|
|
961
|
+
"description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property."
|
|
962
|
+
},
|
|
963
|
+
"BatchResponsePublicDefaultAssociation" : {
|
|
964
|
+
"required" : [ "completedAt", "results", "startedAt", "status" ],
|
|
965
|
+
"type" : "object",
|
|
966
|
+
"properties" : {
|
|
967
|
+
"completedAt" : {
|
|
968
|
+
"type" : "string",
|
|
969
|
+
"format" : "date-time"
|
|
970
|
+
},
|
|
971
|
+
"errors" : {
|
|
972
|
+
"type" : "array",
|
|
973
|
+
"items" : {
|
|
974
|
+
"$ref" : "#/components/schemas/StandardError"
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"links" : {
|
|
978
|
+
"type" : "object",
|
|
979
|
+
"additionalProperties" : {
|
|
980
|
+
"type" : "string"
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
"numErrors" : {
|
|
984
|
+
"type" : "integer",
|
|
985
|
+
"format" : "int32"
|
|
986
|
+
},
|
|
987
|
+
"requestedAt" : {
|
|
988
|
+
"type" : "string",
|
|
989
|
+
"format" : "date-time"
|
|
990
|
+
},
|
|
991
|
+
"results" : {
|
|
992
|
+
"type" : "array",
|
|
993
|
+
"items" : {
|
|
994
|
+
"$ref" : "#/components/schemas/PublicDefaultAssociation"
|
|
995
|
+
}
|
|
996
|
+
},
|
|
997
|
+
"startedAt" : {
|
|
998
|
+
"type" : "string",
|
|
999
|
+
"format" : "date-time"
|
|
1000
|
+
},
|
|
1001
|
+
"status" : {
|
|
1002
|
+
"type" : "string",
|
|
1003
|
+
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
"BatchResponseSimplePublicObject" : {
|
|
1008
|
+
"required" : [ "completedAt", "results", "startedAt", "status" ],
|
|
1009
|
+
"type" : "object",
|
|
1010
|
+
"properties" : {
|
|
1011
|
+
"completedAt" : {
|
|
1012
|
+
"type" : "string",
|
|
1013
|
+
"description" : "The timestamp when the batch processing was completed, in ISO 8601 format.",
|
|
1014
|
+
"format" : "date-time"
|
|
1015
|
+
},
|
|
1016
|
+
"errors" : {
|
|
1017
|
+
"type" : "array",
|
|
1018
|
+
"items" : {
|
|
1019
|
+
"$ref" : "#/components/schemas/StandardError"
|
|
1020
|
+
}
|
|
1021
|
+
},
|
|
1022
|
+
"links" : {
|
|
1023
|
+
"type" : "object",
|
|
1024
|
+
"additionalProperties" : {
|
|
1025
|
+
"type" : "string"
|
|
1026
|
+
},
|
|
1027
|
+
"description" : "An object containing relevant links related to the batch request."
|
|
1028
|
+
},
|
|
1029
|
+
"numErrors" : {
|
|
1030
|
+
"type" : "integer",
|
|
1031
|
+
"format" : "int32"
|
|
1032
|
+
},
|
|
1033
|
+
"requestedAt" : {
|
|
1034
|
+
"type" : "string",
|
|
1035
|
+
"description" : "The timestamp when the batch request was initially made, in ISO 8601 format.",
|
|
1036
|
+
"format" : "date-time"
|
|
1037
|
+
},
|
|
1038
|
+
"results" : {
|
|
1039
|
+
"type" : "array",
|
|
1040
|
+
"items" : {
|
|
1041
|
+
"$ref" : "#/components/schemas/SimplePublicObject"
|
|
1042
|
+
}
|
|
1043
|
+
},
|
|
1044
|
+
"startedAt" : {
|
|
1045
|
+
"type" : "string",
|
|
1046
|
+
"description" : "The timestamp when the batch processing began, in ISO 8601 format.",
|
|
1047
|
+
"format" : "date-time"
|
|
1048
|
+
},
|
|
1049
|
+
"status" : {
|
|
1050
|
+
"type" : "string",
|
|
1051
|
+
"description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"",
|
|
1052
|
+
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
|
|
1053
|
+
}
|
|
1054
|
+
},
|
|
1055
|
+
"description" : "A public object batch response object"
|
|
1056
|
+
},
|
|
1057
|
+
"BatchResponseSimplePublicUpsertObject" : {
|
|
1058
|
+
"required" : [ "completedAt", "results", "startedAt", "status" ],
|
|
1059
|
+
"type" : "object",
|
|
1060
|
+
"properties" : {
|
|
1061
|
+
"completedAt" : {
|
|
1062
|
+
"type" : "string",
|
|
1063
|
+
"description" : "The timestamp when the batch process was completed, in ISO 8601 format.",
|
|
1064
|
+
"format" : "date-time"
|
|
1065
|
+
},
|
|
1066
|
+
"errors" : {
|
|
1067
|
+
"type" : "array",
|
|
1068
|
+
"items" : {
|
|
1069
|
+
"$ref" : "#/components/schemas/StandardError"
|
|
1070
|
+
}
|
|
1071
|
+
},
|
|
1072
|
+
"links" : {
|
|
1073
|
+
"type" : "object",
|
|
1074
|
+
"additionalProperties" : {
|
|
1075
|
+
"type" : "string"
|
|
1076
|
+
},
|
|
1077
|
+
"description" : "An object containing relevant links related to the batch request."
|
|
1078
|
+
},
|
|
1079
|
+
"numErrors" : {
|
|
1080
|
+
"type" : "integer",
|
|
1081
|
+
"format" : "int32"
|
|
1082
|
+
},
|
|
1083
|
+
"requestedAt" : {
|
|
1084
|
+
"type" : "string",
|
|
1085
|
+
"description" : "The timestamp when the batch process was initiated, in ISO 8601 format.",
|
|
1086
|
+
"format" : "date-time"
|
|
1087
|
+
},
|
|
1088
|
+
"results" : {
|
|
1089
|
+
"type" : "array",
|
|
1090
|
+
"items" : {
|
|
1091
|
+
"$ref" : "#/components/schemas/SimplePublicUpsertObject"
|
|
1092
|
+
}
|
|
1093
|
+
},
|
|
1094
|
+
"startedAt" : {
|
|
1095
|
+
"type" : "string",
|
|
1096
|
+
"description" : "The timestamp when the batch process began execution, in ISO 8601 format.",
|
|
1097
|
+
"format" : "date-time"
|
|
1098
|
+
},
|
|
1099
|
+
"status" : {
|
|
1100
|
+
"type" : "string",
|
|
1101
|
+
"description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".",
|
|
1102
|
+
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
"description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects."
|
|
1106
|
+
},
|
|
1107
|
+
"CollectionResponseAssociatedId" : {
|
|
1108
|
+
"required" : [ "results" ],
|
|
1109
|
+
"type" : "object",
|
|
1110
|
+
"properties" : {
|
|
1111
|
+
"paging" : {
|
|
1112
|
+
"$ref" : "#/components/schemas/Paging"
|
|
1113
|
+
},
|
|
1114
|
+
"results" : {
|
|
1115
|
+
"type" : "array",
|
|
1116
|
+
"items" : {
|
|
1117
|
+
"$ref" : "#/components/schemas/AssociatedId"
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
},
|
|
1122
|
+
"CollectionResponseMultiAssociatedObjectWithLabel" : {
|
|
1123
|
+
"required" : [ "results" ],
|
|
1124
|
+
"type" : "object",
|
|
1125
|
+
"properties" : {
|
|
1126
|
+
"paging" : {
|
|
1127
|
+
"$ref" : "#/components/schemas/Paging"
|
|
1128
|
+
},
|
|
1129
|
+
"results" : {
|
|
1130
|
+
"type" : "array",
|
|
1131
|
+
"items" : {
|
|
1132
|
+
"$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel"
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
},
|
|
1137
|
+
"CollectionResponseSimplePublicObjectWithAssociations" : {
|
|
1138
|
+
"required" : [ "results" ],
|
|
1139
|
+
"type" : "object",
|
|
1140
|
+
"properties" : {
|
|
1141
|
+
"paging" : {
|
|
1142
|
+
"$ref" : "#/components/schemas/Paging"
|
|
1143
|
+
},
|
|
1144
|
+
"results" : {
|
|
1145
|
+
"type" : "array",
|
|
1146
|
+
"items" : {
|
|
1147
|
+
"$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
|
|
1148
|
+
}
|
|
1149
|
+
}
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
"CollectionResponseWithTotalSimplePublicObject" : {
|
|
1153
|
+
"required" : [ "results", "total" ],
|
|
1154
|
+
"type" : "object",
|
|
1155
|
+
"properties" : {
|
|
1156
|
+
"paging" : {
|
|
1157
|
+
"$ref" : "#/components/schemas/Paging"
|
|
1158
|
+
},
|
|
1159
|
+
"results" : {
|
|
1160
|
+
"type" : "array",
|
|
1161
|
+
"items" : {
|
|
1162
|
+
"$ref" : "#/components/schemas/SimplePublicObject"
|
|
1163
|
+
}
|
|
1164
|
+
},
|
|
1165
|
+
"total" : {
|
|
1166
|
+
"type" : "integer",
|
|
1167
|
+
"description" : "The number of available results",
|
|
1168
|
+
"format" : "int32"
|
|
1169
|
+
}
|
|
1170
|
+
}
|
|
1171
|
+
},
|
|
1172
|
+
"CreatedResponseLabelsBetweenObjectPair" : {
|
|
1173
|
+
"required" : [ "createdResourceId", "entity" ],
|
|
1174
|
+
"type" : "object",
|
|
1175
|
+
"properties" : {
|
|
1176
|
+
"createdResourceId" : {
|
|
1177
|
+
"type" : "string"
|
|
1178
|
+
},
|
|
1179
|
+
"entity" : {
|
|
1180
|
+
"$ref" : "#/components/schemas/LabelsBetweenObjectPair"
|
|
1181
|
+
},
|
|
1182
|
+
"location" : {
|
|
1183
|
+
"type" : "string"
|
|
1184
|
+
}
|
|
1185
|
+
}
|
|
1186
|
+
},
|
|
1187
|
+
"CreatedResponseSimplePublicObject" : {
|
|
1188
|
+
"required" : [ "createdResourceId", "entity" ],
|
|
1189
|
+
"type" : "object",
|
|
1190
|
+
"properties" : {
|
|
1191
|
+
"createdResourceId" : {
|
|
1192
|
+
"type" : "string"
|
|
1193
|
+
},
|
|
1194
|
+
"entity" : {
|
|
1195
|
+
"$ref" : "#/components/schemas/SimplePublicObject"
|
|
1196
|
+
},
|
|
1197
|
+
"location" : {
|
|
1198
|
+
"type" : "string"
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1202
|
+
"Error" : {
|
|
1203
|
+
"required" : [ "category", "correlationId", "message" ],
|
|
1204
|
+
"type" : "object",
|
|
1205
|
+
"properties" : {
|
|
1206
|
+
"category" : {
|
|
1207
|
+
"type" : "string",
|
|
1208
|
+
"description" : "The error category"
|
|
1209
|
+
},
|
|
1210
|
+
"context" : {
|
|
1211
|
+
"type" : "object",
|
|
1212
|
+
"additionalProperties" : {
|
|
1213
|
+
"type" : "array",
|
|
1214
|
+
"items" : {
|
|
1215
|
+
"type" : "string"
|
|
1216
|
+
}
|
|
1217
|
+
},
|
|
1218
|
+
"description" : "Context about the error condition",
|
|
1219
|
+
"example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}"
|
|
1220
|
+
},
|
|
1221
|
+
"correlationId" : {
|
|
1222
|
+
"type" : "string",
|
|
1223
|
+
"description" : "A unique identifier for the request. Include this value with any error reports or support tickets",
|
|
1224
|
+
"format" : "uuid",
|
|
1225
|
+
"example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf"
|
|
1226
|
+
},
|
|
1227
|
+
"errors" : {
|
|
1228
|
+
"type" : "array",
|
|
1229
|
+
"description" : "further information about the error",
|
|
1230
|
+
"items" : {
|
|
1231
|
+
"$ref" : "#/components/schemas/ErrorDetail"
|
|
1232
|
+
}
|
|
1233
|
+
},
|
|
1234
|
+
"links" : {
|
|
1235
|
+
"type" : "object",
|
|
1236
|
+
"additionalProperties" : {
|
|
1237
|
+
"type" : "string"
|
|
1238
|
+
},
|
|
1239
|
+
"description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps"
|
|
1240
|
+
},
|
|
1241
|
+
"message" : {
|
|
1242
|
+
"type" : "string",
|
|
1243
|
+
"description" : "A human readable message describing the error along with remediation steps where appropriate",
|
|
1244
|
+
"example" : "An error occurred"
|
|
1245
|
+
},
|
|
1246
|
+
"subCategory" : {
|
|
1247
|
+
"type" : "string",
|
|
1248
|
+
"description" : "A specific category that contains more specific detail about the error"
|
|
1249
|
+
}
|
|
1250
|
+
},
|
|
1251
|
+
"example" : {
|
|
1252
|
+
"message" : "Invalid input (details will vary based on the error)",
|
|
1253
|
+
"correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf",
|
|
1254
|
+
"category" : "VALIDATION_ERROR",
|
|
1255
|
+
"links" : {
|
|
1256
|
+
"knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base"
|
|
1257
|
+
}
|
|
1258
|
+
}
|
|
1259
|
+
},
|
|
1260
|
+
"ErrorDetail" : {
|
|
1261
|
+
"required" : [ "message" ],
|
|
1262
|
+
"type" : "object",
|
|
1263
|
+
"properties" : {
|
|
1264
|
+
"code" : {
|
|
1265
|
+
"type" : "string",
|
|
1266
|
+
"description" : "The status code associated with the error detail"
|
|
1267
|
+
},
|
|
1268
|
+
"context" : {
|
|
1269
|
+
"type" : "object",
|
|
1270
|
+
"additionalProperties" : {
|
|
1271
|
+
"type" : "array",
|
|
1272
|
+
"items" : {
|
|
1273
|
+
"type" : "string"
|
|
1274
|
+
}
|
|
1275
|
+
},
|
|
1276
|
+
"description" : "Context about the error condition",
|
|
1277
|
+
"example" : "{missingScopes=[scope1, scope2]}"
|
|
1278
|
+
},
|
|
1279
|
+
"in" : {
|
|
1280
|
+
"type" : "string",
|
|
1281
|
+
"description" : "The name of the field or parameter in which the error was found."
|
|
1282
|
+
},
|
|
1283
|
+
"message" : {
|
|
1284
|
+
"type" : "string",
|
|
1285
|
+
"description" : "A human readable message describing the error along with remediation steps where appropriate"
|
|
1286
|
+
},
|
|
1287
|
+
"subCategory" : {
|
|
1288
|
+
"type" : "string",
|
|
1289
|
+
"description" : "A specific category that contains more specific detail about the error"
|
|
1290
|
+
}
|
|
1291
|
+
}
|
|
1292
|
+
},
|
|
1293
|
+
"Filter" : {
|
|
1294
|
+
"required" : [ "operator", "propertyName" ],
|
|
1295
|
+
"type" : "object",
|
|
1296
|
+
"properties" : {
|
|
1297
|
+
"highValue" : {
|
|
1298
|
+
"type" : "string",
|
|
1299
|
+
"description" : "The upper boundary value when using ranged-based filters."
|
|
1300
|
+
},
|
|
1301
|
+
"operator" : {
|
|
1302
|
+
"type" : "string",
|
|
1303
|
+
"description" : "null",
|
|
1304
|
+
"enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ]
|
|
1305
|
+
},
|
|
1306
|
+
"propertyName" : {
|
|
1307
|
+
"type" : "string",
|
|
1308
|
+
"description" : "The name of the property to apply the filter to."
|
|
1309
|
+
},
|
|
1310
|
+
"value" : {
|
|
1311
|
+
"type" : "string",
|
|
1312
|
+
"description" : "The value to match against the property."
|
|
1313
|
+
},
|
|
1314
|
+
"values" : {
|
|
1315
|
+
"type" : "array",
|
|
1316
|
+
"description" : "The values to match against the property.",
|
|
1317
|
+
"items" : {
|
|
1318
|
+
"type" : "string"
|
|
1319
|
+
}
|
|
1320
|
+
}
|
|
1321
|
+
},
|
|
1322
|
+
"description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. "
|
|
1323
|
+
},
|
|
1324
|
+
"FilterGroup" : {
|
|
1325
|
+
"required" : [ "filters" ],
|
|
1326
|
+
"type" : "object",
|
|
1327
|
+
"properties" : {
|
|
1328
|
+
"filters" : {
|
|
1329
|
+
"type" : "array",
|
|
1330
|
+
"items" : {
|
|
1331
|
+
"$ref" : "#/components/schemas/Filter"
|
|
1332
|
+
}
|
|
1333
|
+
}
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"LabelsBetweenObjectPair" : {
|
|
1337
|
+
"required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ],
|
|
1338
|
+
"type" : "object",
|
|
1339
|
+
"properties" : {
|
|
1340
|
+
"fromObjectId" : {
|
|
1341
|
+
"type" : "string"
|
|
1342
|
+
},
|
|
1343
|
+
"fromObjectTypeId" : {
|
|
1344
|
+
"type" : "string"
|
|
1345
|
+
},
|
|
1346
|
+
"labels" : {
|
|
1347
|
+
"type" : "array",
|
|
1348
|
+
"items" : {
|
|
1349
|
+
"type" : "string"
|
|
1350
|
+
}
|
|
1351
|
+
},
|
|
1352
|
+
"toObjectId" : {
|
|
1353
|
+
"type" : "string"
|
|
1354
|
+
},
|
|
1355
|
+
"toObjectTypeId" : {
|
|
1356
|
+
"type" : "string"
|
|
1357
|
+
}
|
|
1358
|
+
}
|
|
1359
|
+
},
|
|
1360
|
+
"MultiAssociatedObjectWithLabel" : {
|
|
1361
|
+
"required" : [ "associationTypes", "toObjectId" ],
|
|
1362
|
+
"type" : "object",
|
|
1363
|
+
"properties" : {
|
|
1364
|
+
"associationTypes" : {
|
|
1365
|
+
"type" : "array",
|
|
1366
|
+
"items" : {
|
|
1367
|
+
"$ref" : "#/components/schemas/AssociationSpecWithLabel"
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"toObjectId" : {
|
|
1371
|
+
"type" : "string"
|
|
1372
|
+
}
|
|
1373
|
+
}
|
|
1374
|
+
},
|
|
1375
|
+
"NextPage" : {
|
|
1376
|
+
"required" : [ "after" ],
|
|
1377
|
+
"type" : "object",
|
|
1378
|
+
"properties" : {
|
|
1379
|
+
"after" : {
|
|
1380
|
+
"type" : "string",
|
|
1381
|
+
"description" : "A paging cursor token for retrieving subsequent pages."
|
|
1382
|
+
},
|
|
1383
|
+
"link" : {
|
|
1384
|
+
"type" : "string",
|
|
1385
|
+
"description" : "A URL that can be used to retrieve the next page results."
|
|
1386
|
+
}
|
|
1387
|
+
},
|
|
1388
|
+
"description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response",
|
|
1389
|
+
"example" : {
|
|
1390
|
+
"after" : "NTI1Cg%3D%3D",
|
|
1391
|
+
"link" : "?after=NTI1Cg%3D%3D"
|
|
1392
|
+
}
|
|
1393
|
+
},
|
|
1394
|
+
"Paging" : {
|
|
1395
|
+
"type" : "object",
|
|
1396
|
+
"properties" : {
|
|
1397
|
+
"next" : {
|
|
1398
|
+
"$ref" : "#/components/schemas/NextPage"
|
|
1399
|
+
},
|
|
1400
|
+
"prev" : {
|
|
1401
|
+
"$ref" : "#/components/schemas/PreviousPage"
|
|
1402
|
+
}
|
|
1403
|
+
}
|
|
1404
|
+
},
|
|
1405
|
+
"PreviousPage" : {
|
|
1406
|
+
"required" : [ "before" ],
|
|
1407
|
+
"type" : "object",
|
|
1408
|
+
"properties" : {
|
|
1409
|
+
"before" : {
|
|
1410
|
+
"type" : "string",
|
|
1411
|
+
"description" : "A paging cursor token for retrieving previous pages."
|
|
1412
|
+
},
|
|
1413
|
+
"link" : {
|
|
1414
|
+
"type" : "string",
|
|
1415
|
+
"description" : "A URL that can be used to retrieve the previous pages' results."
|
|
1416
|
+
}
|
|
1417
|
+
},
|
|
1418
|
+
"description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response"
|
|
1419
|
+
},
|
|
1420
|
+
"PublicAssociationsForObject" : {
|
|
1421
|
+
"required" : [ "to", "types" ],
|
|
1422
|
+
"type" : "object",
|
|
1423
|
+
"properties" : {
|
|
1424
|
+
"to" : {
|
|
1425
|
+
"$ref" : "#/components/schemas/PublicObjectId"
|
|
1426
|
+
},
|
|
1427
|
+
"types" : {
|
|
1428
|
+
"type" : "array",
|
|
1429
|
+
"items" : {
|
|
1430
|
+
"$ref" : "#/components/schemas/AssociationSpec"
|
|
1431
|
+
}
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
"PublicDefaultAssociation" : {
|
|
1436
|
+
"required" : [ "associationSpec", "from", "to" ],
|
|
1437
|
+
"type" : "object",
|
|
1438
|
+
"properties" : {
|
|
1439
|
+
"associationSpec" : {
|
|
1440
|
+
"$ref" : "#/components/schemas/AssociationSpec"
|
|
1441
|
+
},
|
|
1442
|
+
"from" : {
|
|
1443
|
+
"$ref" : "#/components/schemas/PublicObjectId"
|
|
1444
|
+
},
|
|
1445
|
+
"to" : {
|
|
1446
|
+
"$ref" : "#/components/schemas/PublicObjectId"
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
},
|
|
1450
|
+
"PublicGdprDeleteInput" : {
|
|
1451
|
+
"required" : [ "objectId" ],
|
|
1452
|
+
"type" : "object",
|
|
1453
|
+
"properties" : {
|
|
1454
|
+
"idProperty" : {
|
|
1455
|
+
"type" : "string",
|
|
1456
|
+
"description" : "The name of a unique property, when identifying records by property instead of ID. "
|
|
1457
|
+
},
|
|
1458
|
+
"objectId" : {
|
|
1459
|
+
"type" : "string",
|
|
1460
|
+
"description" : "The ID of the company to delete."
|
|
1461
|
+
}
|
|
1462
|
+
}
|
|
1463
|
+
},
|
|
1464
|
+
"PublicMergeInput" : {
|
|
1465
|
+
"required" : [ "objectIdToMerge", "primaryObjectId" ],
|
|
1466
|
+
"type" : "object",
|
|
1467
|
+
"properties" : {
|
|
1468
|
+
"objectIdToMerge" : {
|
|
1469
|
+
"type" : "string",
|
|
1470
|
+
"description" : "The ID of the company to merge into the primary."
|
|
1471
|
+
},
|
|
1472
|
+
"primaryObjectId" : {
|
|
1473
|
+
"type" : "string",
|
|
1474
|
+
"description" : "The ID of the primary company, which the other will merge into."
|
|
1475
|
+
}
|
|
1476
|
+
}
|
|
1477
|
+
},
|
|
1478
|
+
"PublicObjectId" : {
|
|
1479
|
+
"required" : [ "id" ],
|
|
1480
|
+
"type" : "object",
|
|
1481
|
+
"properties" : {
|
|
1482
|
+
"id" : {
|
|
1483
|
+
"type" : "string",
|
|
1484
|
+
"description" : "The ID of the target record to associate."
|
|
1485
|
+
}
|
|
1486
|
+
}
|
|
1487
|
+
},
|
|
1488
|
+
"PublicObjectSearchRequest" : {
|
|
1489
|
+
"required" : [ "after", "filterGroups", "limit", "properties", "sorts" ],
|
|
1490
|
+
"type" : "object",
|
|
1491
|
+
"properties" : {
|
|
1492
|
+
"after" : {
|
|
1493
|
+
"type" : "string",
|
|
1494
|
+
"description" : "A paging cursor token for retrieving subsequent pages."
|
|
1495
|
+
},
|
|
1496
|
+
"filterGroups" : {
|
|
1497
|
+
"type" : "array",
|
|
1498
|
+
"description" : "Up to 6 groups of filters defining additional query criteria.",
|
|
1499
|
+
"items" : {
|
|
1500
|
+
"$ref" : "#/components/schemas/FilterGroup"
|
|
1501
|
+
}
|
|
1502
|
+
},
|
|
1503
|
+
"limit" : {
|
|
1504
|
+
"type" : "integer",
|
|
1505
|
+
"description" : "The maximum results to return, up to 200 objects.",
|
|
1506
|
+
"format" : "int32"
|
|
1507
|
+
},
|
|
1508
|
+
"properties" : {
|
|
1509
|
+
"type" : "array",
|
|
1510
|
+
"description" : "A list of property names to include in the response.",
|
|
1511
|
+
"items" : {
|
|
1512
|
+
"type" : "string"
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1515
|
+
"query" : {
|
|
1516
|
+
"type" : "string",
|
|
1517
|
+
"description" : "The search query string, up to 3000 characters."
|
|
1518
|
+
},
|
|
1519
|
+
"sorts" : {
|
|
1520
|
+
"type" : "array",
|
|
1521
|
+
"description" : "Specifies sorting order based on object properties.",
|
|
1522
|
+
"items" : {
|
|
1523
|
+
"type" : "string"
|
|
1524
|
+
}
|
|
1525
|
+
}
|
|
1526
|
+
},
|
|
1527
|
+
"description" : "Describes a search request"
|
|
1528
|
+
},
|
|
1529
|
+
"SimplePublicObject" : {
|
|
1530
|
+
"required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ],
|
|
1531
|
+
"type" : "object",
|
|
1532
|
+
"properties" : {
|
|
1533
|
+
"archived" : {
|
|
1534
|
+
"type" : "boolean",
|
|
1535
|
+
"description" : "Whether the object is archived."
|
|
1536
|
+
},
|
|
1537
|
+
"archivedAt" : {
|
|
1538
|
+
"type" : "string",
|
|
1539
|
+
"description" : "The timestamp when the object was archived, in ISO 8601 format.",
|
|
1540
|
+
"format" : "date-time"
|
|
1541
|
+
},
|
|
1542
|
+
"createdAt" : {
|
|
1543
|
+
"type" : "string",
|
|
1544
|
+
"description" : "The timestamp when the object was created, in ISO 8601 format.",
|
|
1545
|
+
"format" : "date-time"
|
|
1546
|
+
},
|
|
1547
|
+
"id" : {
|
|
1548
|
+
"type" : "string",
|
|
1549
|
+
"description" : "The unique ID of the object."
|
|
1550
|
+
},
|
|
1551
|
+
"objectWriteTraceId" : {
|
|
1552
|
+
"type" : "string"
|
|
1553
|
+
},
|
|
1554
|
+
"properties" : {
|
|
1555
|
+
"type" : "object",
|
|
1556
|
+
"additionalProperties" : {
|
|
1557
|
+
"type" : "string",
|
|
1558
|
+
"nullable" : true
|
|
1559
|
+
},
|
|
1560
|
+
"description" : "Key-value pairs representing the properties of the object."
|
|
1561
|
+
},
|
|
1562
|
+
"propertiesWithHistory" : {
|
|
1563
|
+
"type" : "object",
|
|
1564
|
+
"additionalProperties" : {
|
|
1565
|
+
"type" : "array",
|
|
1566
|
+
"items" : {
|
|
1567
|
+
"$ref" : "#/components/schemas/ValueWithTimestamp"
|
|
1568
|
+
}
|
|
1569
|
+
},
|
|
1570
|
+
"description" : "Key-value pairs representing the properties of the object along with their history."
|
|
1571
|
+
},
|
|
1572
|
+
"updatedAt" : {
|
|
1573
|
+
"type" : "string",
|
|
1574
|
+
"description" : "The timestamp when the object was last updated, in ISO 8601 format.",
|
|
1575
|
+
"format" : "date-time"
|
|
1576
|
+
},
|
|
1577
|
+
"url" : {
|
|
1578
|
+
"type" : "string"
|
|
1579
|
+
}
|
|
1580
|
+
},
|
|
1581
|
+
"description" : "A simple public object.",
|
|
1582
|
+
"example" : {
|
|
1583
|
+
"archived" : false,
|
|
1584
|
+
"createdAt" : "2019-10-30T03:30:17.883Z",
|
|
1585
|
+
"id" : "512",
|
|
1586
|
+
"properties" : {
|
|
1587
|
+
"property_checkbox" : "false",
|
|
1588
|
+
"property_date" : "1572480000000",
|
|
1589
|
+
"property_dropdown" : "choice_b",
|
|
1590
|
+
"property_multiple_checkboxes" : "chocolate;strawberry",
|
|
1591
|
+
"property_number" : "17",
|
|
1592
|
+
"property_radio" : "option_1",
|
|
1593
|
+
"property_string" : "value"
|
|
1594
|
+
},
|
|
1595
|
+
"updatedAt" : "2019-12-07T16:50:06.678Z"
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
"SimplePublicObjectBatchInput" : {
|
|
1599
|
+
"required" : [ "id", "properties" ],
|
|
1600
|
+
"type" : "object",
|
|
1601
|
+
"properties" : {
|
|
1602
|
+
"id" : {
|
|
1603
|
+
"type" : "string",
|
|
1604
|
+
"description" : "The ID to be updated. This can be the object ID, or the unique property value of the `idProperty` property."
|
|
1605
|
+
},
|
|
1606
|
+
"idProperty" : {
|
|
1607
|
+
"type" : "string",
|
|
1608
|
+
"description" : "The name of a property whose values are unique for this object",
|
|
1609
|
+
"example" : "my_unique_property_name"
|
|
1610
|
+
},
|
|
1611
|
+
"objectWriteTraceId" : {
|
|
1612
|
+
"type" : "string",
|
|
1613
|
+
"description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)."
|
|
1614
|
+
},
|
|
1615
|
+
"properties" : {
|
|
1616
|
+
"type" : "object",
|
|
1617
|
+
"additionalProperties" : {
|
|
1618
|
+
"type" : "string"
|
|
1619
|
+
},
|
|
1620
|
+
"description" : "The company property values to set."
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties."
|
|
1624
|
+
},
|
|
1625
|
+
"SimplePublicObjectBatchInputForCreate" : {
|
|
1626
|
+
"required" : [ "associations", "properties" ],
|
|
1627
|
+
"type" : "object",
|
|
1628
|
+
"properties" : {
|
|
1629
|
+
"associations" : {
|
|
1630
|
+
"type" : "array",
|
|
1631
|
+
"items" : {
|
|
1632
|
+
"$ref" : "#/components/schemas/PublicAssociationsForObject"
|
|
1633
|
+
}
|
|
1634
|
+
},
|
|
1635
|
+
"objectWriteTraceId" : {
|
|
1636
|
+
"type" : "string"
|
|
1637
|
+
},
|
|
1638
|
+
"properties" : {
|
|
1639
|
+
"type" : "object",
|
|
1640
|
+
"additionalProperties" : {
|
|
1641
|
+
"type" : "string"
|
|
1642
|
+
}
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"SimplePublicObjectBatchInputUpsert" : {
|
|
1647
|
+
"required" : [ "id", "properties" ],
|
|
1648
|
+
"type" : "object",
|
|
1649
|
+
"properties" : {
|
|
1650
|
+
"id" : {
|
|
1651
|
+
"type" : "string",
|
|
1652
|
+
"description" : "The ID of the company to update."
|
|
1653
|
+
},
|
|
1654
|
+
"idProperty" : {
|
|
1655
|
+
"type" : "string",
|
|
1656
|
+
"description" : "The name of a property whose values are unique for this object"
|
|
1657
|
+
},
|
|
1658
|
+
"objectWriteTraceId" : {
|
|
1659
|
+
"type" : "string",
|
|
1660
|
+
"description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)."
|
|
1661
|
+
},
|
|
1662
|
+
"properties" : {
|
|
1663
|
+
"type" : "object",
|
|
1664
|
+
"additionalProperties" : {
|
|
1665
|
+
"type" : "string"
|
|
1666
|
+
},
|
|
1667
|
+
"description" : "The company property values to set."
|
|
1668
|
+
}
|
|
1669
|
+
},
|
|
1670
|
+
"description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID."
|
|
1671
|
+
},
|
|
1672
|
+
"SimplePublicObjectId" : {
|
|
1673
|
+
"required" : [ "id" ],
|
|
1674
|
+
"type" : "object",
|
|
1675
|
+
"properties" : {
|
|
1676
|
+
"id" : {
|
|
1677
|
+
"type" : "string"
|
|
1678
|
+
}
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
"SimplePublicObjectInput" : {
|
|
1682
|
+
"required" : [ "properties" ],
|
|
1683
|
+
"type" : "object",
|
|
1684
|
+
"properties" : {
|
|
1685
|
+
"properties" : {
|
|
1686
|
+
"type" : "object",
|
|
1687
|
+
"additionalProperties" : {
|
|
1688
|
+
"type" : "string"
|
|
1689
|
+
},
|
|
1690
|
+
"description" : "The company property values to set."
|
|
1691
|
+
}
|
|
1692
|
+
},
|
|
1693
|
+
"description" : "Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.",
|
|
1694
|
+
"example" : {
|
|
1695
|
+
"properties" : {
|
|
1696
|
+
"property_checkbox" : "false",
|
|
1697
|
+
"property_date" : "1572480000000",
|
|
1698
|
+
"property_dropdown" : "choice_b",
|
|
1699
|
+
"property_multiple_checkboxes" : "chocolate;strawberry",
|
|
1700
|
+
"property_number" : "17",
|
|
1701
|
+
"property_radio" : "option_1",
|
|
1702
|
+
"property_string" : "value"
|
|
1703
|
+
}
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
"SimplePublicObjectInputForCreate" : {
|
|
1707
|
+
"required" : [ "associations", "properties" ],
|
|
1708
|
+
"type" : "object",
|
|
1709
|
+
"properties" : {
|
|
1710
|
+
"associations" : {
|
|
1711
|
+
"type" : "array",
|
|
1712
|
+
"items" : {
|
|
1713
|
+
"$ref" : "#/components/schemas/PublicAssociationsForObject"
|
|
1714
|
+
}
|
|
1715
|
+
},
|
|
1716
|
+
"properties" : {
|
|
1717
|
+
"type" : "object",
|
|
1718
|
+
"additionalProperties" : {
|
|
1719
|
+
"type" : "string"
|
|
1720
|
+
},
|
|
1721
|
+
"description" : "The company property values to set."
|
|
1722
|
+
}
|
|
1723
|
+
},
|
|
1724
|
+
"description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects."
|
|
1725
|
+
},
|
|
1726
|
+
"SimplePublicObjectWithAssociations" : {
|
|
1727
|
+
"required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ],
|
|
1728
|
+
"type" : "object",
|
|
1729
|
+
"properties" : {
|
|
1730
|
+
"archived" : {
|
|
1731
|
+
"type" : "boolean",
|
|
1732
|
+
"description" : "Whether the object is archived."
|
|
1733
|
+
},
|
|
1734
|
+
"archivedAt" : {
|
|
1735
|
+
"type" : "string",
|
|
1736
|
+
"description" : "The timestamp when the object was archived, in ISO 8601 format.",
|
|
1737
|
+
"format" : "date-time"
|
|
1738
|
+
},
|
|
1739
|
+
"associations" : {
|
|
1740
|
+
"type" : "object",
|
|
1741
|
+
"additionalProperties" : {
|
|
1742
|
+
"$ref" : "#/components/schemas/CollectionResponseAssociatedId"
|
|
1743
|
+
},
|
|
1744
|
+
"description" : "A list defining relationships with other objects."
|
|
1745
|
+
},
|
|
1746
|
+
"createdAt" : {
|
|
1747
|
+
"type" : "string",
|
|
1748
|
+
"description" : "The timestamp when the object was created, in ISO 8601 format.",
|
|
1749
|
+
"format" : "date-time"
|
|
1750
|
+
},
|
|
1751
|
+
"id" : {
|
|
1752
|
+
"type" : "string",
|
|
1753
|
+
"description" : "The unique ID of the object."
|
|
1754
|
+
},
|
|
1755
|
+
"objectWriteTraceId" : {
|
|
1756
|
+
"type" : "string"
|
|
1757
|
+
},
|
|
1758
|
+
"properties" : {
|
|
1759
|
+
"type" : "object",
|
|
1760
|
+
"additionalProperties" : {
|
|
1761
|
+
"type" : "string",
|
|
1762
|
+
"nullable" : true
|
|
1763
|
+
},
|
|
1764
|
+
"description" : "Key value pairs representing the properties of the object."
|
|
1765
|
+
},
|
|
1766
|
+
"propertiesWithHistory" : {
|
|
1767
|
+
"type" : "object",
|
|
1768
|
+
"additionalProperties" : {
|
|
1769
|
+
"type" : "array",
|
|
1770
|
+
"items" : {
|
|
1771
|
+
"$ref" : "#/components/schemas/ValueWithTimestamp"
|
|
1772
|
+
}
|
|
1773
|
+
},
|
|
1774
|
+
"description" : "Key-value pairs representing the properties of the object along with their history."
|
|
1775
|
+
},
|
|
1776
|
+
"updatedAt" : {
|
|
1777
|
+
"type" : "string",
|
|
1778
|
+
"description" : "The timestamp when the object was last updated, in ISO 8601 format.",
|
|
1779
|
+
"format" : "date-time"
|
|
1780
|
+
},
|
|
1781
|
+
"url" : {
|
|
1782
|
+
"type" : "string"
|
|
1783
|
+
}
|
|
1784
|
+
},
|
|
1785
|
+
"description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type."
|
|
1786
|
+
},
|
|
1787
|
+
"SimplePublicUpsertObject" : {
|
|
1788
|
+
"required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ],
|
|
1789
|
+
"type" : "object",
|
|
1790
|
+
"properties" : {
|
|
1791
|
+
"archived" : {
|
|
1792
|
+
"type" : "boolean",
|
|
1793
|
+
"description" : "Whether the object is archived."
|
|
1794
|
+
},
|
|
1795
|
+
"archivedAt" : {
|
|
1796
|
+
"type" : "string",
|
|
1797
|
+
"description" : "The timestamp when the object was archived, in ISO 8601 format.",
|
|
1798
|
+
"format" : "date-time"
|
|
1799
|
+
},
|
|
1800
|
+
"createdAt" : {
|
|
1801
|
+
"type" : "string",
|
|
1802
|
+
"description" : "The timestamp when the object was created, in ISO 8601 format.",
|
|
1803
|
+
"format" : "date-time"
|
|
1804
|
+
},
|
|
1805
|
+
"id" : {
|
|
1806
|
+
"type" : "string",
|
|
1807
|
+
"description" : "The unique ID of the object."
|
|
1808
|
+
},
|
|
1809
|
+
"new" : {
|
|
1810
|
+
"type" : "boolean",
|
|
1811
|
+
"description" : "Whether the property is new."
|
|
1812
|
+
},
|
|
1813
|
+
"objectWriteTraceId" : {
|
|
1814
|
+
"type" : "string"
|
|
1815
|
+
},
|
|
1816
|
+
"properties" : {
|
|
1817
|
+
"type" : "object",
|
|
1818
|
+
"additionalProperties" : {
|
|
1819
|
+
"type" : "string"
|
|
1820
|
+
},
|
|
1821
|
+
"description" : "Key value pairs representing the properties of the object."
|
|
1822
|
+
},
|
|
1823
|
+
"propertiesWithHistory" : {
|
|
1824
|
+
"type" : "object",
|
|
1825
|
+
"additionalProperties" : {
|
|
1826
|
+
"type" : "array",
|
|
1827
|
+
"items" : {
|
|
1828
|
+
"$ref" : "#/components/schemas/ValueWithTimestamp"
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
"description" : "Key-value pairs representing the properties of the object along with their history."
|
|
1832
|
+
},
|
|
1833
|
+
"updatedAt" : {
|
|
1834
|
+
"type" : "string",
|
|
1835
|
+
"description" : "The timestamp when the object was last updated, in ISO 8601 format.",
|
|
1836
|
+
"format" : "date-time"
|
|
1837
|
+
},
|
|
1838
|
+
"url" : {
|
|
1839
|
+
"type" : "string"
|
|
1840
|
+
}
|
|
1841
|
+
},
|
|
1842
|
+
"description" : "Represents a CRM object that has either been created or updated (upserted)"
|
|
1843
|
+
},
|
|
1844
|
+
"StandardError" : {
|
|
1845
|
+
"required" : [ "category", "context", "errors", "links", "message", "status" ],
|
|
1846
|
+
"type" : "object",
|
|
1847
|
+
"properties" : {
|
|
1848
|
+
"category" : {
|
|
1849
|
+
"type" : "string",
|
|
1850
|
+
"description" : "The main category of the error."
|
|
1851
|
+
},
|
|
1852
|
+
"context" : {
|
|
1853
|
+
"type" : "object",
|
|
1854
|
+
"additionalProperties" : {
|
|
1855
|
+
"type" : "array",
|
|
1856
|
+
"items" : {
|
|
1857
|
+
"type" : "string"
|
|
1858
|
+
}
|
|
1859
|
+
},
|
|
1860
|
+
"description" : "Additional context-specific information related to the error."
|
|
1861
|
+
},
|
|
1862
|
+
"errors" : {
|
|
1863
|
+
"type" : "array",
|
|
1864
|
+
"description" : "The detailed error objects.",
|
|
1865
|
+
"items" : {
|
|
1866
|
+
"$ref" : "#/components/schemas/ErrorDetail"
|
|
1867
|
+
}
|
|
1868
|
+
},
|
|
1869
|
+
"id" : {
|
|
1870
|
+
"type" : "string",
|
|
1871
|
+
"description" : "A unique ID for the error instance."
|
|
1872
|
+
},
|
|
1873
|
+
"links" : {
|
|
1874
|
+
"type" : "object",
|
|
1875
|
+
"additionalProperties" : {
|
|
1876
|
+
"type" : "string"
|
|
1877
|
+
},
|
|
1878
|
+
"description" : "URLs linking to documentation or resources associated with the error."
|
|
1879
|
+
},
|
|
1880
|
+
"message" : {
|
|
1881
|
+
"type" : "string",
|
|
1882
|
+
"description" : "A human-readable string describing the error and possible remediation steps."
|
|
1883
|
+
},
|
|
1884
|
+
"status" : {
|
|
1885
|
+
"type" : "string",
|
|
1886
|
+
"description" : "The HTTP status code associated with the error."
|
|
1887
|
+
},
|
|
1888
|
+
"subCategory" : {
|
|
1889
|
+
"type" : "object",
|
|
1890
|
+
"properties" : { },
|
|
1891
|
+
"description" : "A more specific error category within each main category."
|
|
1892
|
+
}
|
|
1893
|
+
},
|
|
1894
|
+
"description" : "Ye olde error"
|
|
1895
|
+
},
|
|
1896
|
+
"ValueWithTimestamp" : {
|
|
1897
|
+
"required" : [ "sourceType", "timestamp", "value" ],
|
|
1898
|
+
"type" : "object",
|
|
1899
|
+
"properties" : {
|
|
1900
|
+
"sourceId" : {
|
|
1901
|
+
"type" : "string",
|
|
1902
|
+
"description" : "The unique ID of the property."
|
|
1903
|
+
},
|
|
1904
|
+
"sourceLabel" : {
|
|
1905
|
+
"type" : "string",
|
|
1906
|
+
"description" : "A human-readable label."
|
|
1907
|
+
},
|
|
1908
|
+
"sourceType" : {
|
|
1909
|
+
"type" : "string",
|
|
1910
|
+
"description" : "The property type."
|
|
1911
|
+
},
|
|
1912
|
+
"timestamp" : {
|
|
1913
|
+
"type" : "string",
|
|
1914
|
+
"description" : "The timestamp when the property was updated, in ISO 8601 format.",
|
|
1915
|
+
"format" : "date-time"
|
|
1916
|
+
},
|
|
1917
|
+
"updatedByUserId" : {
|
|
1918
|
+
"type" : "integer",
|
|
1919
|
+
"description" : "The ID of the user who last updated the property.",
|
|
1920
|
+
"format" : "int32"
|
|
1921
|
+
},
|
|
1922
|
+
"value" : {
|
|
1923
|
+
"type" : "string",
|
|
1924
|
+
"description" : "The property value."
|
|
1925
|
+
}
|
|
1926
|
+
},
|
|
1927
|
+
"description" : "Property model that includes timestamp."
|
|
1928
|
+
}
|
|
1929
|
+
},
|
|
1930
|
+
"responses" : {
|
|
1931
|
+
"Error" : {
|
|
1932
|
+
"description" : "An error occurred.",
|
|
1933
|
+
"content" : {
|
|
1934
|
+
"*/*" : {
|
|
1935
|
+
"schema" : {
|
|
1936
|
+
"$ref" : "#/components/schemas/Error"
|
|
1937
|
+
}
|
|
1938
|
+
}
|
|
1939
|
+
}
|
|
1940
|
+
}
|
|
1941
|
+
},
|
|
1942
|
+
"securitySchemes" : {
|
|
1943
|
+
"oauth2" : {
|
|
1944
|
+
"type" : "oauth2",
|
|
1945
|
+
"flows" : {
|
|
1946
|
+
"authorizationCode" : {
|
|
1947
|
+
"authorizationUrl" : "https://app.hubspot.com/oauth/authorize",
|
|
1948
|
+
"tokenUrl" : "https://api.hubapi.com/oauth/v1/token",
|
|
1949
|
+
"scopes" : {
|
|
1950
|
+
"crm.objects.appointments.read" : "Read appointments",
|
|
1951
|
+
"crm.objects.appointments.sensitive.read.v2" : "Read appointments (sensitive)",
|
|
1952
|
+
"crm.objects.appointments.sensitive.write.v2" : "Write appointments (sensitive)",
|
|
1953
|
+
"crm.objects.appointments.write" : "Write appointments",
|
|
1954
|
+
"crm.objects.carts.read" : "Read carts",
|
|
1955
|
+
"crm.objects.carts.write" : "Write cart",
|
|
1956
|
+
"crm.objects.commercepayments.read" : "Read the COMMERCE_PAYMENT object.",
|
|
1957
|
+
"crm.objects.commercepayments.write" : "Write commerce payments",
|
|
1958
|
+
"crm.objects.companies.highly_sensitive.read.v2" : "View company records (highly-sensitive)",
|
|
1959
|
+
"crm.objects.companies.highly_sensitive.write.v2" : "Change company records (highly-sensitive)",
|
|
1960
|
+
"crm.objects.companies.read" : "Create or update company records",
|
|
1961
|
+
"crm.objects.companies.sensitive.read.v2" : "View sensitive properties on company records",
|
|
1962
|
+
"crm.objects.companies.sensitive.write.v2" : "Create or update sensitive properties on company records",
|
|
1963
|
+
"crm.objects.companies.write" : "View company records",
|
|
1964
|
+
"crm.objects.contacts.highly_sensitive.read.v2" : "View contact records (highly-sensitive)",
|
|
1965
|
+
"crm.objects.contacts.highly_sensitive.write.v2" : "Change contact records (highly-sensitive)",
|
|
1966
|
+
"crm.objects.contacts.read" : "View contact records",
|
|
1967
|
+
"crm.objects.contacts.sensitive.read.v2" : "View sensitive properties on contact records",
|
|
1968
|
+
"crm.objects.contacts.sensitive.write.v2" : "Create or update sensitive properties on contact records",
|
|
1969
|
+
"crm.objects.contacts.write" : "Create or update contact records",
|
|
1970
|
+
"crm.objects.courses.read" : "Read courses",
|
|
1971
|
+
"crm.objects.courses.write" : "Write courses",
|
|
1972
|
+
"crm.objects.custom.highly_sensitive.read.v2" : "View custom object records (highly-sensitive)",
|
|
1973
|
+
"crm.objects.custom.highly_sensitive.write.v2" : "Change custom object records (highly-sensitive)",
|
|
1974
|
+
"crm.objects.custom.read" : "View custom object records",
|
|
1975
|
+
"crm.objects.custom.sensitive.read.v2" : "View custom object records (sensitive)",
|
|
1976
|
+
"crm.objects.custom.sensitive.write.v2" : "Change custom object records (sensitive)",
|
|
1977
|
+
"crm.objects.custom.write" : "Change custom object records",
|
|
1978
|
+
"crm.objects.deals.highly_sensitive.read.v2" : "View deal records (highly-sensitive)",
|
|
1979
|
+
"crm.objects.deals.highly_sensitive.write.v2" : "Change deal records (highly-sensitive)",
|
|
1980
|
+
"crm.objects.deals.read" : "View deal records",
|
|
1981
|
+
"crm.objects.deals.sensitive.read.v2" : "View sensitive properties on deal records",
|
|
1982
|
+
"crm.objects.deals.sensitive.write.v2" : "Create or update sensitive properties on deal records",
|
|
1983
|
+
"crm.objects.deals.write" : "Create or update deal records",
|
|
1984
|
+
"crm.objects.goals.read" : "Read goals",
|
|
1985
|
+
"crm.objects.goals.write" : "Write goals",
|
|
1986
|
+
"crm.objects.invoices.read" : "Read invoices objects",
|
|
1987
|
+
"crm.objects.invoices.write" : "Write invoices",
|
|
1988
|
+
"crm.objects.leads.read" : "Read lead objects",
|
|
1989
|
+
"crm.objects.leads.write" : "Modify lead objects",
|
|
1990
|
+
"crm.objects.line_items.read" : "Line Items",
|
|
1991
|
+
"crm.objects.line_items.write" : "Line Items",
|
|
1992
|
+
"crm.objects.listings.read" : "Read listings",
|
|
1993
|
+
"crm.objects.listings.write" : "Write listings",
|
|
1994
|
+
"crm.objects.orders.read" : "Read Orders",
|
|
1995
|
+
"crm.objects.orders.write" : "Write orders",
|
|
1996
|
+
"crm.objects.partner-clients.read" : "View Partner Client CRM objects",
|
|
1997
|
+
"crm.objects.partner-clients.write" : "Modify Partner Client CRM objects",
|
|
1998
|
+
"crm.objects.partner-services.read" : "View Partner Service CRM objects",
|
|
1999
|
+
"crm.objects.partner-services.write" : "Modify Partner Service CRM objects",
|
|
2000
|
+
"crm.objects.products.read" : "Read from my Product Library",
|
|
2001
|
+
"crm.objects.products.write" : "Write to my Product Library",
|
|
2002
|
+
"crm.objects.projects.highly_sensitive.read" : "Read projects (highly-sensitive)",
|
|
2003
|
+
"crm.objects.projects.highly_sensitive.write" : "Write projects (highly-sensitive)",
|
|
2004
|
+
"crm.objects.projects.read" : "Read projects",
|
|
2005
|
+
"crm.objects.projects.sensitive.read" : "Read projects (sensitive)",
|
|
2006
|
+
"crm.objects.projects.sensitive.write" : "Write projects (sensitive)",
|
|
2007
|
+
"crm.objects.projects.write" : "Write projects",
|
|
2008
|
+
"crm.objects.quotes.read" : "Quotes",
|
|
2009
|
+
"crm.objects.quotes.write" : "Quotes",
|
|
2010
|
+
"crm.objects.services.read" : "Read services",
|
|
2011
|
+
"crm.objects.services.write" : "Write services",
|
|
2012
|
+
"crm.objects.subscriptions.read" : "Read Commerce Subscriptions",
|
|
2013
|
+
"crm.objects.subscriptions.write" : "Write to Commerce Subscriptions",
|
|
2014
|
+
"crm.objects.users.read" : "Read User CRM objects",
|
|
2015
|
+
"crm.objects.users.write" : "Write User CRM objects",
|
|
2016
|
+
"e-commerce" : "e-commerce",
|
|
2017
|
+
"media_bridge.read" : "Read media and media events",
|
|
2018
|
+
"oauth" : "User and Account Information",
|
|
2019
|
+
"tickets" : "Read and write tickets",
|
|
2020
|
+
"tickets.highly_sensitive.v2" : "Tickets (highly-sensitive)",
|
|
2021
|
+
"tickets.sensitive.v2" : "Tickets (sensitive)"
|
|
2022
|
+
}
|
|
2023
|
+
}
|
|
2024
|
+
}
|
|
2025
|
+
},
|
|
2026
|
+
"private_apps" : {
|
|
2027
|
+
"type" : "apiKey",
|
|
2028
|
+
"name" : "private-app",
|
|
2029
|
+
"in" : "header"
|
|
2030
|
+
},
|
|
2031
|
+
"private_apps_legacy" : {
|
|
2032
|
+
"type" : "apiKey",
|
|
2033
|
+
"name" : "private-app-legacy",
|
|
2034
|
+
"in" : "header"
|
|
2035
|
+
}
|
|
2036
|
+
}
|
|
2037
|
+
},
|
|
2038
|
+
"x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ],
|
|
2039
|
+
"x-hubspot-product-tier-requirements" : {
|
|
2040
|
+
"marketing" : "FREE",
|
|
2041
|
+
"sales" : "FREE",
|
|
2042
|
+
"service" : "FREE",
|
|
2043
|
+
"cms" : "FREE",
|
|
2044
|
+
"commerce" : "FREE",
|
|
2045
|
+
"crmHub" : "FREE",
|
|
2046
|
+
"dataHub" : "FREE"
|
|
2047
|
+
}
|
|
2048
|
+
}
|