FAfanhero
Organizations

Create an organization

Changed on
post/organizations

Request

  • Base URL
    https://api-staging.fanheroapi.com
  • URL
    https://api-staging.fanheroapi.com/organizations
  • Auth
    API key in header API Key

Request body

namestring required

The organization name

kind'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' required

The type of the organization

passwordstring required
faviconstring required
logostring required
entitlementsstring[] required

Example request

{
  "name": "FanHero",
  "kind": "EXCLUSIVE",
  "password": "$2a$10$FIq2vF2eOMNe3wUT7d3aQusCn6zYtSDabMtMDTRFxAsRXt4CzCc52",
  "favicon": "6238dc38c5598261ab9eb5a9",
  "logo": "6238dc38c5598261ab9eb5a9",
  "entitlements": [
    "5fbed4f6c4f0c56a9b63ad27"
  ]
}

Response

Organization created

idstring required
namestring required

The organization name

kind'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' required

The organization's privacy level

web_urlstring[] required

The URLs of the end user web applications.

identifierstring required
itunes_idstring required

Apple ID is the account that you use to access Apple services.

current_versionstring required
onesignal_idstring required
min_compat_versionstring required
portal_urlstring required

The URL to the clients portal on the FanHero platform

email_settingsobject required
tenant_idstring required
avatarCdnBaseUrlstring required
audioCdnBaseUrlstring required
imageCdnBaseUrlstring required

Example response

{
  "id": "61886612d37f875060b4749c",
  "web_url": [
    "[\"https://vale.fanhero.tv\"]"
  ],
  "avatarCdnBaseUrl": "https://avatar-cdn",
  "audioCdnBaseUrl": "https://audio-cdn",
  "imageCdnBaseUrl": "https://image-cdn"
}

Changes