Create a dispatch on a matter

Sets the matter's service category, opens it, and runs the rate-card dispatcher. A dispatch requested through the API does NOT go out on its own: it parks for human approval and returns 409 (see responses). RBAC: the dispatch.create capability.

post/api/v1/dispatches

Request

  • Base URL: https://scope.bid
  • URL: https://scope.bid/api/v1/dispatches
  • Auth: HTTP bearer

Request body

scope_idstring required

Matter id (SC-XXXX or UUID).

service_categorystring required

Service category slug.

Response

The request was accepted; the outcome object says what happened, and it may be that nothing was dispatched. outcome.status 'no_coverage' means no qualified professional covers this matter (dispatch_id is null and nothing was sent); 'incomplete_intake' means required intake fields are missing (listed in missing_fields; nothing was sent). A dispatch that parks for approval or is held returns 409, not 201.

Changes

No recorded changes to this operation across all 1 revision of this API.