Skip to content

Changelog

This page lists changes to the API and to these guides, newest first.

The API is version 1, at /api/v1, and there’s no other version. A change that could break an existing integration would come as a new version at a new path, /api/v2, and be announced here.

  • The guides are published: a quick start, authentication, concepts, sending, batching and deleting records, CSV upload, snapshots, and errors and limits.
  • The API reference is drawn from an OpenAPI description of version 1, which you can download from /docs/api/openapi.json to generate a client. Its “Try it” console sends requests from your browser, with a key that you type into the page.
  • Guides for reading the identity map through its OData feed and in Power BI, and a recipe for connecting Salesforce.
  • 429 Too Many Requests now comes with a Retry-After header: the number of seconds to wait before the key can send again.

The operations in version 1 are:

Operation Call
Create or update a record POST /api/v1/records
Create or update up to 1,000 records POST /api/v1/records/batch
Replace a record PUT /api/v1/records/{recordId} and PUT /api/v1/records/by-source-id/{sourceRecordId}
Delete a record DELETE /api/v1/records/{recordId} and DELETE /api/v1/records/by-source-id/{sourceRecordId}
Read a record GET /api/v1/records/{recordId} and GET /api/v1/records/by-source-id/{sourceRecordId}
Open a snapshot POST /api/v1/snapshots
Add records to a snapshot POST /api/v1/snapshots/{snapshotId}/records
Complete a snapshot POST /api/v1/snapshots/{snapshotId}/complete