Delete a gallery image

Overview

Remove an image from the gallery.

Use this to clean up.

You'll need the image id.

The image is removed. It must belong to company_id; otherwise you get 400.

Prerequisites

• A bearer token. See Authentication.
• The account's id (company_id).
• The image's id (image_id), from Get gallery images.

Base URL

Endpoint

DELETE /api/v1/account/images/delete

Authentication

Partner or Account token

• company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
• An account outside your tree, or one that doesn't exist, is rejected with 422.
• The image must belong to company_id; otherwise 400.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Sent as JSON in the body of the DELETE request.

Request payload

{
  "company_id": 5994,
  "image_id": 12
}

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

400 Image not found

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

422 image_id is missing

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

422 image_id doesn't exist

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

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

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": 5994, "image_id": 12}'