Upload Account Favicon

Beta

PUT/v1/identity/accounts/{id}/favicon

This endpoint is idempotent. Learn more

Uploads a customer-portal favicon.

Send the image as the raw request body, not as multipart form data. Use a small square PNG (e.g. 32x32 or 64x64) for the best result in browser tabs. The uploaded image replaces any existing favicon and is shown on the account's customer portal. You can only upload a favicon for the account you are acting in.

Permissions requiredValues:self:update

The role behind your API key or agent must grant every one of these permissions.

idstring

ID of the account the favicon belongs to.

Content-Typeoptional string

Content type of the image (e.g., image/png).

The image is stored as image/png if this header is omitted, so set it to match the actual format you upload.

Responses

200

Successful response for Upload Account Favicon

Upload Account Favicon

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const response = await client.identity.accounts.updateFavicon('ac_ykxoradjoeb3');

console.log(response);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const response = await client.identity.accounts.updateFavicon('ac_ykxoradjoeb3');

console.log(response);

200 example

{}

{}

Upload Account Favicon

Authorization

Path Parameters

Header Parameters

Responses