POST /v1/issuing/personalization_designs

Creates a personalization design object.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
transfer_lookup_key Boolean No

If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.

name String No

Friendly display name.

expand[] Array No

Specifies which fields in the response should be expanded.

preferences Object No

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

preferences.is_default Boolean Yes
metadata Object No

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.

carrier_text Object No

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

carrier_text.footer_title No
carrier_text.header_body No
carrier_text.footer_body No
carrier_text.header_title No
lookup_key String No

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

physical_bundle String Yes

The physical bundle object belonging to this personalization design.

card_logo String No

The file for the card logo, for use with physical bundles that support card logos. Must have a purpose value of issuing_logo.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.