Full width banner v2

post https://api.getgreenspark.com/v2/widgets/full-width-banner

Fetching a banner which displays the user's top stats

Query Params

lng

string

Defaults to en

Set the widget's language. Currently supported languages are: English (en), German (de)

Body Params

options

array of strings

required

options*

imageUrl

string

Customize the banner's background image with an URL

title

string

If a title exists, it will be displayed at the top of the banner

description

string

If a description exists, it will be displayed at the top of the banner or, if a title also exists, it will be displayed below the title

callToActionUrl

string

Adds a button with the "Learn more" call to action, that redirects the user to the specified URL

textColor

string

Changes the color of every text and icon content in the banner. Must be an hexadecimal color.

buttonBackgroundColor

string

If callToActionUrl is no empty, it sets the background color of the call to action button. Must be an hexadecimal color.

buttonTextColor

string

If callToActionUrl is no empty, it sets the background color of the call to action button. Must be an hexadecimal color.

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api.getgreenspark.com/v2/widgets/full-width-banner?lng=en' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400