Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2412028.8 KB
Tenants

Create a new Redfast tenant

Creates a new tenant on the Redfast platform.

post/v1/tenants

Headers

rf-secretstring required

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

Request body

company_namestring required
external_tenant_idstring required
app_namestring required
app_domainstring required
user_emailstring email required
user_first_namestring required
user_last_namestring required
partner_codestring required
api_keystring required

Example request

{
  "company_name": "My Company",
  "external_tenant_id": "tenant-123",
  "app_name": "My App",
  "app_domain": "example.com",
  "user_email": "admin@example.com",
  "user_first_name": "John",
  "user_last_name": "Doe",
  "partner_code": "recurly",
  "api_key": "abcd1234apikey"
}

Response

Tenant provision started successfully

successboolean
statusstring
external_tenant_idstring
app_idstring
tag_urlstring uri
test_modeboolean

Example response

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