DELETE /companies/{companyId}/terminalThemes/{id}/assets

Deletes a single asset from a terminal theme owned by the company specified in the path. To identify the asset you want to remove, you must use the query parameters type and model.

When the type is logo, deleting the asset is blocked if the theme owner is not allowed to edit logos.

To make this request, your API credential must have the following role:

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the terminal theme.

companyId String Yes

The unique identifier of the company account.

Query parameters

Name Type Required Description
type String Yes

The screen type or screen element that the asset is for:

  • logo: your logo. Only supported if model is All.
  • homeScreen: the default background screen.
  • idleScreen: a screensaver shown when the terminal is inactive. Only supported if model is SFO1 or M450.
  • afterPaymentScreen: a screen shown after the payment is completed.
  • shopperEngagementScreen: a screen shown during a shopper engagement request. Only supported if model is SFO1 or M450.

Valid values:

  • "afterPaymentScreen"
  • "shopperEngagementScreen"
  • "idleScreen"
  • "homeScreen"
  • "logo"
model String Yes

The Android terminal model that the asset is for. Use All only if the type is logo. For every other screen type specify a single Android terminal model such as AMS1.

Valid values:

  • "M450"
  • "S1U2"
  • "AMS1"
  • "S1E2L"
  • "S1F2L"
  • "S1E4Pro"
  • "S1U2M4"
  • "LDN1"
  • "P630"
  • "S1F2"
  • "SFO1"
  • "S1F4Pro"
  • "All"

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.