White Label - Delete logo / favicon
Overview
Remove one branding image from a company's white-label config by nulling the matching column (favicon, logo, login_logo, or mobile_logo) on the latest RsWhiteLabel row and saving. Returns a 400 if the company has no white-label record.
Prerequisites
- A bearer token. Callable with Partner and Account tokens.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
POST /api/v1/account/white-label/logo/delete
Authentication
-
Requires a bearer token in the
Authorization: Bearer <bearer-token>header. -
Who can call it: Partner and Account tokens.
-
Authentication, role-agnostic
account/white-labelprefix. -
company_idmust sit inside your own account tree. -
A partner can clear images for any company beneath it. An account user reaches only its own part of the account tree.
Rate limit
- No rate limit.
Request body
- Body:
| Field | Type | Required | Description |
|---|---|---|---|
company_id | integer | required | Must be an existing account inside your own account tree. |
file_type | string | required | one of favicon, logo, login_logo, mobile_logo. |
{
"company_id": 5,
"file_type": "logo"
}Response
data.status(string) —"success".data.message(string) —"File has been deleted!".
200 OK · 200
200{
"data": {
"status": "success",
"message": "File has been deleted!"
}
}400 Bad Request (not found) · 400
400{
"message": "Bad Request",
"status": "error",
"errors": "White label data not found!"
}422 Unprocessable Entity · 422
422{
"message": "The selected file type is invalid.",
"errors": {
"file_type": [
"The selected file type is invalid."
]
}
}Errors
| Status | Meaning |
|---|---|
400 | Bad Request (not found) |
401 | The bearer token is missing, expired or invalid |
422 | Unprocessable Entity |
500 | Unexpected server error |
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": 5, "file_type": "logo"}'Updated 10 days ago
Did this page help you?
