Versions Compared

Old Version 11

changes.mady.by.user J Cobb

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
labelapi_docs_client_actions


Name

Clients Update

Description

Update information about a client.

Type

PUT

URL

/v9/clients/:client_id

Credential Type

API|User


Long Description

Update a client's name or primary address, phone number, or email address.

Parameters

Name

Description

Type

Presence

Location

Limitations

client_id

ID of the Client to update

Integer

Required

URI


name

Name of the client

String

Optional

Body

Must include a space. “Prince Fielder” is valid. “Prince” is not.

company_id

ID of a company to which you want to assign this Client

Integer

Optional

Body


primary_billing_address_id

ID of an address belonging to the client to be labeled as the primary billing address

Integer

Optional

Body


primary_shipping_address_id

ID of an address belonging to the client to be labeled as the primary shipping address

Integer

Optional

Body


primary_email_address_id

ID of an email address belonging to the client to be labeled as the primary email address

Integer

Optional

Body


primary_phone_number_id

ID of a phone number belonging to the client to be labeled as the primary phone number

Integer

Optional

Body


primary_credit_credit_id

ID of a /wiki/spaces/API/pages/4129298 belonging to the client to be labeled as the primary credit card

Integer

Optional

Body


commission_junction_sid

Alphanumeric SID from the Commission Junction network

String

Optional

Body


tags

Comma separated list or an array of tags for this client

String|Array

Optional

Body

Updating tags is not additive. You must include all tags you want to exist on the Client.


Examples

Request

Response

/v9/clients/85238



Code Block
languageruby
themeConfluence
{"name":"
Mike
Michael
Client
Starr"}



Code Block
languageruby
theme
Confluence
{
  "primary_credit_card":null,
  "primary_email_address":{
    "address":"
joe@client
michael.starr@example.
net
com",
    "label":null,
    "id":"81960"
  },
  "company":null,
  "phone_numbers":[
    {
      "extension":null,
      "country_code":null,
      "label":null,
      "number":"2015555555",
      "id":"131865"
    }
  ],
  "email_addresses":[
    {
      "address":"
joe@client
michael.starr@example.
net
com",
      "label":null,
      "id":"81960"
    }
  ],
  "url":"/clients/85238",
  "primary_shipping_address":{
    "locality":"Jersey City",
    "postal_code":"07307",
    "country_code":"US",
    "street_address":"333 Washington St Suite 302",
    "label":null,
    "primary":true,
    "latitude":null,
    "extended_address":null,
    "po_box":false,
    "name":null,
    "id":"376786",
    "longitude":null,
    "region":"NJ"
  },
  "balance":"0.0",
  "updated_at":"2013-07-12T20:13:31Z",
  "tags":[

  ],
  "primary_billing_address":{
    "locality":"Jersey City",
    "postal_code":"07307",
    "country_code":"US",
    "street_address":"333 Washington St Suite 302",
    "label":null,
    "primary":true,
    "latitude":null,
    "extended_address":null,
    "po_box":false,
    "name":null,
    "id":"376786",
    "longitude":null,
    "region":"NJ"
  },
  "name":"
Mike
Michael
Client
Starr",
  "notes":null,
  "id":"85238",
  "addresses":[
    {
      "locality":"Jersey City",
      "postal_code":"07307",
      "country_code":"US",
      "street_address":"333 Washington St Suite 302",
      "label":null,
      "primary":true,
      "latitude":null,
      "extended_address":null,
      "po_box":false,
      "name":null,
      "id":"376786",
      "longitude":null,
      "region":"NJ"
    }
  ],
  "primary_phone_number":{
    "extension":null,
    "country_code":null,
    "label":null,
    "number":"2015555555",
    "id":"131865"
  }
}