Set an organization's logo

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

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_image`	For an image of the wrong type or size.
409	`conflict`	`avatar_busy`	While an earlier upload is still being processed.
503	`unavailable`	`file_storage_unavailable`	When file storage cannot be reached.

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

More in Organizations

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

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."  }}

Set an organization's logo

Errors

More in Organizations

Set an organization's logo

Errors

More in Organizations

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Set an organization's logo

Set an organization's logo

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`