Skip to main content
PUT
/
organizations
cURL
curl --request PUT \
  --url https://admin.fanfare.io/api/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "<string>",
  "companyUrl": "<string>",
  "countryCode": "<string>",
  "currencyCode": "<string>",
  "embeddingAllowedHosts": [
    "<string>"
  ],
  "languageCode": "<string>",
  "sdkVersionRange": "<string>",
  "slug": "<string>",
  "timeZone": "<string>"
}
'
{
  "companyName": "<string>",
  "countryCode": "<string>",
  "currencyCode": "<string>",
  "defaultMessagingChannel": "<string>",
  "languageCode": "<string>",
  "publishableKey": "<string>",
  "sdkPolicy": "<string>",
  "slug": "<string>",
  "timeZone": "<string>",
  "companyUrl": "<string>",
  "embeddingAllowedHosts": [
    "<string>"
  ],
  "sdkVersionRange": "<string>"
}

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json
companyName
string
companyUrl
string | null
countryCode
string
currencyCode
string
defaultMessagingChannel
enum<string>
Available options:
EMAIL,
SMS
embeddingAllowedHosts
string[] | null
languageCode
string
sdkPolicy
enum<string>
Available options:
latest,
range
sdkVersionRange
string | null
slug
string
timeZone
string

Response

Organization updated successfully

companyName
string
required
Minimum string length: 1
countryCode
string
required
Minimum string length: 1
currencyCode
string
required
Minimum string length: 1
Pattern: ^[A-Z]{3}$
defaultMessagingChannel
string
required
languageCode
string
required
Minimum string length: 1
publishableKey
string
required
Minimum string length: 1
sdkPolicy
string
required
slug
string
required
Required string length: 3 - 64
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
state
enum<string>
required
Available options:
PENDING,
ACTIVE,
FAILED
timeZone
string
required
Minimum string length: 1
companyUrl
string<uri> | null
embeddingAllowedHosts
string[] | null
sdkVersionRange
string | null