Create Hauler

POST /haulers

Create a new hauler profile.

Roles

Users with the following roles may access this endoint:

Admin
CrmUser
Dispatcher
Driver
Public
ThirdPartyAdmin
ThirdPartyCrmUser
ThirdPartyDispatcher
ThirdPartyDriver

Request

POST /haulers/company_name=A+Test+Company%2C+Inc.&password=password&recaptcha=DummyCaptcha&username=test_new_user
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{}

Path Parameters

note

No path parameters.

Query Parameters

company_name String, Required

Company name (free text).

  • At least 1 and no more than 64 characters.

password String, Required

Login password.

  • At least 1 and no more than 64 characters.

recaptcha String, Required

Recaptcha answer.

  • At least 8 and no more than 512 characters.

username String, Required

Username.

  • No longer than 64 characters.
  • At least 1 characters long.

Request Headers

Refer to StandardPublicRequestHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

Accept String

Mime type (e.g. application/json).

  • At least 1 and no more than 256 characters.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:


x-request-id String

Request identifier.

  • Valid UUID.

Response Body

Refer to ThirdPartyHaulerModel for more details.

id String

Third party hauler identifier.

  • Valid UUID.

name String

Name (free text).

  • At least 1 and no more than 64 characters.

Code Samples

curl --request POST --include \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
--data '{}' \
127.0.0.1:8003/haulers?company_name=A+Test+Company%2C+Inc.&password=password&recaptcha=DummyCaptcha&username=test_new_user