NAnavigate
Visits

Create a visit access grant

Changed on
post/v1/visits/{visit_id}/access_grants

Request

Path parameters

visit_idstring required

Request body

recipient_namestring nullable

Display name shown as the guest's identity on the visit (e.g. the reviewer's name).

recipient_emailstring nullable

Contact email recorded for the guest. Not used for authentication.

metadataobject nullable

Arbitrary structured data to attach to this grant (e.g. your own user or task ids). Echoed back verbatim in the create response. Never interpreted by NavigateAI.

expires_atstring date-time nullable

When the access link stops working, as an ISO 8601 UTC timestamp (e.g. 2026-12-31T23:59:59Z). Must be in the future and timezone-aware. Omit for a link that never expires.

access_level'edit' | 'view'

What the recipient can do with the visit. edit lets them change the visit's data and share the visit onward; view is read-only. Defaults to edit.

Response

OK

visit_access_grant_idstring required
visit_idstring required
tokenstring required
deeplink_urlstring required
expires_atstring date-time nullable required
metadataobject nullable required

The arbitrary structured data attached at creation, echoed back verbatim.

access_level'edit' | 'view' required

What the recipient can do with the visit.

Changes

  • 9c9de149d8b0Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status