HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
These docs are for v2017-01-01. Click to read the latest docs for v2021-03-10.
added

v2018-06-26: Guide Assignment Acknowledgement

This version introduces the ability for guides assigned to an event to confirm or decline their assignment. This helps the business owner run their tours more effectively and take action if some guides cannot make their tours.

Model Changes

The guides collection in the Event model now contains a list of EventGuide objects when previously it used to contain a list of Guide references.

{
  "id": "event_id",
  "guides": [
    {
      "status": "pending",
      "guide": {"id": "guide_1_id"}
    },
    {
      "status": "confirmed",
      "guide": {"id": "guide_2_id"}
    },
    {
      "status": "declined",
      "guide": {"id": "guide_3_id"}
    }
  ]
}
{
  "id": "event_id",
  "guides": [
    {"id": "guide_1_id"},
    {"id": "guide_2_id"},
    {"id": "guide_3_id"}
  ]
}

Modified Endpoints

EndpointChanges
POST /api/events/{id}/guidesThe model changes mentioned above applies to this endpoint.

New Endpoints

EndpointDescription
PUT /api/events/{id}/guides/{guideId}Update the status of a guide assignment.