Clients / Create





Name

Clients Create

Description

Create one or more clients.

Type

POST

URL

/v9/clients

Credential Type

API



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

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, but recommended

Body



tags

Comma separated list or an array of tags for this client

String|Array

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



company

or

company_id

A Company object

Object

Optional

Body

Use one or the other, but not both. Neither is required.

Note: Using a Company object will create a new Company every time so if you wish to add multiple clients to the same Company you should create the Company once and use the ID.

ID of an existing Company to which you wish to connect this Client

Integer

Optional

Body

notes

Notes you want to store regarding this Client

Sting

Optional

Body



commission_junction_sid

Alphanumeric SID from the Commission Junction network

String

Optional

Body





Examples

Request

Response

Request

Response

POST /v9/clients



A minimal example of creating a client.

{ "clients": [ { "name": "Ned Flanders" } ] }





{ "clients": [ { "addresses": [], "company": null, "email_addresses": [], "id": "168019", "name": "Ned Flanders", "notes": null, "affiliate_store": null, "phone_numbers": [], "primary_credit_card": null, "primary_shipping_address": null, "primary_billing_address": null, "primary_phone_number": null, "primary_email_address": null, "tags": [], "updated_at": "2017-12-14T18:13:24-05:00", "url": "/v9/clients/168019", "balance": "0.0", "pnr_id": null, "commission_junction_sid": null } ] }



An example of creating a client with all available properties as well as related items.

Note: Credit cards cannot be created at the same time as Client creation.

{ "clients": [ { "office_id": 1937, "name": "Ned Flanders", "tags": [ "VIP", "Left Handed", "Mustache Afficianado" ], "company": { "name": "The Leftorium" }, "notes": "Fan of rock band Kovenant, (ex-girlfriend Rachel Jordan is singer).", "email_addresses": [ { "label": "home", "address": "nedflanders@example.com", "is_primary": false }, { "label": "work", "address": "theleftorium@example.com", "is_primary": true } ], "addresses": [ { "label": "home", "name": "Ned Flanders", "company": null, "street_address": "742 Evergreen Terrace", "extended_address": null, "locality": "Springfield", "region": "OR", "postal_code": "97475", "country_code": "US", "is_primary_shipping": false, "is_primary_billing": true }, { "label": "work", "name": "Ned Flanders", "company": "The Leftorium", "street_address": "7721 Springfield Mall Drive", "extended_address": "Suite 202", "locality": "Springfield", "region": "OR", "postal_code": "97475", "country_code": "US", "is_primary_shipping": true, "is_primary_billing": false } ], "phone_numbers": [ { "label": "home", "country_code": "+1", "number": "541-555-0123", "extension": null, "is_primary": false }, { "label": "work", "country_code": "+1", "number": "541-555-0987", "extension": 5, "is_primary": false }, { "label": "cell", "country_code": "+1", "number": "541-555-0573", "extension": null, "is_primary": true } ] } ] }