Skip to content
/
Create a Booking Widget

Create a Booking Widget

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Authorizationstringrequired

Bearer partner_token, User user_token

Content-Typestringrequired

application/json

Bodyapplication/jsonrequired
titlestringrequired

Name of the appointment widget

descriptionstring

appointment widget description

Default:""
is_defaultboolean

Default appointment widget flag

Default:false
without_menuboolean

Step mode flag

Default:false
service_step_defaultnumber

Service ID

service_step_hideboolean

Service Hiding Flag

Default:false
master_step_defaultnumber

team member ID

master_step_hideboolean

team member hide flag

Default:false
service_step_numnumber

Service step sequence number

master_step_numnumber

Sequence number of the wizard step

datetime_step_numnumber

Sequence number of the date and time step

show_buttonboolean

Button visibility flag

Default:true
button_positionstring

Button location on the page

Default:"bottom right"
Enum:"bottom right""bottom left""top right""top left "
form_positionstring

Panel position on the page

Default:"right"
Enum:"right""left"
button_colorstring

Button color

Default:"#1c84c6"
button_animationboolean

Button animation enable flag

Default:true
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/booking_forms' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "",
    "is_default": false,
    "without_menu": false,
    "service_step_default": 0,
    "service_step_hide": false,
    "master_step_default": 0,
    "master_step_hide": false,
    "service_step_num": 0,
    "master_step_num": 0,
    "datetime_step_num": 0,
    "show_button": true,
    "button_position": "bottom right",
    "form_position": "right",
    "button_color": "#1c84c6",
    "button_animation": true
  }'

Responses

appointment Widget Settings

Bodyapplication/json
dataobject(Root Type BookformSettingsResponse)required

appointment Widget Settings

metaArray of objectsrequired

Metadata

successbooleanrequired

Success status (true)

Response
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Name",
    "is_default": false,
    "description": "Description",
    "without_menu": false,
    "service_step_default": 0,
    "service_step_hide": false,
    "master_step_default": 0,
    "master_step_hide": false,
    "service_step_num": 2,
    "master_step_num": 1,
    "datetime_step_num": 3,
    "show_button": true,
    "button_position": "bottom right",
    "form_position": "right",
    "button_color": "#1c84c6",
    "button_animation": true,
    "html_code": "",
    "ab_test_enabled": false
  },
  "meta": []
}