Skip to main content

Create Custom Card

Create a custom card using the uploaded images.

Request Body
name string REQUIRED

The name of the custom card.

card_id string REQUIRED

The card ID of the base card from the 'Customizable Cards' category card to be used.

cover_id integer

The ID of the cover image to be used. Only images with type 'cover' can be used.

cover_size_percent integer
header_type string
header_text string

Text for the header that will be used if the 'header_logo_id is' not specified.

header_font_size integer
header_font_color color

The color of the header text.

header_font_id string

The font ID of the header text. The list of fonts for the customizer can be obtained using 'GET /fonts/listForCustomizer' request.

header_align string
header_logo_id integer

The ID of the logo image to be used for the header. Only images with type 'logo' can be used.

header_logo_size_percent integer
footer_type string
footer_text string

Text for the footer that will be used if the 'footer_logo_id is' not specified.

footer_font_size integer
footer_font_color color

The color of the footer text.

footer_font_id string

The font ID of the footer text. The list of fonts for the customizer can be obtained using 'GET /fonts/listForCustomizer' request.

footer_align string
footer_logo_id integer

The ID of the logo image to be used for the footer. Only images with type 'logo' can be used.

footer_logo_size_percent integer
back_type string
back_cover_id integer

The ID of the cover image to be used for the back. Only images with type 'cover' can be used.

back_text string

Text for the back that will be used if the 'back_logo_id is' not specified.

back_font_size integer
back_font_color color

The color of the back text.

back_font_id string

The font ID of the back text. The list of fonts for the customizer can be obtained using 'GET /fonts/listForCustomizer' request.

back_align string
back_vertical_align string
back_logo_id integer

The ID of the logo image to be used for the back. Only images with type 'logo' can be used.

back_size_percent integer
qr_code_id integer

The ID of the QR code to be used. The list of QR codes for the customizer can be obtained using 'GET /qrCode' request.

qr_code_size_percent integer
qr_code_align string
qr_code_location string
qr_code_frame_id integer

The ID of the frame to be used for the QR code. The list of frames for the customizer can be obtained using 'GET /qrCode/frames' request.

Responses
200

OK

Schema
httpCode integer
status string
card_id integer