Establishments

GET /establishments/[establishmentId]

Retrieves details for a specific establishment by its ID. Useful for loading configuration, display information, and branding assets.

Endpoint

GET/establishments/{establishmentId}

Parameters

Attribute	Description	Type	Location	Required
establishmentId		string	path	Yes

Responses

200

Establishment retrieved successfully.

{
  "establishmentId": "00000000-0000-0000-0000-000000000000",
  "defaultCurrency": "string",
  "description": "string",
  "email": "name@example.com",
  "location": "string",
  "monthlyAllocatedCoins": 0,
  "name": "string",
  "paymentPlanId": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "totalAvailableCoins": 0,
  "imageUrl": "https://example.com",
  "thumbnailUrl": "https://example.com",
  "isIntegration": false,
  "style": {
    "backgroundPrimary": "string",
    "foregroundPrimary": "string",
    "backgroundSecondary": "string",
    "foregroundSecondary": "string",
    "backgroundSidebarPrimary": "string",
    "backgroundSidebarSecondary": "string",
    "marketplaceBackground": "string",
    "marketplaceForegroundPrimary": "string",
    "marketplaceForegroundSecondary": "string",
    "marketplaceBackgroundCard": "string",
    "marketplaceForegroundCardPrimary": "string",
    "marketplaceForegroundCardSecondary": "string",
    "marketplaceForegroundCardTertiary": "string",
    "font": "string"
  }
}

Attribute	Type	Required
establishmentId	string(uuid)	No
defaultCurrency	string	No
description	string	No
email	string(email)	No
location	string	No
monthlyAllocatedCoins	integer	No
name	string	No
paymentPlanId	string(uuid)	No
status	string	No
totalAvailableCoins	integer	No
imageUrl	string(uri)	No
thumbnailUrl	string(uri)	No
isIntegration	boolean	No
style	object	No
style.backgroundPrimary	string	No
style.foregroundPrimary	string	No
style.backgroundSecondary	string	No
style.foregroundSecondary	string	No
style.backgroundSidebarPrimary	string	No
style.backgroundSidebarSecondary	string	No
style.marketplaceBackground	string	No
style.marketplaceForegroundPrimary	string	No
style.marketplaceForegroundSecondary	string	No
style.marketplaceBackgroundCard	string	No
style.marketplaceForegroundCardPrimary	string	No
style.marketplaceForegroundCardSecondary	string	No
style.marketplaceForegroundCardTertiary	string	No
style.font	string	No

400

Invalid establishment ID format.

404

Establishment not found.

500

Internal error while retrieving the establishment.

PUT /establishments/[establishmentId]

Updates the configuration for a specific establishment including branding, location, coin ratio, visual appearance settings, and more.

Endpoint

PUT/establishments/{establishmentId}

Request Body

{
  "name": "string",
  "email": "string",
  "imageUrl": "string",
  "thumbnailUrl": "string",
  "description": "string",
  "location": "string",
  "defaultCurrency": "string",
  "coinRatio": 0,
  "status": "string",
  "parentCasinoId": "string",
  "accountManagerId": "string",
  "backgroundPrimary": "string",
  "foregroundPrimary": "string",
  "backgroundSecondary": "string",
  "foregroundSecondary": "string",
  "backgroundSidebarPrimary": "string",
  "backgroundSidebarSecondary": "string",
  "marketplaceBackground": "string",
  "marketplaceForegroundPrimary": "string",
  "marketplaceForegroundSecondary": "string",
  "marketplaceBackgroundCard": "string",
  "marketplaceForegroundCardPrimary": "string",
  "marketplaceForegroundCardSecondary": "string",
  "marketplaceForegroundCardTertiary": "string",
  "font": "string",
  "locale": "string"
}

Attribute	Type	Required
name	string	Yes
email	string	Yes
imageUrl	string	Yes
thumbnailUrl	string	Yes
description	string	Yes
location	string	Yes
defaultCurrency	string	Yes
coinRatio	integer	No
status	string	Yes
parentCasinoId	string	No
accountManagerId	string	No
backgroundPrimary	string	No
foregroundPrimary	string	No
backgroundSecondary	string	No
foregroundSecondary	string	No
backgroundSidebarPrimary	string	No
backgroundSidebarSecondary	string	No
marketplaceBackground	string	No
marketplaceForegroundPrimary	string	No
marketplaceForegroundSecondary	string	No
marketplaceBackgroundCard	string	No
marketplaceForegroundCardPrimary	string	No
marketplaceForegroundCardSecondary	string	No
marketplaceForegroundCardTertiary	string	No
font	string	No
locale	string	Yes

Parameters

Attribute	Description	Type	Location	Required
establishmentId		string	path	Yes

Responses

200

Establishment updated successfully.

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "string",
    "attempts": 0,
    "totalRetryDelay": 0
  },
  "Attributes": {
    "imageUrl": "https://example.com",
    "location": "string",
    "monthlyAllocatedCoins": 0,
    "defaultCurrency": "string",
    "status": "string",
    "thumbnailUrl": "https://example.com",
    "description": "string",
    "email": "name@example.com",
    "paymentPlanId": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  }
}

Attribute	Type	Required
$metadata	object	No
$metadata.httpStatusCode	integer	No
$metadata.requestId	string	No
$metadata.attempts	integer	No
$metadata.totalRetryDelay	integer	No
Attributes	object	No
Attributes.imageUrl	string(uri)	No
Attributes.location	string	No
Attributes.monthlyAllocatedCoins	integer	No
Attributes.defaultCurrency	string	No
Attributes.status	string	No
Attributes.thumbnailUrl	string(uri)	No
Attributes.description	string	No
Attributes.email	string(email)	No
Attributes.paymentPlanId	string(uuid)	No
Attributes.name	string	No

400

Invalid or incomplete update data.

500

Failed to update establishment due to internal error.

Coins Campaigns