Skip to main content
POST
Ingest Records

Authorizations

X-API-Key
string
header
required

Path Parameters

source_type
string
required

External system the records come from: KEDO or 1C.

Body

application/json
payload_type
string
required

Record kind within the source, e.g. PERSONS, EMPLOYEES, DEPARTMENTS, ORGANIZATIONS, JOB_TITLES (KEDO) or EMPLOYEES_FULL, DEPARTMENTS (1C).

records
object[]
required

Records in the schema of the source/payload pair. Each carries an external_id — the object's identifier in the source system, used to match records to existing objects.

source_type
string
required

External system the records come from: KEDO or 1C.

create_missing
boolean

Create objects for records whose external_id is not known yet. When false, unknown records are skipped and only existing objects are updated.

Response

OK

ingest_request_id
string
read-only

Id of the accepted batch. Processing is asynchronous.

record_count
integer<int32>
read-only

Number of records accepted for processing.

status
string
read-only

Always ACCEPTED on a successful submit.