Tenant API - Tenant Management

Provide an icon for a tenant

Add or update the tenant icon. If an icon already exists, it will be changed.

To check the current icon associated to a tenant you can simply check the following address:

The icon needs to be provided according to the following format:

  • Dimensions: squared icon with size between 256x256 px and 512x512 px
  • Alpha Channel: 32-bits
  • Format: PNG
  • File size: up to 1MB

We recommend to leave a little white area around the logo, to provide the best experience for the users.

post/v2/tenant/{tenantKey}/icon

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/icon
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

Request body

Example request

{
  "file": {
    "name": "filename.pdf",
    "data": "REVBREJFRUY=",
    "content_type": "image/png"
  }
}

Response

empty response confirming that the put operation was successful

Changes

No recorded changes to this operation across all 1 revision of this API.