Skip to main content
PUT
/
firework
/
v2
/
tenants
/
{tenant_id}
cURL
curl --request PUT \
  --url https://api.flare.io/firework/v2/tenants/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "number_of_employees": 123,
  "industry": "global",
  "global_search_calls_limit": 123,
  "prevent_global_search": true
}
'
{
  "next": "<string>",
  "items": "<unknown>"
}

Documentation Index

Fetch the complete documentation index at: https://api.docs.flare.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tenant_id
integer
required

Body

application/json
​
name
string
required

The Tenant display name

​
description
string
required

The Tenant's purpose / description

​
number_of_employees
integer
required

The number of employees for the tenant

​
industry
enum<string>
required

The Tenant's industry

Available options:
global,
transport,
education,
energy,
finance,
healthcare,
manufacturing,
retail,
software,
telecommunication
Example:

"global"

​
global_search_calls_limit
integer

The number of API calls allowed for the tenant.

​
prevent_global_search
boolean

Response

200 - application/json

Success

​
next
string
​
items
any