API Documentation

AccountsEdit Account

Method: /customers/[id].[format]

Fields:

Name	Data Type	Description
name	String	Business Name
office_email	String	Office Email Address
office_number	String	Office Phone Number
office_fax	String	Office Fax
url	String	Company Website Address
billing_address_1	String	Billing Address Line 1
billing_address_2	String	Billing Address Line 2
billing_city	String	Billing City
billing_region	String	Billing Region (Province or State)
billing_country	String	Billing Country
billing_postal_code	String	Billing Postal Code or Zip Code
shipping_address_1	String	Shipping Address Line 1
shipping_address_2	String	Shipping Address Line 2
shipping_city	String	Shipping City
shipping_region	String	Shipping Region (Province or State)
shipping_country	String	Shipping Country
shipping_postal_code	String	Shipping Postal Code or Zip Code

Permissions Required:

View Customers and/or Prospects and/or Suppliers
Modify Customers and/or Prospects and/or Suppliers

Syntax:

https://[subdomain].salesbinder.com/api/2.0/customers/[id].json

HTTP Request Type: PUT

Example JSON Data to Submit

1{
2  "customer":{
3    "name":"API Renamed Customer"
4  }
5}

Example XML Data to Submit

1<?xml version="1.0" encoding="UTF-8" ?>
2<customer>
3  <name>API Renamed Customer</name>
4</customer>

Success:

If you have been successful in updating an account, the response will return the updated data object along with a “message” value of “Saved” as seen below.

Example JSON Returned Response

1{
2    "message": "Saved",
3    "customer": {
4        "id": "19d367c8-97c7-409f-bf67-2ad543493648",
5        "name": "API Renamed Customer",
6        "customer_number": 641,
7        "office_email": "sales@acme-company.com",
8        "office_phone": "(604) 555-5555",
9        "office_fax": "",
10        "url": "acme-company.com",
11        "billing_address_1": "Suite 100 - 1234 West 4th Avenue",
12        "billing_address_2": "",
13        "billing_city": "Vancouver",
14        "billing_region_id": null,
15        "billing_region": "BC",
16        "billing_postal_code": "V6P 6W5",
17        "billing_country_id": null,
18        "billing_country": "Canada",
19        "shipping_address_1": "Suite 100 - 1234 West 4th Avenue",
20        "shipping_address_2": "",
21        "shipping_city": "Vancouver",
22        "shipping_region_id": null,
23        "shipping_region": "BC",
24        "shipping_postal_code": "V6P 6W5",
25        "shipping_country_id": null,
26        "shipping_country": "Canada",
27        "vat_number": "",
28        "context_id": 2,
29        "document_count": null,
30        "tax_rate1": null,
31        "tax_rate2": null,
32        "customer_date": null,
33        "archived": false,
34        "customer_label_id": null,
35        "pricing_tier_id": "",
36        "user_id": "",
37        "modified": "2016-11-11T01:16:55+00:00",
38        "created": "2016-11-11T01:13:09+00:00"
39    }
40}

Updated on February 7th, 2022