v1

latestOpenAPI 3.1.0MIT2026-07-2412028.8 KB

Tenants

Update a Redfast tenant

Updates a Redfast tenant's information or public key.

patch/v1/tenants

Headers

rf-secretstring required

Shared secret provided by Redfast (separate secrets for Test and Production)

Request body

external_tenant_idstring required

Unique Partner Tenant ID

partner_codestring required

Partner Code assigned by Redfast

app_domainstring

(Optional) Top-level domain of the app

api_keystring

(Optional) API key used for integration

Example request

{
  "external_tenant_id": "tenant-123",
  "partner_code": "recurly",
  "app_domain": "example.com",
  "api_key": "abcd1234apikey"
}

Response

Tenant updated successfully

successboolean

statusstring

external_tenant_idstring

app_idstring

tag_urlstring uri

test_modeboolean

Example response

{
  "success": true,
  "status": "updated",
  "external_tenant_id": "tenant-123",
  "app_id": "abc123app",
  "tag_url": "https://abc123app.redfastlabs.com/assets/redfast.js"
}