Service Items

Update a Service Item

Make changes to a service item. <br> Always use ?identifier= in url param to identify the service item uniquely. <br>Any blank parameter deletes an old value, any unspecified parameter does nothing

patch/service-items/{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 for the service item you want to update

Request body

titlestring

Name of the service item as represented at the location

descriptionstring

A description of the service

identifierstring

Required - A unique identifier for this service

listNamestring
priceinteger

Minimum price of the service item. Amounts must be provided in the smallest valid unit of the respective currency (e.g., USD - cents, 10.99 USD → 1099). See range interpretation rules under priceMax.

currencystring

The currency of price and priceMax for this service (required when a price is given). Amounts for price fields must be expressed in the smallest valid unit of this currency (e.g., USD - cents).

urlstring

A valid page url with more details about the item.

categoryinteger

Business category the service should be applied to - this is required when applying a Google structured service but not necessary for freeform services.

countrystring

The country where the locations providing this service are located - this is required when applying a Google structured service but not necessary for freeform services.

googleServicestring

The Google name for a structured service - this is required when applying a Google structured service but not necessary for freeform services.

priceMaxinteger

Maximum price for the item when using a price range. Amounts must be provided in the smallest valid unit of the respective currency (e.g., USD → cents). Range interpretation rules:

  • Exact: price == priceMax

  • Starts At: priceMax == null (only minimum known)

  • Range: price < priceMax (both known and different)

  • Not Interpreted: price is null (minimum unknown)

Validation: if provided, priceMax must be a non-negative integer and greater than or equal to price.

durationinteger

Minimum duration of the service in minutes. See range interpretation rules under durationMax.

durationMaxinteger

Maximum duration (in minutes) when using a duration range. Range interpretation rules:

  • Exact: duration == durationMax\n

  • Starts At: durationMax == null (only minimum known)\n

  • Range: duration < durationMax (both known and different)\n

  • Not Interpreted: duration is null (minimum unknown)\n

Validation: if provided, durationMax must be a non-negative integer and greater than or equal to duration.

Example request

{
  "currency": "USD"
}

Response

Service Item successfully 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

responseobject required

The actual response object of the response

Changes

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