VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List organizations
Create an organization
Retrieve an organization
Update an organization
Delete an organization
Retrieve organization settings
Update organization settings
Set an organization's logo
Remove an organization's logo

Set an organization's logo

Replaces the organization's logo with the image in the body and returns the organization.

Guide: Create a team and a project

PUT
/api/v1/organizations/{organizationId}/avatar

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

organizationId*string

The organization's id, org_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

contentType*string

The image's media type: image/png, image/jpeg or image/webp.

imageBase64*string

The image file, base64-encoded, up to 2 MB before encoding.

Examples

curl -X PUT "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/avatar" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "contentType": "image/png",    "imageBase64": "iVBORw0KGgoAAAANSUhEUgAA..."  }'
{  "id": "org_w5xk2e7q0lzv3n8b1c4d6f9g",  "name": "Acme",  "slug": "acme",  "logoUrl": "https://api.voidhash.com/files/file_g6h9j2k5l8z1x4c7v0b3n6m9q2"}
{  "error": {    "type": "invalid_request",    "code": "invalid_image",    "message": "File type or size is not allowed.",    "param": "imageBase64"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "organization_not_found",    "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.",    "param": "organizationId"  }}
{  "error": {    "type": "conflict",    "code": "avatar_busy",    "message": "Avatar is still being validated."  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}
{  "error": {    "type": "unavailable",    "code": "file_storage_unavailable",    "message": "File storage is temporarily unavailable. Try again shortly."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
400invalid_requestinvalid_imageFor an image of the wrong type or size.
409conflictavatar_busyWhile an earlier upload is still being processed.
503unavailablefile_storage_unavailableWhen file storage cannot be reached.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Organizations

  • List organizations GET
  • Create an organization POST
  • Retrieve an organization GET
  • Update an organization PATCH
  • Delete an organization DELETE
  • Retrieve organization settings GET
  • Update organization settings PATCH
  • Remove an organization's logo DELETE

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousUpdate organization settingsNextRemove an organization's logo

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Organizations