Adds a customer to an account.
A valid API key with a scope of Customers | Create
An optional unique identifier that can be supplied by the caller. This can be used to find the customer after they are created.
The display name of the customer.
Indicates how to behave when a DisplayName is already used.
The first name of the customer.
The customer's middle initial.
The last name of the customer.
The name of the company the customer works for.
The customer's account number.
The customer's job number.
Indicates if the customer is active or inactive. The default is active.
The email address of the sales rep. A user with this email address must be attached to the account and must be in the sales rep list.
The email address of the installer. A user with this email address must be attached to the account and must be in the installer list.
Indicates if list items should be automatically added to accounts if they don't exist. This applies to Terms, LeadSource, AppointmentType, Location, CustomerType, and AlternateInstaller.
The customer's lead source.
The customer's appointment type.
The customer's location (such as a store number).
The customer's discount group. The discount group must already exist to be used here.
The type of customer (such as 'retail').
The name of the customer's alternate installer.
The current Dispatch.me job ID associated with this interaction. Whether the customer is tax-exempt. The default is false.
The reason why the customer is tax-exempt. See Tax Exempt Reasons below. This is required if TaxExempt is set to true.
Additional details regarding the customer's tax-exempt status, if applicable.
The first line of the customer's billing address. If any address fields are supplied, this must be one of them.
The second line of the customer's billing address.
The city of the customer's billing address. If any address fields are supplied, this must be one of them.
The state of the customer's billing address. If any address fields are supplied, this must be one of them.
The postal code of the customer's billing address. If any address fields are supplied, this must be one of them.
The country of the customer's billing address.
One or more shipping addresses. See Address below.
One or more email addresses. See Email Address below.
One or more phone numbers. See Phone Number below.
One or more notes. See Notes below.
One or more tags. See Tag below.
One or more links. See Link below.
One or more attachments. See Attachments below.
One or more tax codes. See Tax Codes below.
Use an integer from the list below when the customer is tax-exempt.
Industrial Production or Manufacturing
A word to describe the type of address.
The first line of the address.
The second line of the address.
The state of the address.
The postal code of the address.
The country of the address.
Indicates if this address is the primary shipping address. Only one address can be marked as the primary.
An integer that indicates the sorting sequence of the address.
A word to describe the type of email address.
Indicates if this email address is the primary email address. Only one email address can be marked as the primary.
An integer that indicates the sorting sequence of the email address.
A word to describe the type of phone number.
Indicates if this phone number is the primary phone number. Only one phone number can be marked as the primary.
An integer that indicates the sorting sequence of the phone number.
The name of the user that added the note.
A number that indicates the type of link.
- 0 = An entity that already exists on the account, such as another customer or a sale.
- 1 = An external URL.
The name of the link (when the link is a URL link).
The URL of the link (when the link is a URL link).
A number that indicates the type of entity the link relates to:
- 0 = relates to
- 1 = duplicates
- 2 = duplicated by
- 3 = replaces
- 4 = replaced by
A number that indicates the type of entity the link relates to:
- 0 = Customer
- 1 = Quote/Sale
- 2 = Purchase Order
- 3 = Vendor
- 4 = Site Vendor
- 5 = Account Vendor
The unique ID of the linked entity (when the link is an entity link).
The URL to the file to be attached.
Indicates if a thumbnail of the file should be created. This is true by default.
Indicates if a preview of the file should be created. This is true by default.
The tax rate as a decimal.
"DisplayName": "Jack Black",
"SalesRep": "odiemckraken@solatech-darious.com",
"Address1": "45 Main Street",
"Note": "Must call before heading to an appointment."
"Note": "Gate code is 12345."
"Address": "jblack@gmail.com"
The DisplayName must be unique when creating customers. If an existing customer already exists with the same DisplayName, then the behavior of the endpoint will be determined by the ForceUnique property.
If ForceUnique is true, then the API should attempt to make a unique customer by appending a number to the end of the DisplayName. For example, “Joe Smith” will be renamed to “Joe Smith (1)”. If “Joe Smith (1)” also existed, then the API will try “Joe Smith (2)”. Do this up to 5 times and then give up.
If ForceUnique is false then the API will return with a status code of 400 and a message “The customer was not created because a customer with the display name ‘Joe Smith’ already exists.”
When using the address fields such as the billing or shipping addresses, you must supply data in the Address1, City, State and Zip fields.
None
The customer was created.
The customer was not created. The reason why will be returned.
The API key is missing, invalid, disabled, or does not have the correct scope.
All details, except the measure sheets and history, are returned. Refer to the body format of the Read endpoint for an example.