Save product mappings
Replace the full product-mapping set atomically. The request body is treated as the desired end state — any existing mapping not in the payload is deleted. To change a single mapping without affecting others, read first via `GET` then send the merged set back. Use `DELETE` for single-mapping removal. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/test` — Test integration credentials - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/sync` — Trigger manual sync - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **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).
Replace the full product-mapping set atomically. The request body is treated as the desired end state — any existing mapping not in the payload is deleted. To change a single mapping without affecting others, read first via GET then send the merged set back. Use DELETE for single-mapping removal.
Related endpoints
POST /integrations/{provider}/activate— Activate integrationPOST /integrations/{provider}/deactivate— Deactivate integrationGET /integrations/{provider}— Get integration statusPOST /integrations/{provider}/test— Test integration credentialsPOST /integrations/{provider}/rotate— Rotate integration credentialsPOST /integrations/{provider}/sync— Trigger manual syncPOST /integrations/{provider}/invoices/{externalInvoiceId}/refresh— Refresh a single PracticeHub invoiceGET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status— Get demand invoice refresh status
Common errors
400 invalid_request— malformed payload or failed validation.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
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
Providers that persist product mappings. TeamUp mappings must be zero-money memberships.
Value in
- "practicehub"
- "wodify"
- "terminal"
- "teamup"
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
curl -X PUT "https://api.revkeen.com/v2/integrations/practicehub/product-mappings" \
-H "x-api-key: $REVKEEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mappings": [
{
"externalId": "string",
"internalId": null,
"ignored": false,
"metadata": {
"name": "string",
"type": "string",
"charge_type": "string"
}
}
]
}'{ "success": true, "count": 0}Get product mappings GET
Return the current mapping set between external packages and RevKeen products. Ordered by external package ID; includes the RevKeen product the package maps to (nullable when unmapped) and an optional price override. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/test` — Test integration credentials - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/sync` — Trigger manual sync - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **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.
Resume sync after auto-pause POST
Reset the integration's circuit breaker (consecutive-error counter) and enqueue an immediate sync run. Use after fixing provider-side issues that caused the auto-pause. Equivalent to a status update followed by `/sync`, but captured as a single atomic operation for audit purposes. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/test` — Test integration credentials - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/sync` — Trigger manual sync - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status **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. **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).