increase-test
POST/digital_card_profiles/{digital_card_profile_id}/archive

Archive a Digital Card Profile

Archives a Digital Card Profile so it is no longer active. Use this operation when the profile should no longer be available for use with digital wallet card artwork.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
digital_card_profile_idstringrequired
The identifier of the Digital Card Profile to archive.

3 status codes
200Returns the Digital Card Profile with its updated status.
app_icon_file_idstringrequired
The identifier of the File containing the card's icon image.
background_image_file_idstringrequired
The identifier of the File containing the card's front image.
card_descriptionstringrequired
A user-facing description for the card itself.
contact_emailstringrequired
An email address the user can contact to receive support for their card.
contact_phonestringrequired
A phone number the user can contact to receive support for their card.
contact_websitestringrequired
A website the user can visit to view and receive support for their card.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Digital Card Profile was created.
descriptionstringrequired
A description you can use to identify the Card Profile.
idstringrequired
The Card Profile identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
issuer_namestringrequired
A user-facing description for whoever is issuing the card.
statusstringrequired
The status of the Card Profile.
Allowed:pendingrejectedactivearchived
text_colorobjectrequired
The Card's text color, specified as an RGB triple.
typestringrequired
A constant representing the object's type. For this resource it will always be `digital_card_profile`.
Allowed:digital_card_profile
4XXReturned when the request results in a client error.
5XXReturned when the server encounters an error processing the request.

Error handling

The digital_card_profile_id path parameter must identify an existing Digital Card Profile. The profile status values are pending, rejected, active, and archived.