Update a personalization design

POST / v1 / issuing / personalization_designs /:id

Updates a card personalization object.

Parameters

• card _ logo string The file for the card logo, for use with physical bundles that support card logos. Must have a purpose value of issuing_logo.
• carrier _ text object Hash containing carrier text, for use with physical bundles that support carrier text.
• lookup _ key string A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. The maximum length is 200 characters.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
• name string Friendly display name. Providing an empty string will set the field to null. The maximum length is 200 characters.
• physical _ bundle string The physical bundle object belonging to this personalization design.
• preferences object Information on whether this personalization design is used to create cards when one is not specified.
• transfer _ lookup _ key boolean If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.

Returns

Returns the updated personalization design object.

Response

{ "id": "ipcd_Oiw9GXcFRE81LZ", "object": "issuing.personalization_design", "livemode": true, "card_logo": "file_1LzR9L2eZvKYlo2CelTpcvKu", "carrier_text": null, "lookup_key": "my_card_design_lookup_key", "metadata": { "order_id": "6735" }, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review"}

Retrieve a personalization design

GET / v1 / issuing / personalization_designs /:id

Retrieves a personalization design object.

Parameters

No parameters.

Returns

Returns the personalization design object.

Response

{ "id": "ipcd_Oiw9GXcFRE81LZ", "object": "issuing.personalization_design", "livemode": true, "card_logo": "file_1LzR9L2eZvKYlo2CelTpcvKu", "carrier_text": null, "lookup_key": "my_card_design_lookup_key", "metadata": {}, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review"}

List all personalization designs

GET / v1 / issuing / personalization_designs

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Parameters

• lookup _ keys array of strings Only return personalization designs with the given lookup keys.
• preferences object Only return personalization designs with the given preferences.
• status enum Only return personalization designs with the given status. Possible enum values active Personalization design can be used to create cards that fulfill immediately. inactive Personalization design cannot be used to create cards because it was deactivated. rejected Personalization design cannot be used to create cards because it was rejected by design review. review Personalization design can be used to create cards but cards will only be fulfilled once the personalization design is activated.

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit cards, starting after card starting_after. Each entry in the array is a separate personalization design object. If no more cards are available, the resulting array will be empty.

Response