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 projects
Create a project
Retrieve a project
Update a project
Delete a project
Set a project's logo
Remove a project's logo
Retrieve project settings
Update project settings

Set a project's logo

Replaces the project's logo with the PNG, JPEG or WebP image in the body, up to 2 MB, and returns the project with its new logoUrl.

Only a person can change the logo.

Guide: Teams, projects and environments

PUT
/api/v1/projects/{projectId}/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

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

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/projects/proj_tz4a98xxat96iws9zmbrgj3a/avatar" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "contentType": "image/png",    "imageBase64": "iVBORw0KGgoAAAANSUhEUgAA..."  }'
{  "id": "proj_tz4a98xxat96iws9zmbrgj3a",  "organizationId": "org_w5xk2e7q0lzv3n8b1c4d6f9g",  "name": "Acme Fitness",  "slug": "acme-fitness",  "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": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}
{  "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 it refuses.
409conflictavatar_busyWhen the image is still being checked or changed at the same time.
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 Projects

  • List projects GET
  • Create a project POST
  • Retrieve a project GET
  • Update a project PATCH
  • Delete a project DELETE
  • Remove a project's logo DELETE
  • Retrieve project settings GET
  • Update project settings PATCH

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

PreviousDelete a projectNextRemove a project's logo

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Projects