Getting Started
Core Concepts
Core
- PUTUpsert customer
- GETList connections
- POSTCreate connection
- GETGet connection
- DELDelete connection
- PATCHUpdate connection
- POSTCheck connection
- POSTSync connection
- GETAdmin list connector configs
- POSTAdmin upsert connector config
- GETAdmin get connector config
- DELAdmin delete connector config
- PATCHAdmin update connector config
- GETList connector config infos
- GETList pipelines
- POSTCreate pipeline
- DELDelete pipeline
- PATCHUpdate pipeline
- POSTSync pipeline
Sales Engagement
CRM
- GETCount Entities
- GETList Accounts
- POSTCreate account
- GETGet Account
- PATCHUpdate account
- POSTBatch read accounts
- POSTUpsert account
- GETList Contacts
- POSTCreate contact
- GETGet Contact
- PATCHUpdate contact
- POSTBatch read contacts
- POSTUpsert contact
- GETList Leads
- GETGet Lead
- GETList Opportunities
- GETGet Opportunity
- GETList notes
- POSTCreate note
- GETList users
- GETGet user
- GETList custom object records
- POSTCreate custom object record
- GETMetadata list objects
- POSTMetadata create object
- GETMetadata list object properties
- POSTMetadata create object property
- POSTMetadata create association
Accounting
File Storage
Webhooks
Metadata create object
Create custom object schema
curl --request POST \
--url https://api.openint.dev/v0/unified/crm/metadata/objects \
--header 'Content-Type: application/json' \
--header 'x-apikey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"labels": {
"singular": "<string>",
"plural": "<string>"
},
"primary_field_id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"is_required": true,
"default_value": "<string>",
"group_name": "my group",
"type": "text",
"precision": 123,
"scale": 123,
"options": [
{
"label": "Option 1",
"value": "option_1",
"description": "<string>",
"hidden": true
}
],
"raw_details": {}
}
]
}'{
"id": "<string>",
"name": "<string>"
}Body
The machine name of the property as it appears in the third-party Provider. In Salesforce, this must end with __c.
The human-readable name of the property as provided by the third-party Provider.
:::note
picklist and multipicklist property types are currently only supported in Salesforce and Hubspot
:::
:::note
url property type currently is only natively supported in Salesforce.
:::
text, textarea, number, picklist, multipicklist, date, datetime, boolean, url, other A description of the field.
Whether or not this field is required. Must be false for Salesforce boolean fields.
The default value for the property. Only supported for Salesforce.
Only applicable for Hubspot. If specified, OpenInt will attempt to attach the field to this group if it exists, or create it if it doesn't.
"my group"
Only applicable in Salesforce. If not given, will default to 18.
Only applicable in Salesforce. If not given, will default to 0.
curl --request POST \
--url https://api.openint.dev/v0/unified/crm/metadata/objects \
--header 'Content-Type: application/json' \
--header 'x-apikey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"labels": {
"singular": "<string>",
"plural": "<string>"
},
"primary_field_id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"is_required": true,
"default_value": "<string>",
"group_name": "my group",
"type": "text",
"precision": 123,
"scale": 123,
"options": [
{
"label": "Option 1",
"value": "option_1",
"description": "<string>",
"hidden": true
}
],
"raw_details": {}
}
]
}'{
"id": "<string>",
"name": "<string>"
}