Update a customer

PUT 
/api/v3/customer/:customer_id

Setting the parent_customer_id to null will effectively disconnect the child customer from its parent.

Note that a customer's parent_customer_id can only be updated if its parent has not made a payment for the customer.

Request

application/json

Body

parent_customer_id integer

Parent customer ID #

superuser_id integer

Main contact ID #

external_key string

External key value

company string

Company/customer name

language_id integer

Language ID #

class_id integer

Default class tracking ID #

admin_id integer

Admin/Worker ID number

campaign_id integer

Campaign/lead source ID #

superuser_email string

Main contact e-mail address

superuser_name string

Main contact name

superuser_first_name string

Main contact first name

superuser_last_name string

Main contact last name

superuser_phone string

Main contact phone number

bill_addr1 string

Billing address line 1

bill_addr2 string

Billing address line 2

bill_addr3 string

(Deprecated)

bill_city string

Billing address city

bill_state string

Billing address state/province

bill_postcode string

Billing address postal code

bill_country string

Billing address country

ship_addr1 string

Shipping address line 1

ship_addr2 string

Shipping address line 2

ship_addr3 string

(Deprecated)

ship_city string

Shipping address city

ship_state string

Shipping address state

ship_postcode string

Shipping address postal code

ship_country string

Shipping address country

custom_1 string

Custom field #1

custom_2 string

Custom field #2

custom_3 string

Custom field #3

custom_4 string

Custom field #4

custom_5 string

Custom field #5

custom_6 string

Custom field #6

custom_7 string

Custom field #7

custom_8 string

Custom field #8

custom_9 string

Custom field #9

custom_10 string

Custom field #10

custom_11 string

Custom field #11

custom_12 string

Custom field #12

custom_13 string

Custom field #13

custom_14 string

Custom field #14

custom_15 string

Custom field #15

custom_16 string

Custom field #16

custom_17 string

Custom field #17

custom_18 string

Custom field #18

custom_19 string

Custom field #19

custom_20 string

Custom field #20

custom_21 string

Custom field #21

custom_22 string

Custom field #22

custom_23 string

Custom field #23

custom_24 string

Custom field #24

custom_25 string

Custom field #25

custom_26 string

Custom field #26

custom_27 string

Custom field #27

custom_28 string

Custom field #28

custom_29 string

Custom field #29

custom_30 string

Custom field #30

custom_31 string

Custom field #31

custom_32 string

Custom field #32

custom_33 string

Custom field #33

custom_34 string

Custom field #34

custom_35 string

Custom field #35

custom_36 string

Custom field #36

custom_37 string

Custom field #37

custom_38 string

Custom field #38

custom_39 string

Custom field #39

custom_40 string

Custom field #40

custom_41 string

Custom field #41

custom_42 string

Custom field #42

custom_43 string

Custom field #43

custom_44 string

Custom field #44

custom_45 string

Custom field #45

custom_46 string

Custom field #46

custom_47 string

Custom field #47

custom_48 string

Custom field #48

custom_49 string

Custom field #49

custom_50 string

Custom field #50

terms_id integer

Default terms ID number

no_taxes boolean

Flag to disable charging of taxes

no_dunning boolean

Flag to disable dunning

no_latefees boolean

Flag to disable late fees

no_procfees boolean

Flag to disable processing fees

invoice_delivery string

Delivery method for initial invoices ("email" or "print" for printed hard-copy)

Possible values: [print, email]

dunning_delivery string

Delivery method for dunning/reminder invoices ("email" or "print" for printed hard-copy via Docsaway, Lob, etc.)

Possible values: [print, email]

tax_ident string

Tax ID #/VAT #

tags string[]

A list of tags

Responses

202

Object was updated successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "id": 0
  }
}

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...