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 | Location | Limitations |
|---|---|---|---|---|---|
name | Name of the client | String | Required | Body | Must include a space. “Prince Fielder” is valid. “Prince” is not. |
office_id | ID of one of your Brokerage’s Offices to which this client will belong | Integer | Optional | Body | |
addresses | Array of addresses belonging to this client | Array | Optional | Body | |
phone_numbers | Array of phone numbers belonging to this client | Array | Optional | Body | |
email_addresses | Array of email addresses belonging to this client | Array | Optional | Body |
Examples
| Request | Response |
|---|---|
| /v9/clients | |
{
"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
}
]
}
| {
"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":[
],
"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"
}
}
]
}
|