Upload a logo

POST 
/v1/businesses/{businessId}/logos

Uploads a logo image for the business. Send the raw image bytes as the request body with the matching Content-Type. The logo starts in CREATED and becomes FINISHED once its sized variations are generated — poll GET /v1/businesses/{businessId}/logos/{logoId} for the status. The returned id is what you set as branding.logoId on a phone number.

Allowed formats: PNG, JPEG, GIF, checked against both the Content-Type and the image bytes. Maximum size 5 MB. Minimum dimensions 600×600 pixels. An image outside these limits returns 400 with IMAGE_ERROR, and the message says which limit it broke.

Path Parameters

---

businessId string<uuid>required
The ID of the business, assigned by Hiya.
Example: 9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8f

Header Parameters

---

X-Hiya-Request-Id string
Your own correlation ID for this call, returned as
requestId
in the response body. Hiya generates one if omitted. A value that doesn't match the pattern is rejected with
400
INVALID_HEADER
.
Possible values: <= 200 characters, Value must match regular expression ^[A-Za-z0-9._:/+=@-]+$
Example: job-2f9c1a7e-0042

Body

required

image/pngimage/jpegimage/gif

Responses

201

The logo was uploaded. It is CREATED, with no variations yet.

Response Body

application/json

400

The image can't be used — the body is empty, the Content-Type or the image itself isn't PNG, JPEG or GIF, the file is larger than 5 MB, or it is smaller than 600×600 pixels. Returned as IMAGE_ERROR; the message says which. Also returned, as INVALID_HEADER, when the X-Hiya-Request-Id header doesn't match its pattern.

Response Body

application/json

401

The API key is missing or invalid.

Response Body

application/json

404

The business doesn't exist, or isn't one of yours — the two are indistinguishable by design.

Response Body

application/json

409

The business is being deleted.

Response Body

application/json

500

Something went wrong on our side.

Response Body

application/json