Skip to main content

Admin Token Required

Administrative operations — create, update, and list users, vehicles, check-ins, rewards, and payouts. Every endpoint in this section requires an admin token.

PUTUpdate Vehicle**Requires admin token.** Update a vehicle in the Ownli System. This method requires the caller to pass in the Id of the vehicle. If the vehicle is active this routine checks for uniqueness of the license plate.PUTDeactivate a vehicle**Requires admin token.** Deactivate a vehicle of the user. This method should be used to remove a vehicle from a policy. No check-ins are allowed on deactivated vehicles. This method does not check if the vehicle is already deactivated or if there are pending check-ins.PUTReactivate a vehicle**Requires admin token.** Reactivate a vehicle of the user. This method should be used to reinstate a vehicle on a policy This method does not check if the vehicle is already active. If the license or vin on the vehicle have already been reused on a different vehicle this method will return an error.PUTUpdate a user**Requires admin token.** Update a user in the Ownli System.PUTUpdate user with policy details**Requires admin token.** Update user with policy details.PUTUpdate one additional driver**Requires admin token.** Only the fields sent are changed. Send an empty string to clear an optional field.DELETERemove one additional driver**Requires admin token.**GETGet a user's address by type**Requires admin token.** Returns the user's address of the given type. Supported types: policy.PUTSet a user's address by type**Requires admin token.** Creates or fully replaces the user's address of the given type. Fields left out are cleared. state is required. Supported types: policy.DELETERemove a user's address by type**Requires admin token.** Removes the user's address of the given type. Supported types: policy.POSTCreate a vehicle using a VIN**Requires admin token.** Create a vehicle in the Ownli System. This method requires the caller to pass the VIN of the vehicle. If Ownli does not find a VIN match for this, the vehicle will not be created.POSTCreate a vehicle (by license plate and state)**Requires admin token.** Create a vehicle in the Ownli System. This method requires the caller to pass the license plate number and the license plate state. If Ownli does not find a VIN match for this, the vehicle will not be created.POSTCreate a user**Requires admin token.** Create a user in the Ownli System. This method requires the caller to pass the user attributes. If a user with the same email or cell phone exists return an error.GETList a user's additional drivers**Requires admin token.**POSTAdd an additional driver to a user**Requires admin token.** Only firstName and lastName are required. A user can have at most 10 additional drivers.POSTCreate a user with policy info**Requires admin token.** Create a user in the Ownli System with required policy info. Users are identified by policyNumber within your partner account.POSTCreate a user by external reference**Requires admin token.** Create a user in the Ownli System identified only by the partner's remote-system id (externalReference). Email, phone, address and policy are all optional. Users are identified by externalReference within your partner account.POSTGrant a reward (for an action that occurred in the partner's own systems.)**Requires admin token.** **Sandbox only.** Calls against production credentials return 404 until the capability is enabled per partner under a commercial agreement with Ownli (covering budget prepayment and clawback terms).POSTGenerate a marketplace handoff URL for a category**Requires admin token.** Returns an Ownli-hosted handoff URL for the given marketplace category. The integrator renders this URL as an anchor (button, card, deep link) inside its own app; clicking lands the end user on Ownli's hosted handoff page, which collects any missing fields and forwards the user to the vendor.GETList all vehicles.**Requires admin token.** Retrieve the list of vehicles for users created by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETList all users.**Requires admin token.** Retrieve the list of users created by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETList all rewards.**Requires admin token.** Retrieve the list of rewards given by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETList all payouts.**Requires admin token.** Retrieve the list of payouts of rewards given by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETSummarise check-in and user counts for a partner.**Requires admin token.** Retrieve the number of check-ins of each type given by all users owned by a partner, plus the number of those users split by whether they are tagged as MobileMax (CustomField1 = 'MobileMax'). Both are optionally restricted to a date window - applied to the check-in date for check-ins and to the registration date for users. Intended as a lightweight health check - it returns counts only, with no check-in or user detail. Archived check-ins are excluded, so each check-in count matches the total reported by the corresponding check-in list endpoint, and the user total matches the total reported by the user list endpoint, for the same date window.GETList all Proof of address check-ins.**Requires admin token.** Retrieve the list of proof of address check-ins of all users owned by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETList all mileage check-ins.**Requires admin token.** Retrieve the list of mileage check-ins of all users owned by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.GETList all condition check-ins.**Requires admin token.** Retrieve the list of condition check-ins of all users owned by a partner. By default, personal data (names, contact details, addresses, licence plates, VINs, notes, photos, document links and payout links) is masked as `***` in bulk lists, and coordinates are returned as 0. Masking is a per-partner setting; contact Ownli to change it for your account. Use the by-id endpoints for an individual record, or contact Ownli for an offline bulk report.