Create Customer

Use this endpoint to create a new customer.

REST Endpoint

POST /restapi/v1/customers

Request Content Type

application/json

Request JSON Example

{
    "profileCode":  "Default",
    "email": "testguy@rocksolidinternet.com",
    "password": "abc123",
    "franchiseId": "TST",
    "mailingAddress": {
        "name": "Test Guy",
        "company": "Test Co",
        "address1": "123 Place",
        "address2": "",
        "city": "Someplace",
        "state": "UT",
        "zip": "84117",
        "country": "US",
        "phone": "8011231234"
    },
    "billingAddress": {
        "name": "Test Guy",
        "company": "Test Co",
        "address1": "123 Place",
        "address2": "",
        "city": "Someplace",
        "state": "UT",
        "zip": "84117",
        "country": "US",
        "phone": "8011231234"
    },
    "prepaySettings": {
        "minimumBalance": "50.00",
        "rechargeAmount": "100.00"
    },
    "salesRep": "jeremy",
    "utm": {
        "source": "google",
        "medium": "cpc",
        "campaign": "summer-sale",
        "term": "camping-gear",
        "content": "cta-bottom"
    },
    "monthlyVolume": "50_shipments_or_less"
}

Explanation of Request Fields

Field	Type	Required	Description
profileCode	string	true	The customer profile to be used as a template for customer creation. Usually 'Default'
email	string	true	The email for the new customer, which will also be used to log in
password	string	true	The password for the new customer
franchiseId	string	false	The three character franchise code for the new customer
mailingAddress.name	string	true	Mailing address name
mailingAddress.company	string	true	Mailing address company
mailingAddress.address1	string	true	Mailing address line 1
mailingAddress.address2	string	true	Mailing address line 2
mailingAddress.city	string	true	Mailing address city
mailingAddress.state	string	true	Mailing address state/province (must be two-character code for US and CA)
mailingAddress.zip	string	true	Sender zip or postal code
mailingAddress.country	string	true	ISO two-character country code
mailingAddress.phone	string	true	10-digit phone number
billingAddress.name	string	true	Mailing address name
billingAddress.company	string	true	Mailing address company
billingAddress.address1	string	true	Mailing address line 1
billingAddress.address2	string	true	Mailing address line 2
billingAddress.city	string	true	Mailing address city
billingAddress.state	string	true	Mailing address state/province (must be two-character code for US and CA)
billingAddress.zip	string	true	Sender zip or postal code
billingAddress.country	string	true	ISO two-character country code
billingAddress.phone	string	true	10-digit phone number
prepaySettings.minimumBalance	decimal	true	Preferred minimum balance for customer
prepaySettings.rechargeAmount	decimal	true	Amount customer will be billed upon creation and when below minimum balance
salesRep	string	false	The name of the sales rep
utm.source	string	false	Campaign source of traffic
utm.medium	string	false	Campaign medium used to share and access your link
utm.campaign	string	false	Campaign name tied to your link
utm.term	string	false	Campaign term or key words used
utm.content	string	false	Campaign content clicked on
monthlyVolume	string	false	Customer expected monthly volume

Response Status Code

201 Created

Response Content Type

application/json

Response JSON Example

{
  "customerId": "TST12345"
}

Explanation of Response Fields

Field	Type	Description
customerId	string	Unique ID for new customer