Skip to main content
PUT
Update 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.

Path Parameters

cardId
number
required

Id of the custom card to update.

Body

application/json
cardId
number
required

Id of the custom card to update.

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
string

Image position value. Possible values are:

isVisible
number

Visibility status of card on the microsite. Possible values are:

isPinOnTop
number

Pin status of card on the microsite.

clickURL
string

Redirect URL for card click action.

Text displayed for the link.

type
string

Type/category of the custom card.

Response

OK