RevKeenDocs
StatusSupport
API Reference

Update sync state

Update or create sync state for a specific resource type. Used by worker after sync jobs. --- **Related endpoints** - `GET /sync-state/{source}/{merchantId}` — Get sync states for integration **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

PUT
/sync-state/{source}/{merchantId}/{resourceType}

Update or create sync state for a specific resource type. Used by worker after sync jobs.

Related endpoints

  • GET /sync-state/{source}/{merchantId} — Get sync states for integration

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 403 authorization_error — the caller is identified but the action is denied. Codes include insufficient_permissions, ip_not_allowed, merchant_mismatch, and origin_not_allowed.
  • 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

source*string

Integration source (e.g., practicehub, wodify)

merchantId*string

Merchant ID

Formatuuid
resourceType*string

Resource type (e.g., members, products, payments)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X PUT "https://api.revkeen.com/v2/sync-state/practicehub/00000000-0000-0000-0000-000000000000/members" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lastSyncAt": "2026-01-01T00:00:00Z",
    "lastSyncStatus": "idle",
    "lastSyncError": null,
    "cursor": null,
    "itemsSynced": 0,
    "leaseOwner": "string",
    "leaseToken": "string"
  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",    "provider": "string",    "resource_type": "string",    "last_sync_at": "2019-08-24T14:15:22Z",    "last_sync_status": "idle",    "last_sync_error": "string",    "cursor": "string",    "items_synced": 0,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "created": true}

Get sync states for integration GET

Get all sync states for a specific integration (by provider and merchant). --- **Related endpoints** - `PUT /sync-state/{source}/{merchantId}/{resourceType}` — Update sync state **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Retrieve a terminal device GET

Get a terminal device by ID, including its current status and heartbeat information. --- **Related endpoints** - `GET /terminal-devices` — List terminal devices **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.