OnFleet
FREE
By stefan.skliarov
Updated a year ago

OnFleet API Documentation

Real-time delivery management and analytics functionality.

Learn more about this API
POSTcloneTask
POSTcompleteTask
POSTcreateAdministrator
POSTcreateDestination
POSTcreateDestinationFromRaw
POSTcreateRecipient
POSTcreateTask
POSTcreateTeam
POSTcreateWebhook
POSTcreateWorker
POSTdeleteAdministrator
POSTdeleteTask
POSTdeleteTeam
POSTdeleteWebhook
POSTdeleteWorker
POSTfindRecipientByName
POSTfindRecipientByPhone
POSTgetDelegateeDetails
POSTgetOrganizationDetails
POSTgetSingleDestination
POSTgetSingleRecipient
POSTgetSingleTask
POSTgetSingleTaskByShortId
POSTgetSingleTeam
POSTgetSingleWorker
POSTgetWorkersByLocation
POSTinsertTasksAtIndex
POSTlistAdministrators
POSTlistHubs
POSTlistTasks
POSTlistTeams
POSTlistWebhooks
POSTlistWorkers
POSTtestAuth
POSTupdateAdministrator
POSTupdateRecipient
POSTupdateTask
POSTupdateTasks
POSTupdateTeam
POSTupdateWorker
POSTwebhookEvent
POSTcreateRecipient

A recipient is an organization’s customer and a target for a task, that is, whom the task is being delivered to.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
nameSTRING
REQUIREDThe recipient’s complete name.
apiKeyCREDENTIALS
REQUIREDApi key obtained from OnFleet
phoneSTRING
REQUIREDA unique, valid phone number as per the recipient’s organization’s country.
Optional Parameters
skipPhoneNumberValidationBOOLEAN
OPTIONALWhether to skip validation of this recipient's phone number. An E.164-like number is still required (must start with +), however the API will not enforce any country-specific validation rules.
notesSTRING
OPTIONALNotes for this recipient: these are global notes that should not be task- or destination-specific.
skipSMSNotificationsBOOLEAN
OPTIONALWhether this recipient has requested to not receive SMS notifications. Defaults to false if not provided.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication