PRpromorepublic
Locations Photos

Update an existing photo

Update metadata of a photo identified by its PromoRepublic unique id. Only metadata fields are supported here (e.g., type, description, identifier, crop values, sourceUrl). The photo file/content cannot be replaced via this endpoint. Each location can contain only one photo of a given type. If a photo of that type already exists, the request will fail.

patch/photos/{id}

Request

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

Path parameters

idstring required

The PromoRepublic unique id of the photo

Request body

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

descriptionstring

Optional description

sourceUrlstring

Original/source URL of the image. Not used to upload a new file.

cropOffsetXinteger

Horizontal crop offset in pixels

cropOffsetYinteger

Vertical crop offset in pixels

cropHeightinteger

Crop height in pixels

cropWidthinteger

Crop width in pixels

Response

The photo has been updated

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.