Delete image

Delete a stored company image. The endpoint marks the matched row status=inactive and then soft-deleted (the model uses SoftDeletes). Returns a bad-request error if no image matches the company_id + image_id pair.

Auth: Both — 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, so a caller can only delete images belonging to a company in their own tree.

Rate limit: No rate limit.

Request

  • Body (JSON):
FieldTypeRequiredNotes
company_idintegerYesMust be an existing account and belong to the auth company hierarchy.
image_idintegerYesMust be an existing image; the image must also belong to company_id or the request returns Image not found!.

Response{ data. } envelope.

  • status (string) — success.
  • message (string) — Image has been deleted successfully!.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json