Skip to content
API Reference/
/
Upload a new photo

Upload a new photo

Request

Upload a single photo for a given location. This endpoint accepts multipart/form-data with a binary photo file.

Security
X-API-KEY or Authorization
Bodymultipart/form-datarequired

Multipart form with the binary photo and related metadata.

locationIdinteger, (int64)required

The uberall unique id of the location to attach the photo to

Example:12345
photostring, (binary)required

Binary image file to upload

identifierstring

Client-defined identifier. Must be unique per location

typestring

Photo type, if not defined defaults to PHOTO

Enum:"MAIN""DOCTOR_COM_PORTRAIT""LOGO""STOREFINDER_LOGO""SQUARED_LOGO""LANDSCAPE""STOREFINDER_COVER""FACEBOOK_LANDSCAPE""APPLE_LANDSCAPE""MENU"
descriptionstring, <= 255 characters

Optional caption/description

orderinteger, (int32)

Zero-based insertion index; if omitted, photo is added to the end

cropOffsetXinteger, (int32)

Horizontal crop offset in pixels

cropOffsetYinteger, (int32)

Vertical crop offset in pixels

cropHeightinteger, (int32)

Crop height in pixels

cropWidthinteger, (int32)

Crop width in pixels

mainbooleandeprecated

Legacy flag for setting main photo. Use type=MAIN instead.

curl -i -X POST \
  https://uberall.com/api/photos \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -F locationId=12345 \
  -F photo=string \
  -F identifier=string \
  -F type=MAIN \
  -F description=string \
  -F order=0 \
  -F cropOffsetX=0 \
  -F cropOffsetY=0 \
  -F cropHeight=0 \
  -F cropWidth=0 \
  -F main=true \
  -F logo=true

Responses

The photo has been uploaded

Bodyapplication/json
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "photo": { … }
  }
}