PRpromorepublic
Locations Photos

Upload a new photo

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

post/photos

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Request body multipart/form-data

locationIdinteger required

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

photostring binary required

Binary image file to upload

identifierstring

Client-defined identifier. Must be unique per location

type'MAIN' | 'DOCTOR_COM_PORTRAIT' | 'LOGO' | 'STOREFINDER_LOGO' | 'SQUARED_LOGO' | 'LANDSCAPE' | 'STOREFINDER_COVER' | 'FACEBOOK_LANDSCAPE' | 'APPLE_LANDSCAPE' | 'MENU' | 'PHOTO' | 'ROOMS' | 'TEAMS' | 'AT_WORK' | 'PRODUCT' | 'EXTERIOR' | 'INTERIOR' | 'COMMON_AREA' | 'FOOD_AND_DRINK'

Photo type, if not defined defaults to PHOTO

descriptionstring

Optional caption/description

orderinteger

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

cropOffsetXinteger

Horizontal crop offset in pixels

cropOffsetYinteger

Vertical crop offset in pixels

cropHeightinteger

Crop height in pixels

cropWidthinteger

Crop width in pixels

Example request

{
  "locationId": 12345
}

Response

The photo has been uploaded

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Changes

No recorded changes to this operation across all 1 revision of this API.