Skip to main content

Create task in Onfleet

Create task in Onfleet.

Application

  • Onfleet

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected accountThe connected account to use for the requestConnected AccountYes
Task IDThe ID of the task object for lookupText (Short)Yes
Destination numberThe number component of this address, it may also contain lettersText (Short)No
Destination streetThe name of the streetText (Short)No
Destination cityThe name of the municipalityText (Short)No
Destination stateText (Short)No
Destination countryThe name of the countryText (Short)No
Destination postal codeThe postal or zip codeText (Short)No
Destination address nameA name associated with this addressText (Short)No
Destination apartmentThe suite or apartment number, or any additional relevant informationText (Short)No
Destintion address NotesNotes about the destinationText (Long)No
Complete afterThe earliest time the task should be completedDatetimeNo
Complete beforeThe latest time the task should be completedDatetimeNo
Executor IDThe ID of the organization that will be responsible for fulfilling the taskText (Short)No
Merchant IDThe ID of the organization that will be displayed to the recipient of the taskText (Short)No
NotesNotes for the taskText (Long)No
Pick up task?Whether the task is a pickup taskTrue/FalseNo
QuantityThe number of units to be dropped off while completing this task, for route optimization purposesNumberNo
Recipient nameThe recipient's complete nameText (Short)No
Recipient phoneA unique, valid phone number as per the organization's country if there's no leading + sign. If a phone number has a leading + sign, it will disregard the organization's country setting.Text (Short)No
Recipient notesNotes for this recipient: these are global notes that should not be task- or destination-specificText (Long)No
Skip recipient SMS notifications?Whether this recipient has requested to skip SMS notificationsTrue/FalseNo
Recipient name overrideOverride the recipient name for this task onlyText (Short)No
Recipient notes overrideOverride the recipient notes for this task onlyText (Short)No
Recipient skip sms notifications override?Whether to override the recipient notification settings for this taskTrue/FalseNo
Service timeThe number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposesNumberNo
Use merchant for proxy override?Whether to override the organization ID with the merchant's org ID for this taskTrue/FalseNo

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A