Delete image

Overview

Delete a stored account image. The endpoint marks the matching row status = inactive and then soft-deletes it — the record is retained, not physically removed. Returns a bad-request error if no image matches the company_id + image_id pair.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

DELETE /api/v1/account/images/delete

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Authentication.

• Target company must sit inside your own account tree, keyed on company_id. It must resolve into the authenticated user's company hierarchy.

• The image is additionally constrained to the given company_id. A caller can only delete images belonging to a company in their own tree.

Rate limit

• No rate limit.

Request body

• Body (JSON):

{
  "company_id": 1,
  "image_id": 42
}

Response

• data.status (string) — success.
• data.message (string) — Image has been deleted successfully!.

200 OK · 200

{
  "data": {
    "status": "success",
    "message": "Image has been deleted successfully!"
  }
}

400 Image not found · 400

{
  "message": "Bad Request",
  "status": "error",
  "errors": "Image not found!"
}

422 Validation error · 422

{
  "message": "The image id field is required.",
  "errors": {
    "image_id": ["The selected image id is invalid."]
  }
}

Errors

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/account/images/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 1, "image_id": 42}'