OFofficernd
Visits

Delete visit

Delete visit by id

Required scopes: flex.community.visits.delete

delete/api/v2/organizations/{orgSlug}/visits/{visitId}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/visits/{visitId}
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.community.visits.delete

Path parameters

visitIdstring required

The _id of the visit

orgSlugstring required

organization slug

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.