RevKeenDocs

Upsert customer by external ID

Create or update a customer identified by external source and ID. Used by integrations (PracticeHub, Wodify) to sync customers.

Related endpoints

  • GET /customers/{customerId}/invoices — List customer invoices
  • GET /customers/{customerId}/subscriptions — List customer subscriptions
  • GET /customers/{customerId}/orders — List customer orders
  • GET /customers/{customerId}/payments — List customer payments
  • PUT /customers/external/batch — Batch upsert customers by external ID
  • POST /customers — Create a new customer
  • GET /customers — List customers
  • GET /customers/{id} — Get customer by ID

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.

Idempotency

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

PUT
/customers/external/{source}/{externalId}

Authorization

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

External source identifier (e.g., practicehub, wodify)

externalId*string

External ID from the source system

Request Body

application/json

Customer data for upsert. external_id and external_source are set from path params.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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/customers/external/practicehub/PAT-12345" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "customer@example.com"
  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
    "merchant_ref_id": "string",
    "email": "user@example.com",
    "name": "string",
    "phone": "string",
    "company_name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string",
    "auth_user_id": "990d439e-9996-4264-8929-f50029888dd9",
    "metadata": {},
    "custom_fields": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "created": true,
  "warnings": [
    "string"
  ]
}
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
    "merchant_ref_id": "string",
    "email": "user@example.com",
    "name": "string",
    "phone": "string",
    "company_name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string",
    "auth_user_id": "990d439e-9996-4264-8929-f50029888dd9",
    "metadata": {},
    "custom_fields": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "created": true,
  "warnings": [
    "string"
  ]
}
{
  "error": "Bad request"
}
{
  "error": "Unauthorized"
}
Edit on GitHub

Batch upsert customers by external ID

Previous Page

List customer entitlements

Next Page