Customer Products
A customer product is an item you offer customers, used to track what they have and what they might want. See the Customer Products guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Customer Product
Section titled “Retrieve Single Customer Product”/backend/api/v1/customerProducts/ID - fetch the customer product with the specified ID.
List Customer Products
Section titled “List Customer Products”/backend/api/v1/customerProducts/ - list all customer products.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include products with a higher ID |
createdSince | datetime | No | Only include products created since the given time |
updatedSince | datetime | No | Only include products updated since the given time |
/backend/api/v1/customerProducts/ - add a new customer product. The newly-added product will be returned.
/backend/api/v1/customerProducts/ID - update the customer product with the specified ID. The modified product will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/customerProducts/ID - delete the customer product with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| customerProductName | Customer Product | Text | Name of the customer product |
| customerProductDisplayClass | Customer Product Display Class | Text | CSS class name used for display styling of this customer product |
| customerProductDisplayPosition | Customer Product Display Position | Number | Sort order position for displaying this customer product in lists |
| onNumbers | On Numbers | Preset Value | Whether this product can be applied to telephone numbers |
| onFeatures | On Features | Preset Value | Whether this product can be applied to customer features |
| autoAddToCustomer | Auto-Add to Customer | Preset Value | Whether to automatically add this product to customers when a feature/number with this product is added |
| autoRemoveFromCustomer | Auto-Remove from Customer Interests | Preset Value | Whether to automatically remove this product from customer interests when a feature/number with this product is added |
| id | Customer Product ID | Text | The unique identifier for this customer product |