API Reference
Log In
API Reference

Update a visit

Updates the metadata and/or the presence status of a visit of the facility the API token belongs to. Send at least one of metadata or status. When both are sent, metadata is applied first and then status. A request that changes nothing, for example sending the status the visit already has, still succeeds and returns the current visit.

Path Params
string
required

Identifier of the visit, as returned in the id field of GET /public/visits. A visit that does not exist, belongs to another facility or has been deleted is answered with 404.

Body Params

Metadata changes and/or the status to move the visit to.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json