Skip to main content
POST
Create Custom card

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. [Required] Long Business Number.

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
title
string
required

Title shown on the custom card.

description
string

Description/content shown on the custom card.

imageURL
string

Public image URL displayed on the card.

imagePosition
number

Position of the image on the card.

isVisible
number

Visibility status of card on the microsite.

isPinOnTop
number

Pin status of card on the microsite.

clickURL
string

Redirect URL for card click action.

Response

OK

cardId
number

Id of the created custom card.

title
string

Title shown on the custom card.

description
string

Description/content shown on the custom card.

imageURL
string

Public image URL displayed on the card.

imagePosition
string

Image position value.

isVisible
number

Visibility status of card on the microsite.

isPinOnTop
number

Pin status of card on the microsite.

clickURL
string

Redirect URL for card click action. Empty when no redirect is configured.