Skip to main content
PATCH
Update a card design

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Path Parameters

card_design_id
string
required

The card design to update Imprint ID for the graphic design printed on the card

Example:

"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"

Body

application/json
status
enum<string>
required

The new availability of the design.

Available options:
ACTIVE,
INACTIVE
Example:

"INACTIVE"

Response

The updated card design

id
string
required

Imprint ID for the graphic design printed on the card

Example:

"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"

name
string
required

Human-readable name of the card design

Example:

"Midnight Black"

access_min_rank
integer<int64>
required

Minimum loyalty tier rank a customer must hold to select this design. 0 means available to everyone. A design with a rank above the customer's own tier is returned but cannot be selected by them.

Example:

0

type
enum<string>
required

Whether this is the program's default design or one of its selectable alternates.

Available options:
UNSPECIFIED,
DEFAULT,
REGULAR
Example:

"REGULAR"

status
enum<string>
required

Availability of the design. Only ACTIVE designs can be selected.

Available options:
UNSPECIFIED,
ACTIVE,
INACTIVE,
DELETED
Example:

"ACTIVE"

loyalty_tier_name
string

Name of the loyalty tier corresponding to access_min_rank. Currently always omitted; use access_min_rank to determine gating.

Example:

"GOLD"

categories
object

Partner-defined key/value labels for grouping designs

image_orientation
enum<string>

Orientation of the card design artwork

Available options:
UNSPECIFIED,
VERTICAL,
HORIZONTAL
Example:

"VERTICAL"

light_asset_url_path
string

Absolute URL of the card design artwork for light mode. Artwork is served from https://assets.imprint.co or https://app.imprint.co depending on where it was uploaded.

Example:

"https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg"

dark_asset_url_path
string

Absolute URL of the card design artwork for dark mode. Artwork is served from https://assets.imprint.co or https://app.imprint.co depending on where it was uploaded.

Example:

"https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg"

virtual_digital_card_art_id
string

Processor-side art identifier for the virtual card

physical_digital_card_art_id
string

Processor-side art identifier for the physical card