Remove a logo or favicon

Overview

Remove an uploaded logo or favicon and return to the default.

Use this to reset.

You'll need which image to remove.

The image is removed. The account needs a white-label setup; otherwise you get 400.

Prerequisites

• A bearer token. See Authentication.
• The account's id (company_id), with white label set up.

Base URL

Endpoint

POST /api/v1/account/white-label/logo/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.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Request payload

{
  "company_id": 5994,
  "file_type": "logo"
}

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

400 White label not set up

{
  "message": "Bad Request",
  "status": "error",
  "errors": "White label data not found!"
}

422 file_type isn't allowed

{
  "message": "The selected file type is invalid.",
  "errors": {
    "file_type": [
      "The selected file type 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 POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/logo/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "file_type": "logo"}'