v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Visits

Add new visit

Required scopes: flex.community.visits.create

post/api/v2/organizations/{orgSlug}/visits

Path parameters

orgSlugstring required

organization slug

Request body

visitorstring required

The _id of the visitor for which the visit is being recorded.

locationstring required

The _id of the location for which the visit is being recorded.

startstring date-time required

The start date and time of the visit.

endstring date-time required

The end date and time of the visit.

flowIdstring

The _id of the reception flow for which the visit is being recorded.

memberstring

The _id of the member for which the visit is being recorded.

Example request

{
  "visitor": "603dfbc260f4054084125d34",
  "location": "603dfbc260f4054084125d36",
  "start": "2022-02-07T10:03:33.169Z",
  "end": "2022-02-07T10:03:33.169Z",
  "flowId": "603dfbc260f4054084125d34",
  "member": "603dfbc260f4054084125d38"
}

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The _id of the visit.

memberstring

The _id of the member for which the visit is being recorded.

visitorstring

The _id of the visitor for which the visit is being recorded.

locationstring

The _id of the location for which the visit is being recorded.

startstring date-time

The start date and time of the visit.

endstring date-time

The end date and time of the visit.

receptionFlowstring

The _id of the reception flow for which the visit is being recorded.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "603dfbc260f4054084125d39",
  "member": "603dfbc260f4054084125d38",
  "visitor": "603dfbc260f4054084125d34",
  "location": "603dfbc260f4054084125d36",
  "start": "2022-02-07T10:03:33.169Z",
  "end": "2022-02-07T10:03:33.169Z",
  "receptionFlow": "603dfbc260f4054084125d34"
}