Sign in
Access codes

Create an access code

post/v1/location/{location_id}/create_access_code

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

OK

access_codestring required
deeplink_urlstring required
expires_atstring date-time nullable required

Changes

No recorded changes to this endpoint across all 5 revisions of this API.