RevKeenDocs
StatusSupport
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 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
/products/external/{source}/{externalId}

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 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)

externalId*string

External system's product ID

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/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}

Batch upsert products by external ID PUT

Create or update multiple products by external system ID. Supports up to 100 products per request with 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/{source}/{externalId}` — Upsert product by external ID **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `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`. **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).

Get product by ID GET

Get a product by its ID. Requires 'products:read' scope. --- **Related endpoints** - `GET /products` — List products - `POST /products` — Create product - `PATCH /products/{id}` — Update product - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID - `PUT /products/external/batch` — Batch upsert products by external ID **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. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.