POST /v1/entity/opening_times

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: POST

Path:  /v1/entity/opening_times

Authentication: API Key required, User ID required

Description: upload opening times for an entity.

Each day can be either:

  • 'closed' to indicate that the entity is closed that day,
  • '24hour' to indicate that the entity is open all day
  • single/split time ranges can be supplied in 4-digit 24-hour format, such as '09001730' or '09001200,13001700' to indicate hours of opening.

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
entity_id string yes The entity ID being manipulated
379275323781120
monday string yes Opening hours for Monday
'closed', '24hour' , '09001730' , '09001200,13001700'
tuesday string yes Opening hours for Tuesday
'closed', '24hour' , '09001730' , '09001200,13001700'
wednesday string yes Opening hours for Wednesday
'closed', '24hour' , '09001730' , '09001200,13001700'
thursday string yes Opening hours for Thursday
'closed', '24hour' , '09001730' , '09001200,13001700'
friday string yes Opening hours for Friday
'closed', '24hour' , '09001730' , '09001200,13001700'
saturday string yes Opening hours for Satruday
'closed', '24hour' , '09001730' , '09001200,13001700'
sunday string yes Opening hours for Sunday
'closed', '24hour' , '09001730' , '09001200,13001700'
closed_public_holidays
boolean

no

Whether entity is closed on public holidays
Default is FALSE

 

Sample Success Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"
    }
}  

Docs Navigation