Skip to main content
GET
/
v1
/
pub
/
Customization
Returns the customizations as configured in the BonifiQ admin panel
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pub/Customization \
  --header 'X-BQ-ApiToken: <api-key>'
{
  "Logo": "<string>",
  "ProgramName": "<string>",
  "FontName": "<string>",
  "FontUrl": "<string>",
  "MainColor": "<string>",
  "Url": "<string>",
  "CompanyName": "<string>",
  "WidgetIconUrl": "<string>",
  "HaveIconUrl": true,
  "WidgetColor": "<string>",
  "PointsNameSingular": "<string>",
  "PointNamePlural": "<string>"
}

Authorizations

X-BQ-ApiToken
string
header
required

API Tokeen

Response

200 - application/json
Logo
string | null

The URL of the store. This is usually used in the e-mails sent do customers.

ProgramName
string | null

The name of the loyalty program. This could be different from the store name. Eg: "MyStore Rewards"

FontName
string | null

Name of the font set. If null use a default font

FontUrl
string | null

URL for the font. For webfonts the FontUrl is null otherwise the URL if given in this field

MainColor
string

The hexadecimal color used as a main theme color for the program.

Url
string | null

The URL of the store or loyalty landing page. It could be useful when communicating with the customer for sending him to the store.

CompanyName
string

Name of the store or company. Can be used in communications.

WidgetIconUrl
string | null

The URL of the icon used as reference in the loyaty program. Used in widget an landing pages. If null, the default icon should be used

HaveIconUrl
boolean

if true the icon URL is set and should be used. If false, the default icon should be used

WidgetColor
string | null

if HaveIconUrl is false, this color should be used in the widget.

PointsNameSingular
string

The user can change the name "Points" to something like "Coins". This is the Singular version

PointNamePlural
string

The user can change the name "Points" to something like "Coins". This is the Plural version