Create task in Onfleet.
Application
Onfleet
Inputs (what you have)
Name | Description | Data Type | Required? | Example |
Connected account | The connected account to use for the request | Connected Account | Yes | |
Task ID | The ID of the task object for lookup | Text (Short) | Yes | |
Destination number | The number component of this address, it may also contain letters | Text (Short) | No | |
Destination street | The name of the street | Text (Short) | No | |
Destination city | The name of the municipality | Text (Short) | No | |
Destination state | Text (Short) | No | ||
Destination country | The name of the country | Text (Short) | No | |
Destination postal code | The postal or zip code | Text (Short) | No | |
Destination address name | A name associated with this address | Text (Short) | No | |
Destination apartment | The suite or apartment number, or any additional relevant information | Text (Short) | No | |
Destintion address Notes | Notes about the destination | Text (Long) | No | |
Complete after | The earliest time the task should be completed | Datetime | No | |
Complete before | The latest time the task should be completed | Datetime | No | |
Executor ID | The ID of the organization that will be responsible for fulfilling the task | Text (Short) | No | |
Merchant ID | The ID of the organization that will be displayed to the recipient of the task | Text (Short) | No | |
Notes | Notes for the task | Text (Long) | No | |
Pick up task? | Whether the task is a pickup task | True/False | No | |
Quantity | The number of units to be dropped off while completing this task, for route optimization purposes | Number | No | |
Recipient name | The recipient's complete name | Text (Short) | No | |
Recipient phone | A 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 notes | Notes for this recipient: these are global notes that should not be task- or destination-specific | Text (Long) | No | |
Skip recipient SMS notifications? | Whether this recipient has requested to skip SMS notifications | True/False | No | |
Recipient name override | Override the recipient name for this task only | Text (Short) | No | |
Recipient notes override | Override the recipient notes for this task only | Text (Short) | No | |
Recipient skip sms notifications override? | Whether to override the recipient notification settings for this task | True/False | No | |
Service time | The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes | Number | No | |
Use merchant for proxy override? | Whether to override the organization ID with the merchant's org ID for this task | True/False | No |
Outputs (what you get)
Name | Description | Data Type | Required? | Example |
JSON Output | JSON output returned by the API | Text (Long) | No |
Outcomes
Name | Description |
Success | This status is selected if the job has successfully completed. |
Unsuccessful | This status is selected if the job has completed unsuccessfully. |
Requirements
N/A