Update a personalization design 

Issuing
Personalization Designs
Update a personalization design

Updates a card personalization object.

Parameters

  • 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_textobject

    Hash containing carrier text, for use with physical bundles that support carrier text.

    • carrier_text.footer_bodystring

      The footer body text of the carrier letter.

    • carrier_text.footer_titlestring

      The footer title text of the carrier letter.

    • carrier_text.header_bodystring

      The header body text of the carrier letter.

    • carrier_text.header_titlestring

      The header title text of the carrier letter.

  • lookup_keystring

    A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.

  • metadataobject

    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.

  • namestring

    Friendly display name. Providing an empty string will set the field to null.

  • physical_bundlestring

    The physical bundle object belonging to this personalization design.

  • preferencesobject

    Information on whether this personalization design is used to create cards when one is not specified.

    • preferences.is_defaultbooleanRequired

      Whether we use this personalization design to create cards when one isn’t specified. A connected account uses the Connect platform’s default design if no personalization design is set as the default design.

  • transfer_lookup_keyboolean

    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.

POST /v1/issuing/personalization_designs/:id
curl https://api.stripe.com/v1/issuing/personalization_designs/ipcd_Oiw9GXcFRE81LZ \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d "metadata[order_id]"=6735
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"
}