Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Events

Record contact events in a batch (Preview)

Preview · Available to selected organizations. Validates the full request shape, contact references, and event names before processing.

POST
/v1/events/batch

Validates the full request shape, contact references, and event names before processing. A schema failure rejects the entire batch without writes. Between 1 and 100 valid entries are then processed in input order, with independent indexed results for properties limits, contact resolution, and idempotency.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

events*array<>
Items1 <= items <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/events/batch" \  -H "Content-Type: application/json" \  -d '{    "events": [      {        "contact": {          "id": "string"        },        "name": "string"      }    ]  }'
{  "total": -9007199254740991,  "accepted": -9007199254740991,  "errors": -9007199254740991,  "results": [    {      "index": -9007199254740991,      "status": "accepted",      "event": {        "id": "string",        "contactId": "string",        "name": "string",        "source": "api",        "properties": {          "property1": "string",          "property2": "string"        },        "occurredAt": "string",        "recordedAt": "string"      },      "error": "string"    }  ]}

Related documentation

Update a contact

Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key.

Record a contact event (Preview)

Preview · Available to selected organizations. Records a custom contact event. Identify the contact by exactly one ID, external ID, or email.