Check-out a Visit

Check-out a visit

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

This endpoint allows you to check-out a visit

Path Parameters

Name	Type	Description
id	string	ID of the visit

Query Parameters

Name	Type	Description
force	boolean	If false and a visit already checked out it returns an error. Otherwise, it overrides the value Default: false
date	number	Unix timestamp (in seconds) with the checkout date of the visit in the current visit timezone. Default: current date and time

Headers

Name	Type	Description
Content-Type	string	application/JSON
Authentication	string	Basic token

200 Success

{
    "id": "43d2895a-6785-4442-b065-d4c80d7825c8",
    "checkinAt": "2019-07-09T08:02:17-03:00",
    "checkoutAt": "2019-07-09T11:04:17-03:00"
    "isInsideCompany": false,
    "type": "visit",
    "name": "Alisson Enz",
    "host": {
        "id": "b98ff2895de825dec050af67d57a23e1",
        "name": "Gabriel Gratival",
        "email": "[email protected]",
        "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": "[email protected]",
    "customFields": [
        {
            "id": "aqg-QM4xL",
            "name": "Do you want to receive promotional emails?",
            "type": "Dropdown",
            "value": "Yes",
        }, { 
            ... 
        }
    ],
    "authorizationStatus": "allowed",
    "notes": "He forgot his id"
}

404 Error

{
    "type": "NOT_FOUND"
}