customer object
A customer object contains the properties that define a DropStream customer.
Customer objects are managed by the /customers endpoint.
customer properties
The following are the properties of a customer object.
id
| Property | id |
|---|
| Description | Unique ID, assigned when the customer object is created |
|---|
| Data type | integer |
|---|
| Note | In other contexts, "customer_id" refers to this property |
|---|
| Example | 12345 |
|---|
company_name
| Property | company_name |
|---|
| Description | Company name |
|---|
| Data type | string |
|---|
| Example | "The company" |
|---|
| Required? | Yes |
|---|
street1
| Property | street1 |
|---|
| Description | Postal address, line 1 |
|---|
| Data type | string |
|---|
| Default | null |
|---|
street2
| Property | street2 |
|---|
| Description | Postal address, line 2 |
|---|
| Data type | string |
|---|
| Default | null |
|---|
street3
| Property | street3 |
|---|
| Description | Postal address, line 3 |
|---|
| Data type | string |
|---|
| Default | null |
|---|
city
| Property | city |
|---|
| Description | City |
|---|
| Data type | string |
|---|
| Default | null |
|---|
state
| Property | state |
|---|
| Description | State |
|---|
| Data type | string |
|---|
| Default | null |
|---|
zipcode
| Property | zipcode |
|---|
| Description | ZIP code |
|---|
| Data type | string |
|---|
| Default | null |
|---|
country
| Property | country |
|---|
| Description | Country |
|---|
| Data type | string |
|---|
| Default | null |
|---|
provider
| Property | provider |
|---|
| Description | String identifying the provider |
|---|
| Accepted values | "dropstream" |
|---|
| Default | null |
|---|
created_at
| Property | created_at |
|---|
| Description | Date when the customer was created |
|---|
| Data type | dateString |
|---|
| Default | null |
|---|
| Example | "2018-08-02T20:36:23.000Z" |
|---|
Example customer object
{
"id": 2376,
"company_name": "Company Name",
"street1": "123 Commerce St",
"street2": "Suite 789",
"street3": null,
"city": "New York",
"state": "NY",
"zipcode": "10012",
"country": "USA",
"provider": "dropstream",
"created_at": "2018-08-02T20:36:23.000Z"
}