Delete attachment

DELETE

https://api.light.inc/v1/attachments/{attachmentId}

Archives an attachment. The attachment keeps its id, can still be listed with status=ARCHIVED and its file downloaded, and on records that have an activity log the archive is recorded there as ARCHIVE_FILE. An archived attachment can't be restored to its record; to replace a file, upload a new one, and both stay listed. Archived attachments don't count towards the resource's attachment limit. Attachments on posted, partially paid or paid documents can't be archived. Deleting an attachment that is already archived does nothing.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Path parameters

attachmentId string · uuidrequired

Response

application/json;charset=UTF-8This endpoint returns no content.

cURL

curl -X DELETE "https://api.light.inc/v1/attachments/3c90c3cc-0d44-4b50-8888-8dd25736052a" \
  -H "Authorization: Basic YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.light.inc/v1/attachments/3c90c3cc-0d44-4b50-8888-8dd25736052a", {
  method: "DELETE",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

res = requests.delete(
    "https://api.light.inc/v1/attachments/3c90c3cc-0d44-4b50-8888-8dd25736052a",
    headers={
        "Authorization": f"Basic {os.environ['LIGHT_API_KEY']}",
    },
)
data = res.json()