Setup Logo setting for Sub Account
Upload Logo
Description
This endpoint allows the user to upload or update the subaccount logo. If the logo does not exist, it will be inserted; otherwise, it will be updated. The logo is stored in an S3 bucket, and only PNG and SVG file formats are allowed.
Restriction for the logo image
Supported maximum dimensions: 180x60 (rectangular), 120x120 (square).
Recommended dimensions: 100x50 (rectangular), 80x80 (square).
Supported formats: .svg, .png.
HTTP Request
POST /api/subaccount/settings/upload-logo
Headers
Authorization: Bearer
{{YOUR_ACCESS_TOKEN}}(Required)
Request Parameters
Parameter
Type
Description
file
Multipart
The file to upload. Must be of type PNG or SVG.
Authorization
This endpoint requires following role:
ADMIN
Request Body
The body should contain a multipart/form-data request with the file parameter.
Response
200 OK: Returns the updated account setting with the logo key and its corresponding S3 bucket URL.
returns the updated account setting.
{
"key": "logo",
"value": {{URL_TO_THE_LOGO_ON_S3}}
}Example CURL Request
curl --location --request POST '{{BASE-URL}}/api/subaccount/settings/upload-logo' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}' \
--form 'file=@"{{PATH_TO_YOUR_FILE}}"'Replace the placeholders:
{{BASE-URL}}with your API base URL.{{YOUR-ACCESS-TOKEN}}with your valid access token.{{PATH_TO_YOUR_FILE}}with the path to the PNG or SVG file you want to upload.
Remove Logo
Description:
Deletes the logo setting associated with the subaccount and removes the corresponding image from the S3 bucket.
HTTP Request
DELETE /api/subaccount/settings/remove-logo
Headers
Authorization: Bearer
{{YOUR_ACCESS_TOKEN}}(Required)
Authorization
This endpoint requires one of the following roles:
ADMIN
Example CURL Request
curl --location --request DELETE '{{BASE-URL}}/api/subaccount/settings/remove-logo' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}'Response:
Status Code
Description
204
No Content. The logo was successfully removed.
Last updated