Access codes

Create an access code

post/v1/location/{location_id}/create_access_code

Request

Base URL
https://api.navigateai.co
Auth
HTTP bearer
TypeScript
https://skmtc.dev/navigateai/apis/navigateai-api/docs/v1/location/:location_id/create_access_code/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

location_idstring required

Request body

visit_type_slugstring required

work_order_idstring nullable

Associate this access code with a work order. The work order must be in open status.

visit_metadataobject nullable

expires_atstring date-time nullable

When the access code 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 code that never expires.

Response

access_codestring required

deeplink_urlstring required

expires_atstring date-time nullable required

Changes

No recorded changes to this operation across all 15 revisions of this API.