PlanDocket

Massenimport

Business+

Importieren Sie mehrere Datensätze auf einmal.

Erforderliche Bereiche: contacts participants
Der Endpunkt /contacts erfordert den Bereich "contacts", der Endpunkt /participants erfordert den Bereich "participants".

Endpunkte

POST /api/v1/bulk-import/contacts

Kontakte importieren

POST /api/v1/bulk-import/participants

Teilnehmer importieren

Request-Schema

Parameter Typ Erforderlich Beschreibung
records array Ja Array von zu importierenden Datensätzen (max. 1000)
field_mapping object Nein Objekt zur Zuordnung von Quell- zu Zielfeldnamen
mode string Nein Import-Modus: create, upsert oder update (Standard: create)
match_field string Nein Feld zum Abgleich bestehender Datensätze: email oder customer_number (Standard: email)
skip_on_error boolean Nein Ob Datensätze mit Fehlern übersprungen werden sollen (Standard: true)
event_key string Nein Event-Schlüssel für Teilnehmerimport (erforderlich für Teilnehmer)
create_contacts boolean Nein Ob nicht existierende Kontakte beim Teilnehmerimport erstellt werden sollen (Standard: true)

Response-Schema

Feld Typ
total integer
created integer
updated integer
skipped integer
contacts_created integer
errors array
details array

Codebeispiele

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)

Beispiel-Antwort

200 OK
{
  "data": {
    "bulk-import_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
API Version v1.0
Esc zum Schließen