NAnavigateai
Dispatch requests

Create a dispatch request

Changed on
post/v1/dispatch_requests

Request

Request body

location_idstring required

NavigateAI identifier for the location where work should be performed.

visit_type_slugstring required

Slug identifying the visit type to use for this request.

reference_keystring nullable

Optional customer-provided identifier for this request, unique within your organization. Reusing a key returns the existing request unchanged with status 200 — the rest of the body is still validated but not applied; a new key creates a request and returns 201.

assignee_emailstring nullable

Email address of the user to assign to this request, if any. Matching ignores case.

work_order_idstring nullable

NavigateAI identifier for the related work order, if one is provided.

prefill_scope_idstring nullable

NavigateAI identifier for the scope to prefill the visit with, if one is provided.

target_scope_idstring nullable

NavigateAI identifier for the scope whose work the visit checks or updates. Cannot be combined with prefill_scope_id.

metadataobject nullable

Customer-provided metadata to associate with this request.

Response

OK

Changes

  • b928dbabd4e8Revision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • bbdde99b5256Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status