Browse API reference

Delete a background

deletehttps://api.intelliprint.net/v1/backgrounds/{id}

Deletes a background.

Parameters

Path

idrequired

string

The ID of the background to delete.

Responses

Sample JSON for every response shape is in the right rail. Expand a row below to see every field this endpoint can return.

200Successful responseapplication/json

id

string

The ID of the deleted background.

Example"bg_eg"

object

string

The object type. Always background.

Allowed valuesbackground

deleted

boolean

Whether the background was successfully deleted. Always true.

Exampletrue

400Example error responseapplication/json

error

object

messagestring

A human-readable message describing the error. You can display this to your users to help them understand what went wrong.

Example"Received unknown parameter: testmood (Did you mean testmode?)"

typestring

The general category of the error.

Allowed valuesinvalid_request_errorauthentication_errorpayment_errorrate_limitedinternal_error

Example"invalid_request_error"

codestring

A unique code for the specific error that occurred.

Allowed valuesparameter_invalidparameter_missingparameter_unknownbody_too_largebody_incorrect_formatno_api_keyinvalid_api_keylogged_outforbiddenpayment_errornot_foundrate_limitedrefusedinternal_error

Example"parameter_unknown"

paramstring

The parameter that caused the error, if applicable.

Example"testmood"

Request example

cURL

curl -X DELETE https://api.intelliprint.net/v1/backgrounds/background-id \ 
  -H 'Authorization: YOUR_API_KEY'

Node.js SDK

Node.js

import Intelliprint from 'intelliprint'
const ip = Intelliprint('your-api-key-here')

const deleted = await ip.backgrounds.delete('background-id')

Example response

200 · Successful response

JSON

{
  "id": "bg_eg",
  "object": "background",
  "deleted": true
}

400 · Example error response

JSON

{
  "error": {
    "message": "Received unknown parameter: testmood (Did you mean testmode?)",
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "param": "testmood"
  }
}