patch

/immobilizations/{id}

This endpoint allows you to update the status of an existing immobilization and “check-in” an immobilization device. This API allows you to complete the lifecycle of the immobilization and you should use it when the immobilization device is returned so that Passport’s system can remain up to date.

Failure to update an immobilization record after the device has been returned can result in the citation recipient being charged a fee for failing to return the device.

Request Parameters

2 Headers

Request Body

In the request, you must provide a value for the status that is a value defined by Passport. The list of possible options available to public integration partners are listed below:

  • Returned
  • Released

If you have worked with Passport establish a custom integration that allows us to display an release code to the vehicle owners after all citations have been paid, you may also update the release code by providing a release_code value. If you are providing a release_code the status field is not required.

Schema
object
release_code
string

This is the code that should be displayed after the citations associated to an immobilization have been paid to unlock the device.

1 validation
status
string

The new status of the immobilization device.

1 validation

Responses

Schema
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
host