REST API
SUPPORTFEEDBACK

Create an assignment

post
https://api.samsara.com/fleet/carrier-proposed-assignments

Creates a new assignment that a driver can later use. Each driver can only have one future assignment.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

To use this endpoint, select Write Carrier-Proposed Assignments under the Assignments category when creating or editing an API token. Learn More.

Body Params

The assignment to create.

string

Time after which this assignment will be active and visible to the driver on the mobile app. Not setting it makes it active now. UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

string
required

ID for the driver for the driver that this assignment is for. This can be either a unique Samsara ID or an external ID for the driver.

string
length ≤ 40

Shipping Documents that this assignment will propose to the driver.

trailerIds
array of strings

IDs of trailers to propose. This can be either a unique Samsara IDs or an external IDs for the trailers. (forbidden if trailerNames is set)

trailerIds
trailerNames
array of strings

Names of trailers to propose. (forbidden if trailerIds is set)

trailerNames
string
required

ID for the vehicle to propose. This can be either a unique Samsara ID or an external ID for the vehicle.

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago