Browse API reference

Update a background

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

Updates a background.

Parameters

Path

idrequired

string

The ID of the background to update.

Request body

application/json

name

string

A user-friendly name for this background. This name is used for the selection menu in the dashboard print editor.

Example"Company Letterhead"

team

string

To restrict dashboard-based usage of this background to a certain team, specify the team's ID here.

Examplenull

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

A globally unique identifier for the background.

Example"bg_eg"

object

string

The object type. Always background.

Allowed valuesbackground

account

string

The Intelliprint account ID that the background belongs to.

Example"acc_eg"

name

string

A user-friendly name for this background. This name is used for the selection menu in the dashboard print editor.

Example"Company Letterhead"

file

object

namestring

The name of the file uploaded as the background.

Example"eg_file.pdf"

sizeinteger<int64>

The size of the file uploaded as the background in bytes.

Example1024000

team

object

The team that the background is available to. Can be set to null to make the background available to everyone.

pdf

string<uri>

A URL to a PDF example of the background. This is a signed URL that will expire after 1 hour.

Example"https://cdn.storage.com/intelliprint/backgrounds/bg_ID.pdf"

created

integer<int64>

The UNIX timestamp of when the background was created. We use UNIX timestamps to avoid timezone-based issues.

Example1761955200

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 POST https://api.intelliprint.net/v1/backgrounds/background-id \ 
  -H 'Authorization: YOUR_API_KEY' \ 
  -d 'name=Updated Company Letterhead'

Node.js SDK

Node.js

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

const background = await ip.backgrounds.update('background-id', {
  name: 'Updated Company Letterhead'
})

Example response

200 · Successful response

JSON

{
  "id": "bg_eg",
  "object": "background",
  "account": "acc_eg",
  "name": "Company Letterhead",
  "file": {
    "name": "eg_file.pdf",
    "size": 1024000
  },
  "team": null,
  "pdf": "https://cdn.storage.com/intelliprint/backgrounds/bg_ID.pdf",
  "created": 1761955200
}

400 · Example error response

JSON

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