Experiences

Lists all experiences.

get

Authorizations

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/flow/experiences HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text",
            "content": "text"
          },
          "en": {
            "name": "text",
            "description": "text",
            "content": "text"
          }
        },
        "minGuests": 1,
        "maxGuests": 1,
        "sort": 1,
        "feeInvoiceType": {},
        "feePerGuest": true,
        "feeAppendLoyaltyBenefits": true,
        "default": true,
        "image": "text",
        "ageGroups": [
          {
            "id": "text",
            "counted": true,
            "productUid": "text",
            "locales": {}
          }
        ],
        "sortNumber": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "productUid": "text",
        "productListUid": "text",
        "optionalProductListUid": "text"
      }
    ],
    "next": "text"
  }
}

Creates a new experience.

post

Authorizations

Header parameters

organization-idstringRequired

Organization ID

Body

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "params": {
    "locales": {
      "ar": {
        "name": "text",
        "description": "text",
        "content": "text"
      },
      "en": {
        "name": "text",
        "description": "text",
        "content": "text"
      }
    },
    "effectiveRules": [
      {
        "conditions": [
          {
            "key": "area",
            "operator": "contains",
            "value": "text"
          }
        ],
        "action": "exclude"
      }
    ],
    "minGuests": 1,
    "maxGuests": 1,
    "sort": 1,
    "feeInvoiceType": {},
    "feePerGuest": true,
    "feeAppendLoyaltyBenefits": true,
    "minScheduledItems": 1,
    "minScheduledPaymentPercent": 1,
    "default": true,
    "image": "text",
    "lastSeatingAdjustment": 1,
    "confirmWinow": 1,
    "confirmWinowMethod": {},
    "autoCanceled": true,
    "ageGroups": [
      {}
    ],
    "productUid": "text",
    "productList": "text",
    "optionalProductList": "text",
    "sortNumber": 1
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true,
    "uid": "text"
  }
}

Returns a specific experience.

get

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/flow/experiences/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text",
          "content": "text"
        },
        "en": {
          "name": "text",
          "description": "text",
          "content": "text"
        }
      },
      "minGuests": 1,
      "maxGuests": 1,
      "sort": 1,
      "feeInvoiceType": {},
      "feePerGuest": true,
      "feeAppendLoyaltyBenefits": true,
      "default": true,
      "image": "text",
      "ageGroups": [
        {
          "id": "text",
          "counted": true,
          "productUid": "text",
          "locales": {}
        }
      ],
      "sortNumber": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "productUid": "text",
      "productListUid": "text",
      "optionalProductListUid": "text"
    }
  }
}

Deletes a specific experience.

delete

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/flow/experiences/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a specific experience

patch

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

Responses

200Success

application/json

400

Functional Error

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "params": {
    "locales": {
      "ar": {
        "name": "text",
        "description": "text",
        "content": "text"
      },
      "en": {
        "name": "text",
        "description": "text",
        "content": "text"
      }
    },
    "effectiveRules": [
      {
        "conditions": [
          {
            "key": "area",
            "operator": "contains",
            "value": "text"
          }
        ],
        "action": "exclude"
      }
    ],
    "minGuests": 1,
    "maxGuests": 1,
    "sort": 1,
    "feeInvoiceType": {},
    "feePerGuest": true,
    "feeAppendLoyaltyBenefits": true,
    "minScheduledItems": 1,
    "minScheduledPaymentPercent": 1,
    "default": true,
    "image": "text",
    "lastSeatingAdjustment": 1,
    "confirmWinow": 1,
    "confirmWinowMethod": {},
    "autoCanceled": true,
    "ageGroups": {},
    "productUid": "text",
    "productList": "text",
    "optionalProductList": "text",
    "sortNumber": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text",
          "content": "text"
        },
        "en": {
          "name": "text",
          "description": "text",
          "content": "text"
        }
      },
      "minGuests": 1,
      "maxGuests": 1,
      "sort": 1,
      "feeInvoiceType": {},
      "feePerGuest": true,
      "feeAppendLoyaltyBenefits": true,
      "default": true,
      "image": "text",
      "ageGroups": [
        {
          "id": "text",
          "counted": true,
          "productUid": "text",
          "locales": {}
        }
      ],
      "sortNumber": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "productUid": "text",
      "productListUid": "text",
      "optionalProductListUid": "text"
    }
  }
}

Exports all experiences with support for incremental fetching.

get

Authorizations

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/flow/experiences/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text",
            "content": "text"
          },
          "en": {
            "name": "text",
            "description": "text",
            "content": "text"
          }
        },
        "minGuests": 1,
        "maxGuests": 1,
        "sort": 1,
        "feeInvoiceType": {},
        "feePerGuest": true,
        "feeAppendLoyaltyBenefits": true,
        "default": true,
        "image": "text",
        "ageGroups": [
          {
            "id": "text",
            "counted": true,
            "productUid": "text",
            "locales": {}
          }
        ],
        "sortNumber": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "productUid": "text",
        "productListUid": "text",
        "optionalProductListUid": "text"
      }
    ],
    "next": "text"
  }
}