LogoLogo
  • Overview
    • How to obtain an API key?
  • Webhooks
    • About Webhooks
    • Quickstart Guide
      • Set up your server
      • Creating a webhook
      • Configure your server
      • Review your webhooks
      • Secure webhooks
    • Webhook events
      • About events
      • Event List
    • Troubleshooting
  • REST API
    • Overview
      • Current Version
      • Authentication
      • Pagination
    • Quickstart Guide
      • Find the API key
      • Playground
    • API References
      • Rides
      • Search
      • Customers
      • Drivers
      • Webhooks
      • Auth
    • Errors
      • Error codes
    • Troubleshooting
Powered by GitBook
On this page

Was this helpful?

  1. REST API
  2. API References

Drivers

PreviousCustomersNextWebhooks

Last updated 2 years ago

Was this helpful?

About the Driver API

The EverTransit Driver API allows you to create an invitation for a driver to your fleet. To make your request, you can use the endpoint and method listed below.

Endpoints

The Driver invitation object

{
  "email": "john@mail.com",
  "id": "5f886c22fe5dd800318f809f",
  "status": "pending",
  "createdTime": "2022-08-16T22:06:24.024Z"
}

Attributes

Name
Type
Description

email

string

The email of the driver.

id

string

A unique identifier for the driver invitation.

status

string

The status of the invitation request.

createdTime

string

The date and time the driver invitation request was created in ISO format.

Create a Driver invitation

API playground for creating a driver invitation
Create a driver invitation
  • About the Driver API
  • The Driver invitation object
  • Create a Driver invitation
  • POSTCreate a driver invitation.

Create a driver invitation.

post

You can use this endpoint to invite a driver to your fleet. The driver must be registered in the EverTransit driver application: https://apps.apple.com/us/app/evertransit/id1611567689.

Authorizations
Body
emailstring ยท emailRequired

The email of the driver which you want to invite.

Example: john@mail.com
Responses
200
The driver invitation was created successfully.
application/json
400
Bad request.
application/json
401
Unauthorized.
application/json
post
POST /v2beta/drivers/invitations HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "email": "john@mail.com"
}
{
  "email": "john@mail.com",
  "id": "5f886c22fe5dd800318f809f",
  "status": "pending",
  "createdTime": "2022-08-16T22:06:24.024Z"
}