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
CRM
Upsert account
CRM
Upsert account
POST
/
unified
/
crm
/
account
/
_upsert
curl --request POST \
--url https://api.openint.dev/v0/unified/crm/account/_upsert \
--header 'Content-Type: application/json' \
--header 'x-apikey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '{
"upsert_on": {
"key": "domain",
"values": [
"<string>"
]
},
"record": {
"description": "Integration API",
"industry": "<string>",
"name": "<string>",
"number_of_employees": 123,
"website": "<string>",
"addresses": [
{
"address_type": "primary",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>"
}
],
"phone_numbers": [
{
"phone_number": "<string>",
"phone_number_type": "primary"
}
],
"owner_id": "<string>",
"lifecycle_stage": "subscriber",
"passthrough_fields": {}
}
}'
{
"record": {
"id": "<string>",
"updated_at": "<string>",
"raw_data": {},
"name": "<string>",
"is_deleted": true,
"website": "<string>",
"industry": "<string>",
"number_of_employees": 123,
"owner_id": "<string>",
"created_at": "<string>",
"description": "Integration API",
"last_activity_at": "<string>",
"addresses": [
{
"address_type": "primary",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>"
}
],
"phone_numbers": [
{
"phone_number": "<string>",
"phone_number_type": "primary"
}
],
"lifecycle_stage": "subscriber",
"last_modified_at": "<string>"
}
}
Body
application/json
The key to upsert on. Only website
is supported for Salesforce, while both domain
and website
are supported for Hubspot.
Available options:
domain
, website
The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.
Example:
"Integration API"
Available options:
primary
, mailing
, other
, billing
, shipping
Available options:
subscriber
, lead
, marketingqualifiedlead
, salesqualifiedlead
, opportunity
, customer
, evangelist
, other
Response
200
application/json
Successful response
ISO8601 date string
Example:
"Integration API"
date-time
Available options:
primary
, mailing
, other
, billing
, shipping
Available options:
subscriber
, lead
, marketingqualifiedlead
, salesqualifiedlead
, opportunity
, customer
, evangelist
, other
curl --request POST \
--url https://api.openint.dev/v0/unified/crm/account/_upsert \
--header 'Content-Type: application/json' \
--header 'x-apikey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '{
"upsert_on": {
"key": "domain",
"values": [
"<string>"
]
},
"record": {
"description": "Integration API",
"industry": "<string>",
"name": "<string>",
"number_of_employees": 123,
"website": "<string>",
"addresses": [
{
"address_type": "primary",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>"
}
],
"phone_numbers": [
{
"phone_number": "<string>",
"phone_number_type": "primary"
}
],
"owner_id": "<string>",
"lifecycle_stage": "subscriber",
"passthrough_fields": {}
}
}'
{
"record": {
"id": "<string>",
"updated_at": "<string>",
"raw_data": {},
"name": "<string>",
"is_deleted": true,
"website": "<string>",
"industry": "<string>",
"number_of_employees": 123,
"owner_id": "<string>",
"created_at": "<string>",
"description": "Integration API",
"last_activity_at": "<string>",
"addresses": [
{
"address_type": "primary",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>"
}
],
"phone_numbers": [
{
"phone_number": "<string>",
"phone_number_type": "primary"
}
],
"lifecycle_stage": "subscriber",
"last_modified_at": "<string>"
}
}