Create stop
upper_create_stopWRITE: create a stop. The address is geocoded by Upper. Pass route_id to put it on a route (the route must not be active/in progress; an optimized route is flagged for re-optimization); omit it for an unscheduled stop. Calling it twice creates two stops. POST /ext-create-stop.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City (overrides the geocoded value). | |
| note | No | Free-text note shown to the driver. | |
| No | Contact email. | ||
| phone | No | Contact phone number; non-digits are stripped by Upper. | |
| state | No | State or region (overrides the geocoded value). | |
| address | Yes | Street address of the stop (geocoded by Upper). | |
| zipcode | No | Postal code (overrides the geocoded value). | |
| end_time | No | Latest service time (time window end), HH:MM or HH:MM:SS. | |
| route_id | No | Route to attach the stop to; omit for an unscheduled stop. | |
| nick_name | No | Short label for the stop. | |
| pin_color | No | Map pin colour, hex like #FF6600. | |
| stop_type | No | Stop type, for example Delivery or Pickup. | |
| start_time | No | Earliest service time (time window start), HH:MM or HH:MM:SS. | |
| company_name | No | Company name for the stop. | |
| contact_name | No | Contact (recipient) name. | |
| parcel_count | No | Number of parcels at the stop. | |
| custom_fields | No | Custom field values keyed by slot (custom1 - custom5). Only fields enabled in the workspace (and in the plan) are stored. | |
| stop_duration | No | Service duration at the stop, in seconds. | |
| stop_priority | No | Stop priority, for example Normal, High, Urgent. | |
| capacity_fields | No | Capacity values (integers) for load planning, keys capacity1 - capacity5. | |
| customer_system_id | No | Your own identifier for the stop (for cross-referencing). | |
| phone_country_code | No | Phone dialing code, for example 1. |