Versions Compared

Old Version 11

changes.mady.by.user J Cobb

Saved on

compared with

New Version 12

changes.mady.by.user J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added documentation for tags
Page Properties
labelapi_docs_client_actions
NameClients Create
DescriptionCreate one or more clients.
TypePOST
URL/v9/clients
Credential TypeAPI

Long Description

Create one or more clients for your brokerage which can participate in orders as the buyer or seller. Note that this takes an array of clients even if only creating one.

Parameters

Name
Description
Type
Presence
LocationLimitations
nameName of the clientStringRequiredBodyMust include a space. “Prince Fielder” is valid. “Prince” is not.
office_idID of one of your Brokerage’s Offices to which this client will belongIntegerOptionalBody
 

tagsComma separated list or an array of tags for this clientString|ArrayOptionalNody
addressesArray of addresses belonging to this clientArrayOptionalBody
 

phone_numbersArray of phone numbers belonging to this clientArrayOptionalBody
 

email_addressesArray of email addresses belonging to this clientArrayOptionalBody
 

 



Examples

RequestResponse
/v9/clients
 

Code Block
language
code
ruby
themeConfluence
languageruby
{
  "clients":[
    {
      "name":"Joe Client",
      "email_addresses":[
        {
          "address":"joe@client.net"
        }
      ],
      "addresses":[
        {
          "region":"NJ",
          "country_code":"US",
          "postal_code":"07307",
          "street_address":"333 Washington St Suite 302",
          "locality":"Jersey City"
        }
      ],
      "phone_numbers":[
        {
          "number":"2015555555"
        }
      ],
      "office_id":1494,
      "tags":"VIP,Radio,Local",
    }
  ]
}
Code Block
languageruby
themeConfluence
languageruby
{
  "clients":[
    {
      "primary_credit_card":null,
      "primary_email_address":{
        "address":"joe@client.net",
        "label":null,
        "id":"81960"
      },
      "company":null,
      "phone_numbers":[
        {
          "extension":null,
          "country_code":null,
          "label":null,
          "number":"2015555555",
          "id":"131865"
        }
      ],
      "email_addresses":[
        {
          "address":"joe@client.net",
          "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":[
        "VIP",
        "Radio",
        "Local"
      ],
      "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":"Joe Client",
      "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"
      }
    }
  ]
}