Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
Get the organization's branding GETGo back to Annoty's branding DELETESet the organization's branding PUTRemove the branding's logo DELETEUpload the branding's logo PUTGet the caller's organization GET
REST APIOrganization

Upload the branding's logo

Remove the branding's logo DELETE

Reviewers see Annoty's mark in the branding's color instead. Requires `organization:update`.

Get the caller's organization GET

The organization the API key or signed-in member belongs to, with plan usage. Needs no scope. Possible scopes: organization, member, invitation, team, ac, apiKey, project, feedbackSession, comment, notificationDestination, billing, connectedApp.

PUT
/v1/organization/branding/logo

Replaces the logo: image/png, image/jpeg, image/webp, image/svg+xml, up to 2 MB, sent as multipart/form-data field file. Set the branding first. Requires organization:update and a plan with customBranding (Team).

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Request Body

multipart/form-data
  1. body
  1. body
  2. …
file*file

PNG, JPEG, WebP or SVG, up to 2 MB

Formatbinary

Response Body

The organization's branding

application/json
  1. response
  1. response
  2. …
name*string

Shown to reviewers next to the logo

url*|

Where the logo and name link to; null for no link

color*string

Accent on the toolbar, pins and buttons, #rrggbb

foreground*string

Text on color, chosen when saving: white or near-black, whichever reads better

logoUrl*|

The uploaded logo; null shows Annoty's mark in color

hideFooter*boolean

No footer under the widget's panels

updatedAt*string
Formatdate-time
Example Request
curl -X PUT 'https://api.annoty.app/v1/organization/branding/logo' \
  -F 'file=string'
Example Response
{
  "name": "string",
  "url": "string",
  "color": "string",
  "foreground": "string",
  "logoUrl": "string",
  "hideFooter": true,
  "updatedAt": "2019-08-24T14:15:22Z"
}