PUT
/
tenants
/
{tenant_id}
curl --request PUT \
  --url https://api.flare.io/firework/v2/tenants/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "industry": "global",
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "type": "<string>"
}'
{
  "identifier_count": 123,
  "tenant": {
    "description": "<string>",
    "feed_id": 123,
    "id": 123,
    "industry": "<string>",
    "is_archived": true,
    "name": "<string>",
    "number_of_employees": 123,
    "organization_id": 123,
    "permissions": [
      "<string>"
    ],
    "prevent_global_search": true,
    "type": "<string>",
    "urn": "<string>"
  },
  "user_count": 123
}

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
​
description
string
required

The Tenant's purpose / description

​
industry
enum<string>
required

The Tenant's industry

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

"global"

​
name
string
required

The Tenant display name

​
type
string
required

The Tenant's type

​
permissions
string[]

Response

200 - application/json
Success
​
identifier_count
integer
​
tenant
object
​
user_count
integer

Was this page helpful?

Suggest editsRaise issue