RevKeen Docs
Api reference

Upsert product by external ID

Create or update a product by external system ID. Uses stale update protection.


Related endpoints

  • GET /products — List products
  • POST /products — Create product
  • GET /products/{id} — Get product by ID
  • PATCH /products/{id} — Update product
  • PUT /products/external/batch — Batch upsert products by external ID

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 403 permission_denied — key lacks the required scope, or the resource belongs to a different merchant.
  • 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.

PUT
/products/external/{source}/{externalId}
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

source*string

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

externalId*string

External system's product ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://api.revkeen.com/v2/products/external/practicehub/prod_12345" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Monthly Membership",    "amountCents": 9900  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "name": "string",
    "description": "string",
    "kind": "subscription",
    "amountCents": 0,
    "currency": "string",
    "isActive": true,
    "externalId": "string",
    "externalSystem": "string",
    "externalRef": "string",
    "interval": "string",
    "intervalCount": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "created": true,
  "skipped": true
}
Empty
Empty
Empty