Waitlist

Creates a new waitlist reservation.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

post

/v1/flow/waitlist

HTTPcURLJavaScriptPython

POST /v1/flow/waitlist HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "params": {
    "branchId": "text",
    "customerId": "text",
    "numberOfGuests": 1,
    "note": "text",
    "areaId": "text",
    "tableIds": [
      "text"
    ],
    "duration": 1,
    "internalNote": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "waitEntry": {
      "type": "queue",
      "businessDate": "text",
      "status": "admitted",
      "code": "text",
      "numberOfGuests": 1,
      "areaId": "text",
      "duration": 1,
      "note": "text",
      "admittedAt": "text",
      "declinedAt": "text",
      "canceledAt": "text",
      "seatedAt": "text",
      "leftAt": "text",
      "internalNote": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "tableIds": [
        "text"
      ],
      "customer": {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "sequence": 1,
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "passcode": "text",
        "unsubscribed": true,
        "internalNote": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "roleAssignments": [
          {
            "endDate": "text",
            "id": "text"
          }
        ]
      },
      "number": 1,
      "position": 1,
      "notifications": [
        {
          "time": "text",
          "status": "Failed",
          "error": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "text": "text"
        }
      ],
      "can": [
        "admit"
      ],
      "estimatedSeatAt": "text",
      "estimatedLeaveAt": "text",
      "recommendedTableIds": [
        "text"
      ],
      "labels": [
        {
          "uid": "text",
          "labelUid": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text"
        }
      ],
      "flowEntryUid": "text"
    }
  }
}

Updates a specific waitlist reservation.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/flow/waitlist/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/flow/waitlist/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "params": {
    "id": "text",
    "status": "admitted",
    "numberOfGuests": 1,
    "duration": 1,
    "areaId": "text",
    "tableIds": {},
    "note": "text",
    "internalNote": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "waitEntry": {
      "type": "queue",
      "businessDate": "text",
      "status": "admitted",
      "code": "text",
      "numberOfGuests": 1,
      "areaId": "text",
      "duration": 1,
      "note": "text",
      "admittedAt": "text",
      "declinedAt": "text",
      "canceledAt": "text",
      "seatedAt": "text",
      "leftAt": "text",
      "internalNote": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "tableIds": [
        "text"
      ],
      "customer": {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "sequence": 1,
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "passcode": "text",
        "unsubscribed": true,
        "internalNote": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "roleAssignments": [
          {
            "endDate": "text",
            "id": "text"
          }
        ]
      },
      "number": 1,
      "position": 1,
      "notifications": [
        {
          "time": "text",
          "status": "Failed",
          "error": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "text": "text"
        }
      ],
      "can": [
        "admit"
      ],
      "estimatedSeatAt": "text",
      "estimatedLeaveAt": "text",
      "recommendedTableIds": [
        "text"
      ],
      "labels": [
        {
          "uid": "text",
          "labelUid": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text"
        }
      ],
      "flowEntryUid": "text"
    }
  }
}