Home
API Reference
Bulk Import

Bulk Import

Business+

Import multiple records at once.

Required scopes: contacts participants

The /contacts endpoint requires the "contacts" scope, the /participants endpoint requires the "participants" scope.

Endpoints

POST


                    /api/v1/bulk-import/contacts

Import contacts

POST


                    /api/v1/bulk-import/participants

Import participants

Request Schema

Parameter	Type	Required	Description
`records`	array	Yes	Array of records to import (max 1000)
`field_mapping`	object	No	Object mapping source field names to target field names
`mode`	string	No	Import mode: create, upsert, or update (default: create)
`match_field`	string	No	Field to match existing records: email or customer_number (default: email)
`skip_on_error`	boolean	No	Whether to skip records with errors and continue (default: true)
`event_key`	string	No	Event key for participant import (required for participants)
`create_contacts`	boolean	No	Whether to create contacts that do not exist during participant import (default: true)

Response Schema

Field	Type
`total`	integer
`created`	integer
`updated`	integer
`skipped`	integer
`contacts_created`	integer
`errors`	array
`details`	array

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/bulk-import" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/bulk-import',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/bulk-import`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

response = requests.get(f'{base_url}/api/v1/bulk-import', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK

{
  "data": {
    "bulk-import_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Calendar