Skip to content

Account API (1.0.0)

The Account API manages customer accounts, billing addresses, and contact information for the Hauler Hero platform. All endpoints require API key authentication using the HERO-API-KEY header.

Download OpenAPI description
account.json
account.yaml
Languages
Servers
Mock server
https://docs.haulerhero.com/_mock/account/
Production server
https://api.haulerhero.com/

Accounts

Customer account management operations

Operations

Create a new account

Request

Creates a new customer account with billing address and primary contact information

Security
apiKey
Bodyapplication/jsonrequired
accountNamestring[ 1 .. 200 ] charactersrequired

Name of the account/company

Example: "Acme Corporation"
billingAddressobject(AddressView)
primaryContactobject(ContactView)
curl -i -X POST \
  https://docs.haulerhero.com/_mock/account/hero-api/v1/accounts \
  -H 'Content-Type: application/json' \
  -H 'HERO-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "accountName": "Acme Corporation",
    "billingAddress": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "country": "USA",
      "zip": "94105"
    },
    "primaryContact": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@acme.com",
      "phone": "+1-555-0123"
    }
  }'

Responses

Account created successfully

Bodyapplication/json
accountIdstringread-only

Unique identifier for the account (auto-generated)

Example: "acc-789xyz"
accountNumberstringread-only

Unique account number (auto-generated)

Example: "ACC-2024-0001"
accountNamestring[ 1 .. 200 ] charactersrequired

Name of the account/company

Example: "Acme Corporation"
billingAddressobject(AddressView)
primaryContactobject(ContactView)
Response
application/json
{
  "accountId": "acc-789xyz",
  "accountNumber": "ACC-2024-0001",
  "accountName": "Acme Corporation",
  "billingAddress": {
    "addressId": "addr-123",
    "street": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "zip": "94105"
  },
  "primaryContact": {
    "contactId": "cont-456",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@acme.com",
    "phone": "+1-555-0123"
  }
}