Skip to main content
POST
/
v1
/
core
/
integrations
/
connections
Create a new integration connection for a given org
curl --request POST \
  --url https://api.example.com/v1/core/integrations/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "integrationPlatform": "MERGE",
  "externalAccountId": "<string>",
  "isActive": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "externalAccountId": "<string>",
  "organizationId": "<string>",
  "integrationPlatform": "MERGE",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "isActive": true,
  "syncStatus": [
    {
      "id": "<string>",
      "modelName": "<string>",
      "modelSyncStatus": "SYNCING",
      "modelModifiedAfter": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the integration connection

​
integrationPlatform
enum<string>
required

The type of integration connection

Available options:
MERGE,
SIRO_CUSTOM_INPUT,
SERVICE_TITAN,
COMPANY_CAM,
INGAGE,
LEAD_PERFECTION,
SPOTIO
​
externalAccountId
string
required

External account id (typically maps to a tenant)

​
isActive
boolean
default:true

Whether the connection is active

Response

Create a new integration connection for a given org

​
id
string
required
​
name
string
required
​
externalAccountId
string
required
​
organizationId
string
required
​
integrationPlatform
enum<string>
required
Available options:
MERGE,
SIRO_CUSTOM_INPUT,
SERVICE_TITAN,
COMPANY_CAM,
INGAGE,
LEAD_PERFECTION,
SPOTIO
​
createdAt
string
required

ISO 8601 date string

​
updatedAt
string
required

ISO 8601 date string

​
isActive
boolean
required

Whether the integration is actively syncing data

​
syncStatus
object[]
required