Favourites

These features interact with the user's favourites.

If the site allows registered users to create their own API keys then normal registered users can use the API too, allowing them to interact with the site via the API, including modifying their favourites.

Scope

Favourites Get and Set

Get favourites

Endpoint

GET https://yourdomain.com/bookyflow/api/favourites

Response Example

Status: OK (200)

{
  "data": {
    "ids": [
      1,
      2,
      3,
      9,
      10,
      13
    ]
  },
  "meta": {
    "code": 200
  }
}

Add favourite

Endpoint

POST https://yourdomain.com/bookyflow/api/favourites/{{property_id}}

Add a property id to the user's favourite properties record.

If the property is already in the favourites list, it will respond with a success message.

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "id": "1"
  },
  "meta": {
    "code": 200
  }
}

Delete favourite

Endpoint

DELETE https://yourdomain.com/bookyflow/api/favourites/{{property_id}}

Removes a property id from the user's favourites record

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "id": "1"
  },
  "meta": {
    "code": 200
  }
}