W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • Allow a Visit
  • Deny a Visit

Was this helpful?

  1. Visit

Change Visit Status

Allow a Visit

PATCH https://api.w3lcome.com/v1/visit/allow/:id

This endpoint allows you to allow a visit entrance

Path Parameters

Name
Type
Description

id

string

ID of the visit

Headers

Name
Type
Description

Content-Type

string

application/JSON

Authentication

string

Basic token

{
    "id": "43d2895a-6785-4442-b065-d4c80d7825c8",
    "checkinAt": "2019-07-09T08:02:17-03:00",
    "isInsideCompany": true,
    "type": "visit",
    "name": "Alisson Enz",
    "host": {
        "id": "b98ff2895de825dec050af67d57a23e1",
        "name": "Gabriel Gratival",
        "email": "gabriel@w3lcome.com",
        "type": "host",
    },
    "pictureUrl": "https://firebasestorage.googleapis.com/v0/b/w3lcome-cbcbb.appspot.com/o/AlissonEnz.jpg?alt=media&token=e2f80260-fc3e-417d-b3ad-572513cf8e18",
    "phone": "(43) 9 9982-0420",
    "email": "alisson@w3lcome.com",
    "authorizationStatus": "allowed"
}
{
    "type": "NOT_FOUND"
}

Deny a Visit

PATCH https://api.w3lcome.com/v1/visit/deny/:id

This endpoint allows you to deny a visit entrance

Path Parameters

Name
Type
Description

id

string

ID of the visit

Headers

Name
Type
Description

Content-Type

string

application/json

Authentication

string

Basic token

{
    "id": "43d2895a-6785-4442-b065-d4c80d7825c8",
    "checkinAt": "2019-07-09T08:02:17-03:00",
    "isInsideCompany": true,
    "type": "visit",
    "name": "Alisson Enz",
    "host": {
        "id": "b98ff2895de825dec050af67d57a23e1",
        "name": "Gabriel Gratival",
        "email": "gabriel@w3lcome.com",
        "type": "host",
    },
    "pictureUrl": "https://firebasestorage.googleapis.com/v0/b/w3lcome-cbcbb.appspot.com/o/AlissonEnz.jpg?alt=media&token=e2f80260-fc3e-417d-b3ad-572513cf8e18",
    "phone": "(43) 9 9982-0420",
    "email": "alisson@w3lcome.com",
    "authorizationStatus": "denied"
}
{
    "type": "NOT_FOUND"
}
PreviousRetrieve a List of VisitsNextCheck-out a Visit

Last updated 4 years ago

Was this helpful?