Sync Email Activity

Refreshes a sent campaign's activity feed by pulling the latest Sparkpost engagement events and attributed orders into storage. Idempotent: re-running only adds events seen since the last sync. Returns how many rows were added.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Email id, discoverable via list_emails

POST/v1/email/{id}/activity/sync

curl -X POST "https://api.3common.com/v1/email/string/activity/sync" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": {
    "inserted": -9007199254740991,
    "scanned": -9007199254740991,
    "syncedAt": 0
  }
}

TypeScript

export interface Response {
  data: {
    /**
     * Rows newly inserted this sync.
     */
    inserted: number;
    /**
     * Rows considered (Sparkpost events + orders).
     */
    scanned: number;
    /**
     * Sync completion time, epoch ms.
     */
    syncedAt: number;
  };
}