Replaces a Establishment object

put

https://api-sandbox-revel.revelup.com/enterprise/Establishment/{EstablishmentId}/

Path Params

EstablishmentId

int64

required

Body Params

Establishment object that needs to be updated

about_access_to_location

string

about_description

string

about_title

string

length ≤ 511

active

boolean

Defaults to true

address

uri

android_settings

json

Defaults to {}

billing_enabled

boolean

Defaults to false

brand

uri

brand_name

string

length ≤ 280

cancelable_by_billing

boolean

Defaults to true

cancellation_date

date-time

client_type

integer

enum

Allowed:

contact_name

string

length ≤ 255

created_by

uri

created_date

date-time

ctuit

boolean

Defaults to false

currency

uri

deprecated

delivery_management

boolean

Defaults to false

disabled_backend_for_payment

boolean

Defaults to false

disabled_backend_for_payment_date

string

disabled_for_cancellation

boolean

Defaults to false

disabled_for_payment

boolean

Defaults to false

display_unit_bg_url

url

deprecated

effective_from

date-time

effective_to

string

deprecated

string

length ≤ 75

export_type

integer

enum

Allowed:

fax

string

length ≤ 80

hierarchy_type

integer

enum

Allowed:

images

array of urls

images

information_verified

boolean

Defaults to false

kiosk_image_url_legacy

url

deprecated

location_account_status

string

length ≤ 280

deprecated

location_email

string

length ≤ 75

deprecated

location_name

string

length ≤ 280

deprecated

lock_add_category

integer

enum

Allowed:

lock_add_discount

boolean

Defaults to false

lock_add_modifier

integer

enum

Allowed:

logo_img

uri

logo_url_legacy

url

deprecated

manager

uri

matrix_inventory

boolean

Defaults to false

name

string

length ≤ 280

notes

string

deprecated

ns_internal_id

string

on_boarding_completed

boolean

deprecated

on_boarding_completed_date

date-time

deprecated

on_boarding_started

date-time

deprecated

payment_gateway

integer

enum

phone

string

length ≤ 80

quick_books

integer

enum

Allowed:

retailer_id

string

length ≤ 255

revel_id

string

length ≤ 6

rti

boolean

Defaults to false

deprecated

RUID

string

length ≤ 100

sc_cert

boolean

Defaults to false

settings

uri

settings_last_update

date-time

show_backend_payment_warning

boolean

Defaults to false

show_payment_warning

boolean

Defaults to false

site_number

string

length ≤ 6

social_networks

array of uris

deprecated

social_networks

sorting_id

integer

deprecated

store_number

integer

deprecated

surcharge

integer

deprecated

tax

array of strings

deprecated

tax

tax_payer_sum

string

deprecated

time_worked_available

boolean

Defaults to false

time_zone

string

type_of_service

integer

enum

updated_by

uri

updated_date

date-time

vip

boolean

Defaults to false

web_reservations_key

string

length ≤ 255

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Establishment with the provided ID not found.

201Resource successfully replaced