Workestra
API ReferenceEndpoints

Ingest API

Bulk data ingestion endpoint.

The Ingest API allows you to send bulk data to Workestra for processing. This is useful for initial data migration or ongoing sync from external systems.

Ingest Data

POST /api-ingest

Body

{
  "entity_type": "contacts",
  "records": [
    {
      "first_name": "John",
      "last_name": "Smith",
      "email": "john@example.com"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com"
    }
  ]
}

Supported Entity Types

  • contacts — CRM contacts
  • deals — CRM deals
  • issues — Support tickets

Response

{
  "data": {
    "inserted": 2,
    "updated": 0,
    "errors": []
  }
}

Limits

  • Maximum 100 records per request
  • Duplicate detection based on email (contacts) or title (deals/issues)
  • Failed records are returned in the errors array with details

Deduplication

The ingest endpoint checks for existing records:

  • Contacts — Matched by email address
  • Deals — Matched by title + contact
  • Issues — No deduplication (always creates new)

Existing matches are updated rather than duplicated.