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
API Reference
CRM
Metadata create object
CRM
Metadata create object
Create custom object schema
POST
/
unified
/
crm
/
metadata
/
objects
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
application/json
Response
200
application/json
Successful response
The response is of type object
.
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>"
}