{ "swagger": "2.0", "info": { "description": "No description", "version": "1.0.0", "title": "Customer" }, "host": "vo3fadi.restletmocks.net", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/customers": { "get": { "tags": [ "Customer" ], "summary": "Returns a list of all customers", "operationId": "customer-get-list", "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0).", "default": 0, "x-example": 3 }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page", "default": 0, "x-example": 5 }, { "name": "tags[]", "in": "query", "required": false, "type": "array", "description": "Optional parameter to filter by one or more tags using the tagId", "items": { "$ref": "#/definitions/TagId" }, "x-example": "tags[]=123e4567-e89b-12d3-a456-426655440000&tags[]=123e4567-e89b-12d3-a456-426655440001" }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "sortBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order", "default": "asc", "enum": [ "asc", "desc" ] }, { "name": "searchText", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results containing specified text" } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/Customer" } }, "examples": { "application/json": "[\n {\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"customerAccountSourceTagList\": [\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Referral\"\n },\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Cold call\"\n }\n ],\n \"customerAccountOwnerTagList\": [\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Smith\"\n },\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jane Doe\"\n }\n ],\n \"customerSalesRepTagList\": [\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Doe\"\n },\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Joe Smith\"\n }\n ],\n \"customerImageURL\": \"https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png\",\n \"customerName\": \"SlashNote.com\",\n \"customerEmail\": \"admin@slashnote.tld\",\n \"customerPhone\": \"800-555-1234\",\n \"customerCreatedBy\": \"John Smith\",\n \"customerCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerBillingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerShippingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerDescription\": \"Great customer for online notes\",\n \"crmIdentifier\": \"crm-a63424932\",\n \"accountNumber\": \"101567839\",\n \"customerSupportPIN\": \"555666\",\n \"websiteURL\": \"https://slashnotes.com\",\n \"customerFax\": \"800-555-1234\",\n \"customerBirthday\": \"2000-01-01\",\n \"customerEmployeeCountTagId\": {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"1 - 25\"\n },\n \"customerSegmentTagList\": [\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Web design\"\n },\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Db design\"\n }\n ],\n \"customerTagList\": [\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair color\",\n \"value\": \"Brown\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Hair Color\"\n }\n ]\n }\n]" } } } }, "post": { "tags": [ "Customer" ], "summary": "Create a new customer", "operationId": "customer-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Customer" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": "{\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"customerAccountSourceTagList\": [\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Referral\"\n },\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Cold call\"\n }\n ],\n \"customerAccountOwnerTagList\": [\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Smith\"\n },\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jane Doe\"\n }\n ],\n \"customerSalesRepTagList\": [\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Doe\"\n },\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Joe Smith\"\n }\n ],\n \"customerImageURL\": \"https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png\",\n \"customerName\": \"SlashNote.com\",\n \"customerEmail\": \"admin@slashnote.tld\",\n \"customerPhone\": \"800-555-1234\",\n \"customerCreatedBy\": \"John Smith\",\n \"customerCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerBillingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerShippingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerDescription\": \"Great customer for online notes\",\n \"crmIdentifier\": \"crm-a63424932\",\n \"accountNumber\": \"101567839\",\n \"customerSupportPIN\": \"555666\",\n \"websiteURL\": \"https://slashnotes.com\",\n \"customerFax\": \"800-555-1234\",\n \"customerBirthday\": \"2000-01-01\",\n \"customerEmployeeCountTagId\": {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"1 - 25\"\n },\n \"customerSegmentTagList\": [\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Web design\"\n },\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Db design\"\n }\n ],\n \"customerTagList\": [\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair color\",\n \"value\": \"Brown\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Hair Color\"\n }\n ]\n }" } }, "400": { "description": "The operation will fail if the customer Id or relationships already exist" } } } }, "/customers/{customerId}": { "get": { "tags": [ "Customer" ], "summary": "Get a customer", "operationId": "customer-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": "{\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"customerAccountSourceTagList\": [\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Referral\"\n },\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Cold call\"\n }\n ],\n \"customerAccountOwnerTagList\": [\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Smith\"\n },\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jane Doe\"\n }\n ],\n \"customerSalesRepTagList\": [\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Doe\"\n },\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Joe Smith\"\n }\n ],\n \"customerImageURL\": \"https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png\",\n \"customerName\": \"SlashNote.com\",\n \"customerEmail\": \"admin@slashnote.tld\",\n \"customerPhone\": \"800-555-1234\",\n \"customerCreatedBy\": \"John Smith\",\n \"customerCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerBillingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerShippingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerDescription\": \"Great customer for online notes\",\n \"crmIdentifier\": \"crm-a63424932\",\n \"accountNumber\": \"101567839\",\n \"customerSupportPIN\": \"555666\",\n \"websiteURL\": \"https://slashnotes.com\",\n \"customerFax\": \"800-555-1234\",\n \"customerBirthday\": \"2000-01-01\",\n \"customerEmployeeCountTagId\": {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"1 - 25\"\n },\n \"customerSegmentTagList\": [\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Web design\"\n },\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Db design\"\n }\n ],\n \"customerTagList\": [\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair color\",\n \"value\": \"Brown\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Hair Color\"\n }\n ]\n }" } } } }, "put": { "tags": [ "Customer" ], "summary": "Update a customer", "operationId": "customer-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Customer" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/Customer" }, "examples": { "application/json": "{\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"customerAccountSourceTagList\": [\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Referral\"\n },\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Cold call\"\n }\n ],\n \"customerAccountOwnerTagList\": [\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Smith\"\n },\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jane Doe\"\n }\n ],\n \"customerSalesRepTagList\": [\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Doe\"\n },\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Joe Smith\"\n }\n ],\n \"customerImageURL\": \"https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png\",\n \"customerName\": \"SlashNote.com\",\n \"customerEmail\": \"admin@slashnote.tld\",\n \"customerPhone\": \"800-555-1234\",\n \"customerCreatedBy\": \"John Smith\",\n \"customerCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerBillingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerShippingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerDescription\": \"Great customer for online notes\",\n \"crmIdentifier\": \"crm-a63424932\",\n \"accountNumber\": \"101567839\",\n \"customerSupportPIN\": \"555666\",\n \"websiteURL\": \"https://slashnotes.com\",\n \"customerFax\": \"800-555-1234\",\n \"customerBirthday\": \"2000-01-01\",\n \"customerEmployeeCountTagId\": {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"1 - 25\"\n },\n \"customerSegmentTagList\": [\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Web design\"\n },\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Db design\"\n }\n ],\n \"customerTagList\": [\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair color\",\n \"value\": \"Brown\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Hair Color\"\n }\n ]\n }" } }, "404": { "description": "Status 404" } } }, "delete": { "tags": [ "Customer" ], "summary": "Delete a customer", "description": "Delete a customer\n\nCannot delete a customer if dependancies exist (remove those first)", "operationId": "customer-delete", "parameters": [], "responses": { "204": { "description": "Status 204" }, "404": { "description": "Status 404" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/notes": { "get": { "tags": [ "Customer Note" ], "summary": "Get all notes for a customer", "description": "Get all notes for a customer", "operationId": "customer-notes-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerNote" } }, "examples": { "application/json": "[\n {\n \"customerNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n},\n {\n \"customerNoteId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"noteDetail\": \"The quick brown fox jumps over the lazy dog.\",\n \"authorName\": \"Jane Doe\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}\n]" } } } }, "post": { "tags": [ "Customer Note" ], "summary": "Create a customer note", "description": "Create a customer note", "operationId": "customer-notes-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerNote" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerNote" }, "examples": { "application/json": "{\n \"customerNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/notes/{customerNoteId}": { "get": { "tags": [ "Customer Note" ], "summary": "Get a customer note", "description": "Get a customer note", "operationId": "customer-note-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerNote" }, "examples": { "application/json": "{\n \"customerNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair Color\",\n \"value\": \"Blonde\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}" } } } }, "put": { "tags": [ "Customer Note" ], "summary": "Update a customer note", "description": "Update a customer note", "operationId": "customer-note-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerNote" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerNote" }, "examples": { "application/json": "{\n \"customerNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}" } } } }, "delete": { "tags": [ "Customer Note" ], "summary": "Delete a customer note", "description": "Delete a customer note", "operationId": "customer-note-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerNoteId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/contacts": { "get": { "tags": [ "Customer Contact" ], "summary": "Get all contacts for customer", "description": "Get all contacts for customer", "operationId": "customer-contact-get-list", "parameters": [ { "name": "tags[]", "in": "query", "required": false, "type": "string", "description": "Optional parameter to filter by one or more tags using the tagId", "x-example": "tags[]=123e4567-e89b-12d3-a456-426655440000&tags[]=123e4567-e89b-12d3-a456-426655440001" }, { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0).", "default": 0, "x-example": 5 }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page" }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2018-06-27T00:00:00.000Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2018-06-27T00:00:00.000Z" }, { "name": "sortBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order", "default": "asc", "enum": [ "asc", "desc" ] } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } }, "examples": { "application/json": "[{\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerContactRoleTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Dr\",\n \"contactName\": \"Sam Jones\",\n \"emailAddresses\": [{\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"samjones@chassi.tld\",\n \"primaryEmailAddress\": true\n }],\n \"phoneNumbers\": [{\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": true\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 133-1351\",\n \"primaryPhoneNumber\": false\n }\n ],\n \"physicalAddresses\": [{\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }],\n \"customerContactTags\": [{\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }],\n \"metadata\": [{\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }],\n \"dateCreated\": \"example\",\n \"lastUpdated\": \"example\",\n \"primaryCustomerContact\": true\n },\n {\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerContactRoleTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Ms\",\n \"contactName\": \"Jane Doe\",\n \"emailAddresses\": [{\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"jane@chassi.tld\",\n \"primaryEmailAddress\": true\n },\n {\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"home email\",\n \"emailAddress\": \"jdoe@fakeemail.tld\",\n \"primaryEmailAddress\": true\n }\n ],\n \"phoneNumbers\": [{\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544003\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": false\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544004\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 631-1212\",\n \"primaryPhoneNumber\": true\n }\n\n ],\n \"physicalAddresses\": [{\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544003\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n },\n {\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544004\",\n \"label\": \"shipping\",\n \"attention\": \"Jane\",\n \"addressLine1\": \"305 W Main St\",\n \"addressLine2\": \"\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }\n ],\n \"customerContactTags\": [{\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }],\n \"metadata\": [{\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }],\n \"dateCreated\": \"20180430T00:00:00.000Z\",\n \"lastUpdated\": \"20180430T00:00:00.000Z\",\n \"primaryCustomerContact\": false\n }\n]" } } } }, "post": { "tags": [ "Customer Contact" ], "summary": "Create or attach a customer contact", "description": "Create or attach a customer contact", "operationId": "customer-contact-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContact" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContact" }, "examples": { "application/json": "{\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Dr\",\n \"contactName\": \"Sam Jones\",\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"samjones@chassi.tld\",\n \"primaryEmailAddress\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": true\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 133-1351\",\n \"primaryPhoneNumber\": false\n }\n ],\n \"physicalAddresses\": [\n {\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }\n ],\n \"customerContactTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ],\n \"dateCreated\": \"example\",\n \"lastUpdated\": \"example\",\n \"primaryCustomerContact\": true\n }" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/contacts/{customerContactId}": { "get": { "tags": [ "Customer Contact" ], "summary": "Get a customer contact", "description": "Get a customer contact", "operationId": "customer-contact-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContact" }, "examples": { "application/json": "{\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerContactRoleTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Dr\",\n \"contactName\": \"Sam Jones\",\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"sjones@chassi.com\",\n \"primaryEmailAddress\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": true\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 133-1351\",\n \"primaryPhoneNumber\": false\n }\n ],\n \"physicalAddresses\": [\n {\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }\n ],\n \"customerContactTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ],\n \"dateCreated\": \"2018-03-16T00:16:12.000Z\",\n \"lastUpdated\": \"2018-06-11T13:15:03.000Z\",\n \"primaryCustomerContact\": true\n }" } } } }, "put": { "tags": [ "Customer Contact" ], "summary": "Update a customer contact", "description": "Update a customer contact", "operationId": "customer-contact-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContact" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContact" }, "examples": { "application/json": "{\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerContactRoleTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Dr\",\n \"contactName\": \"Sam Jones\",\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"sjones@chassi.com\",\n \"primaryEmailAddress\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": true\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 133-1351\",\n \"primaryPhoneNumber\": false\n }\n ],\n \"physicalAddresses\": [\n {\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }\n ],\n \"customerContactTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ],\n \"dateCreated\": \"2018-03-16T00:16:12.000Z\",\n \"lastUpdated\": \"2018-06-11T13:15:03.000Z\",\n \"primaryCustomerContact\": true\n }" } } } }, "delete": { "tags": [ "Customer Contact" ], "summary": "Delete a customer contact", "description": "Delete a customer contact", "operationId": "customer-contact-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerContactId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/contact-id-list": { "post": { "tags": [ "Customer Contact" ], "summary": "Attach a list of existing contacts to the specified customer", "description": "Attach a list of existing contacts to the specified customer", "operationId": "customer-contact-list-create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactIdList" } } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerContact" } }, "examples": { "application/json": "[{\n \"customerContactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerContactRoleTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"contactTitle\": \"Dr\",\n \"contactName\": \"Sam Jones\",\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"contactId\": \"123e4567-e89b-12d3-a456-42665544000\",\n \"label\": \"Work email\",\n \"emailAddress\": \"sjones@chassi.com\",\n \"primaryEmailAddress\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"Cell\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 123-1234\",\n \"primaryPhoneNumber\": true\n },\n {\n \"phoneNumberId\": \"123e4567-e89b-12d3-a456-42665544002\",\n \"label\": \"Home\",\n \"countryCode\": \"1\",\n \"phoneNumber\": \"1 (555) 133-1351\",\n \"primaryPhoneNumber\": false\n }\n ],\n \"physicalAddresses\": [\n {\n \"physicalAddressId\": \"123e4567-e89b-12d3-a456-42665544001\",\n \"label\": \"mailing\",\n \"attention\": \"Sam Smith\",\n \"addressLine1\": \"123 Elm\",\n \"addressLine2\": \"Suite 104\",\n \"city\": \"Anytown\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\",\n \"primaryAddress\": true\n }\n ],\n \"customerContactTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ],\n \"dateCreated\": \"2018-03-16T00:16:12.000Z\",\n \"lastUpdated\": \"2018-06-11T13:15:03.000Z\",\n \"primaryCustomerContact\": true\n }]" } }, "400": { "description": "Status 400" }, "404": { "description": "Status 404", "schema": { "type": "object" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customer-contacts/{contactId}": { "get": { "tags": [ "Customer Contact" ], "summary": "Returns a list of customers associated with the specified contact id", "description": "Returns a list of customers associated with the specified contact id", "operationId": "customer-contact-customers-get-list", "produces": [ "application/json" ], "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0).", "default": 0, "x-example": 3 }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page", "default": 0, "x-example": 5 }, { "name": "sortBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order", "default": "asc", "enum": [ "asc", "desc" ] } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/Customer" } }, "examples": { "application/json": "[\n {\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"customerAccountSourceTagList\": [\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Referral\"\n },\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Cold call\"\n }\n ],\n \"customerAccountOwnerTagList\": [\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Smith\"\n },\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jane Doe\"\n }\n ],\n \"customerSalesRepTagList\": [\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"John Doe\"\n },\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Joe Smith\"\n }\n ],\n \"customerImageURL\": \"https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png\",\n \"customerName\": \"SlashNote.com\",\n \"customerEmail\": \"admin@slashnote.tld\",\n \"customerPhone\": \"800-555-1234\",\n \"customerCreatedBy\": \"John Smith\",\n \"customerCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerBillingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerShippingAddress\": {\n \"addressLine1\": \"123 Elm Street\",\n \"addressLine2\": \"Suite 301\",\n \"city\": \"Phoenix\",\n \"stateOrProvince2Digit\": \"AZ\",\n \"postalCode\": \"85034\",\n \"countryCode2Digit\": \"US\"\n },\n \"customerDescription\": \"Great customer for online notes\",\n \"crmIdentifier\": \"crm-a63424932\",\n \"accountNumber\": \"101567839\",\n \"customerSupportPIN\": \"555666\",\n \"websiteURL\": \"https://slashnotes.com\",\n \"customerFax\": \"800-555-1234\",\n \"customerBirthday\": \"2000-01-01\",\n \"customerEmployeeCountTagId\": {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"1 - 25\"\n },\n \"customerSegmentTagList\": [\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Web design\"\n },\n {\n \"customerSegmentTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Db design\"\n }\n ],\n \"customerTagList\": [\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n }\n ],\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Hair color\",\n \"value\": \"Brown\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Hair Color\"\n }\n ]\n }\n]" } }, "404": { "description": "Status 404" } } }, "parameters": [ { "name": "contactId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/contacts/{customerContactId}/notes": { "get": { "tags": [ "Customer Contact Notes" ], "summary": "Get all notes for a customer contact", "description": "Get all notes for a customer contact", "operationId": "customer-contact-note-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerContactNote" } }, "examples": { "application/json": "[\n {\n \"customerContactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n},\n {\n \"customerContactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"Jane Doe\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Books\",\n \"key\": \"Favorite Books\",\n \"value\": \"Javascript - The Weird Parts\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Books\"\n },\n {\n \"metadataTag\": \"Books\",\n \"key\": \"Favorite Books\",\n \"value\": \"Camel in Action\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Books\"\n }\n ]\n}\n ]\n}\n]" } } } }, "post": { "tags": [ "Customer Contact Notes" ], "summary": "Create a customer contact note", "description": "Create a customer contact note", "operationId": "customer-contact-note-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContactNote" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactNote" }, "examples": { "application/json": "{\n \"customerContactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n },\n {\n \"metadataTag\": \"Books\",\n \"key\": \"Favorite Books\",\n \"value\": \"Javascript - The Weird Parts\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Books\"\n },\n {\n \"metadataTag\": \"Books\",\n \"key\": \"Favorite Books\",\n \"value\": \"Camel in Action\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Books\"\n }\n ]\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerContactId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/contacts/{customerContactId}/notes/{customerContactNoteId}": { "get": { "tags": [ "Customer Contact Notes" ], "summary": "Get a customer contact note", "description": "Get a customer contact note", "operationId": "customer-contact-note-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactNote" }, "examples": { "application/json": "{\n \"customerContactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}" } } } }, "put": { "tags": [ "Customer Contact Notes" ], "summary": "Update a customer contact note", "description": "Update a customer contact note", "operationId": "customer-contact-note-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContactNote" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactNote" }, "examples": { "application/json": "{\n \"customerContactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"noteDetail\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n \"lastUpdated\": \"2016-02-28T16:41:41.090Z\",\n \"metadata\": [\n {\n \"metadataTag\": \"Colors\",\n \"key\": \"Favorite Color\",\n \"value\": \"Red\",\n \"valueFormat\": \"String\",\n \"displayLabel\": \"Favorite Color\"\n }\n ]\n}" } } } }, "delete": { "tags": [ "Customer Contact Notes" ], "summary": "Delete a customer contact note", "description": "Delete a customer contact note", "operationId": "customer-contact-note-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerContactId", "in": "path", "required": true, "type": "string" }, { "name": "customerContactNoteId", "in": "path", "required": true, "type": "string" } ] }, "/customer-contact-roles": { "get": { "tags": [ "Customer Contact Roles" ], "summary": "Returns a list of customer contact roles", "description": "Returns a list of customer contact roles", "operationId": "customer-contact-roles-get-list", "produces": [ "application/json" ], "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0).", "default": 0, "x-example": 3 }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of records per page", "default": 0, "x-example": 5 }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "sortBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order", "default": "asc", "enum": [ "asc", "desc" ] }, { "name": "searchText", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results containing specified text in the roleName field" } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerContactRole" } }, "examples": { "application/json": "[\n {\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"roleName\": \"Manager\",\n \"label\": \"HR team\",\n \"primaryContactRole\": true,\n \"dateCreated\": \"2018-01-01T00:00:00.000Z\",\n \"lastUpdated\": \"2018-01-01T00:00:00.000Z\"\n},\n {\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"roleName\": \"Developer\",\n \"label\": \"Development team\",\n \"primaryContactRole\": false,\n \"dateCreated\": \"2018-01-01T00:00:00.000Z\",\n \"lastUpdated\": \"2018-01-01T00:00:00.000Z\"\n}\n]" } } } }, "post": { "tags": [ "Customer Contact Roles" ], "summary": "Create a customer contact role", "description": "Create a customer contact role", "operationId": "customer-contact-roles-create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContactRole" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactRole" }, "examples": { "application/json": "{\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"roleName\": \"Manager\",\n \"label\": \"HR Team\",\n \"primaryContactRole\": true,\n \"dateCreated\": \"2018-01-01T00:00:00.000Z\",\n \"lastUpdated\": \"2018-01-01T00:00:00.000Z\"\n}" } }, "400": { "description": "Status 400", "schema": { "type": "object" } }, "409": { "description": "Status 409" } } } }, "/customer-contact-roles/{customerContactRoleId}": { "get": { "tags": [ "Customer Contact Roles" ], "summary": "Returns a customer contact role", "description": "Returns a customer contact role", "operationId": "customer-contact-roles-get", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactRole" }, "examples": { "application/json": "{\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"roleName\": \"Manager\",\n \"label\": \"HR Team\",\n \"primaryContactRole\": true,\n \"dateCreated\": \"2018-01-01T00:00:00.000Z\",\n \"lastUpdated\": \"2018-01-01T00:00:00.000Z\"\n}" } }, "404": { "description": "Status 404" } } }, "put": { "tags": [ "Customer Contact Roles" ], "summary": "Updates a customer contact role", "description": "Updates a customer contact role", "operationId": "customer-contact-roles-update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerContactRole" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerContactRole" }, "examples": { "application/json": "{\n \"customerContactRoleId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"roleName\": \"Manager\",\n \"label\": \"HR Team\",\n \"primaryContactRole\": true,\n \"dateCreated\": \"2018-01-01T00:00:00.000Z\",\n \"lastUpdated\": \"2018-01-01T00:00:00.000Z\"\n}" } }, "400": { "description": "Status 400", "schema": { "type": "object" } }, "404": { "description": "Status 404", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Customer Contact Roles" ], "summary": "Deletes a customer contact role", "description": "Deletes a customer contact role", "operationId": "customer-contact-roles-delete", "parameters": [], "responses": { "204": { "description": "Status 204" }, "404": { "description": "Status 404" } } }, "parameters": [ { "name": "customerContactRoleId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/tags": { "get": { "tags": [ "Customer Tag" ], "summary": "Get all tags for customer", "description": "Get all tags for customer", "operationId": "customer-tag-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerTag" } }, "examples": { "application/json": "[\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n},\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"TLC Needed\"\n},\n {\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"tagName\": \"Very first one\"\n}\n]" } } } }, "post": { "tags": [ "Customer Tag" ], "summary": "Create a customer tag", "description": "Create a customer tag", "operationId": "customer-tag-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerTag" }, "examples": { "application/json": "{\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/tags/{customerTagId}": { "get": { "tags": [ "Customer Tag" ], "summary": "Get a customer tag", "description": "Get a customer tag", "operationId": "customer-tag-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerTag" }, "examples": { "application/json": "{\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n}" } } } }, "put": { "tags": [ "Customer Tag" ], "summary": "Update a customer tag", "description": "Update a customer tag", "operationId": "customer-tag-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerTag" }, "examples": { "application/json": "{\n \"customerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"VIP Customer\"\n}" } } } }, "delete": { "tags": [ "Customer Tag" ], "summary": "Delete a customer tag", "description": "Delete a customer tag", "operationId": "customer-tag-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerTagId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/account-owner-tags": { "get": { "tags": [ "Customer Account Owner Tags" ], "summary": "Get all account owner tags for customer", "description": "Get all account owner tags for customer", "operationId": "customer-account-owner-tag-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountOwnerTag" } }, "examples": { "application/json": "[\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n},\n {\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jules Verne\"\n}\n]" } } } }, "post": { "tags": [ "Customer Account Owner Tags" ], "summary": "Create a customer account owner tag", "description": "Create a customer account owner tag", "operationId": "customer-account-owner-tag-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountOwnerTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountOwnerTag" }, "examples": { "application/json": "{\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/account-owner-tags/{accountOwnerTagId}": { "get": { "tags": [ "Customer Account Owner Tags" ], "summary": "Get a customer tag", "description": "Get a customer tag", "operationId": "customer-account-owner-tag-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountOwnerTag" }, "examples": { "application/json": "{\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "put": { "tags": [ "Customer Account Owner Tags" ], "summary": "Update a customer tag", "description": "Update a customer tag", "operationId": "customer-account-owner-tag-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountOwnerTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountOwnerTag" }, "examples": { "application/json": "{\n \"accountOwnerTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "delete": { "tags": [ "Customer Account Owner Tags" ], "summary": "Delete a customer tag", "description": "Delete a customer tag", "operationId": "customer-account-owner-tag-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "accountOwnerTagId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/account-source-tags": { "get": { "tags": [ "Customer Account Source" ], "summary": "Get all account source tags for customer", "description": "Get all account source tags for customer", "operationId": "customer-account-source-tag-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountSourceTag" } }, "examples": { "application/json": "[\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n},\n {\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jules Verne\"\n}\n]" } } } }, "post": { "tags": [ "Customer Account Source" ], "summary": "Create a customer account source tag", "description": "Create a customer account source tag", "operationId": "customer-account-source-tag-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountSourceTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountSourceTag" }, "examples": { "application/json": "{\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/account-source-tags/{accountSourceTagId}": { "get": { "tags": [ "Customer Account Source" ], "summary": "Get a customer account source tag", "description": "Get a customer account source tag", "operationId": "customer-account-source-tag-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountSourceTag" }, "examples": { "application/json": "{\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "put": { "tags": [ "Customer Account Source" ], "summary": "Update a customer account source tag", "description": "Update a customer account source tag", "operationId": "customer-account-source-tag-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountSourceTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/AccountSourceTag" }, "examples": { "application/json": "{\n \"accountSourceTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "delete": { "tags": [ "Customer Account Source" ], "summary": "Delete a customer account source tag", "description": "Delete a customer account source tag", "operationId": "customer-account-source-tag-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "accountSourceTagId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/sales-rep-tags": { "get": { "tags": [ "Customer Sales Representitives" ], "summary": "Get all sales rep tags for customer", "description": "Get all sales rep tags for customer", "operationId": "customer-sales-rep-tag-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/SalesRepTag" } }, "examples": { "application/json": "[\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n},\n {\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jules Verne\"\n}\n]" } } } }, "post": { "tags": [ "Customer Sales Representitives" ], "summary": "Create a customer sales rep tag", "description": "Create a customer sales rep tag", "operationId": "customer-salesrep-tag-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesRepTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SalesRepTag" }, "examples": { "application/json": "{\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/sales-rep-tags/{salesRepTagId}": { "get": { "tags": [ "Customer Sales Representitives" ], "summary": "Get a customer sales rep tag", "description": "Get a customer sales rep tag", "operationId": "customer-salesrep-tag-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SalesRepTag" }, "examples": { "application/json": "{\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "put": { "tags": [ "Customer Sales Representitives" ], "summary": "Update a customer sales rep tag", "description": "Update a customer sales rep tag", "operationId": "customer-salesrep-tag-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesRepTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SalesRepTag" }, "examples": { "application/json": "{\n \"salesRepTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "delete": { "tags": [ "Customer Sales Representitives" ], "summary": "Delete a customer sales rep tag", "description": "Delete a customer tag", "operationId": "customer-salesrep-tag-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "salesRepTagId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/segment-tags": { "get": { "tags": [ "Customer Industry - Segment" ], "summary": "Get all industry tags for customer", "description": "Get all industry tags for customer", "operationId": "customer-industry-tag-get-list", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/SegmentTag" } }, "examples": { "application/json": "[\n {\n \"segmentId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n},\n {\n \"segmentId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Jules Verne\"\n}\n]" } } } }, "post": { "tags": [ "Customer Industry - Segment" ], "summary": "Create a customer industry tag", "description": "Create a customer industry tag", "operationId": "customer-industry-tag-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SegmentTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SegmentTag" }, "examples": { "application/json": "{\n \"segmentId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/segment-tags/{segmentTagId}": { "get": { "tags": [ "Customer Industry - Segment" ], "summary": "Get a customer industry tag", "description": "Get a customer industry tag", "operationId": "customer-industry-tag-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SegmentTag" }, "examples": { "application/json": "{\n \"segmentId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "put": { "tags": [ "Customer Industry - Segment" ], "summary": "Update a customer industry tag", "description": "Update a customer industry tag", "operationId": "customer-industry-tag-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SegmentTag" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/SegmentTag" }, "examples": { "application/json": "{\n \"segmentId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Adam Mann\"\n}" } } } }, "delete": { "tags": [ "Customer Industry - Segment" ], "summary": "Delete a customer industry tag", "description": "Delete a customer industry tag", "operationId": "customer-industry-tag-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "segmentTagId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/journeys": { "get": { "tags": [ "Customer Journeys" ], "summary": "Get all journeys for customer", "description": "Get all journeys for customer", "operationId": "customer-journeys-get-list", "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0)." }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page" }, { "name": "tags", "in": "query", "required": false, "type": "array", "description": "Optional parameter to filter by one or more tags using the tagId", "items": { "type": "string" } }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "sortyBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order" } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerJourney" } }, "examples": { "application/json": "[\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T13:00:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"lifecycleName\": \"Customer Onboarding\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\"\n },\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T00:01:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"lifecycleName\": \"Equipment setup\",\n \"versionNo\": 1,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Equipment setup\",\n \"stepStartCycleDatetime\": \"2016-05-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-05-29T16:41:41.090Z\"\n },\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440003\",\n \"entityLifecycleLastUpdated\": \"2018-06-05T00:01:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440003\",\n \"lifecycleName\": \"Lifecycle 3\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-06-01T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-05-29T16:41:41.090Z\"\n }\n]" } } } }, "post": { "tags": [ "Customer Journeys" ], "summary": "Record activity for a journey", "description": "Record activity for a journey", "operationId": "customer-journey-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerJourney" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerJourney" }, "examples": { "application/json": "{\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T13:00:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"lifecycleName\": \"Customer Onboarding\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\"\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/journeys/most-recent": { "get": { "tags": [ "Customer Journeys" ], "summary": "Most recent journey activity", "description": "Most recent journey activity", "operationId": "customer-journeys-most-recent", "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0)." }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page" }, { "name": "tags", "in": "query", "required": false, "type": "array", "description": "Optional parameter to filter by one or more tags using the tagId", "items": { "type": "string" } }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "sortyBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order" } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerJourney" } }, "examples": { "application/json": "[\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T13:00:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"lifecycleName\": \"Customer Onboarding\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\"\n },\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T00:01:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"lifecycleName\": \"Equipment setup\",\n \"versionNo\": 1,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Equipment setup\",\n \"stepStartCycleDatetime\": \"2016-05-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-05-29T16:41:41.090Z\"\n },\n {\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440003\",\n \"entityLifecycleLastUpdated\": \"2018-06-05T00:01:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440003\",\n \"lifecycleName\": \"Lifecycle 3\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-06-01T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-05-29T16:41:41.090Z\"\n }\n]" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/journeys/{customerJourneyId}": { "get": { "tags": [ "Customer Journeys" ], "summary": "Get a customer journey", "description": "Get a customer journey", "operationId": "customer-journeys-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerJourney" }, "examples": { "application/json": "{\n \"customerJourneyId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"entityLifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"entityLifecycleLastUpdated\": \"2018-06-03T13:00:11.000Z\",\n \"entityLifecycleTags\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Sales Dept\"\n }\n ],\n \"lifecycleId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"lifecycleName\": \"Customer Onboarding\",\n \"versionNo\": 2,\n \"currentStepId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"stepType\": \"In_Progress\",\n \"stepName\": \"Customer Welcome\",\n \"stepStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\",\n \"cycleStartCycleDatetime\": \"2016-02-28T16:41:41.090Z\"\n}" } } } }, "delete": { "tags": [ "Customer Journeys" ], "summary": "Delete a customer journey (unlink)", "description": "Delete a customer journey. Removes link between Customer and EntityLifecycle. Remember to also delete the EntityLifecycle if applicable.", "operationId": "customer-journeys-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerJourneyId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/activity": { "get": { "tags": [ "Customer Activity" ], "summary": "Get all customer activity", "description": "Get all customer activity", "operationId": "customer-activity-get-list", "parameters": [ { "name": "pageOffset", "in": "query", "required": false, "type": "number", "description": "Number of pages away from the first one. The first one is zero (0).", "x-example": 3 }, { "name": "pageSize", "in": "query", "required": false, "type": "number", "description": "Number of items per page", "x-example": 5 }, { "name": "tags[]", "in": "query", "required": false, "type": "array", "description": "Optional parameter to filter by one or more tags using the tagId", "items": { "$ref": "#/definitions/TagId" }, "x-example": "tags[]=123e4567-e89b-12d3-a456-426655440000&tags[]=123e4567-e89b-12d3-a456-426655440001" }, { "name": "fromDatetime", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results for records created after the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "toDatetime", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results for records created before the specified date-time", "x-example": "2016-02-28T16:41:41.090Z" }, { "name": "sortBy", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by specified field name" }, { "name": "sortOrder", "in": "query", "required": false, "type": "string", "description": "Optional parameter to sort by ascending or descending order", "default": "asc", "enum": [ "asc", "desc" ] }, { "name": "searchText", "in": "query", "required": false, "type": "string", "description": "Optional parameter to limit search results containing specified text" } ], "responses": { "200": { "description": "Status 200", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerActivity" } }, "examples": { "application/json": "[\n {\n \"customerActivityId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"activityDetail\": \"Address changed from 123 Elm to 321 Elm\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2018-07-09T05:13:13.000Z\",\n \"lastUpdated\": \"2018-07-09T05:13:13.000Z\",\n \"activityTagList\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Change of personal info\"\n },\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"tagName\": \"Changed address\"\n }\n ]\n },\n {\n \"customerActivityId\": \"123e4567-e89b-12d3-a456-426655440002\",\n \"activityDetail\": \"Phone changed from 480-555-1211 to 480-555-1212\",\n \"authorName\": \"Jane Doe\",\n \"dateCreated\": \"2018-07-09T05:13:13.000Z\",\n \"lastUpdated\": \"2018-07-09T05:13:13.000Z\",\n \"activityTagList\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Change of personal info\"\n },\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440001\",\n \"tagName\": \"Changed Phone\"\n }\n ]\n }\n]" } } } }, "post": { "tags": [ "Customer Activity" ], "summary": "Log a customer activity", "description": "Log a customer activity", "operationId": "customer-activity-create", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerActivity" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerActivity" }, "examples": { "application/json": "{\n \"customerActivityId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"activityDetail\": \"Address changed from 123 Elm to 321 Elm\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2018-07-09T05:13:13.000Z\",\n \"lastUpdated\": \"2018-07-09T05:13:13.000Z\",\n \"activityTagList\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Change of address\"\n }\n ]\n}" } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" } ] }, "/customers/{customerId}/activity/{customerActivityId}": { "get": { "tags": [ "Customer Activity" ], "summary": "Get a customer activity", "description": "Get a customer activity", "operationId": "customer-activity-get", "parameters": [], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerActivity" }, "examples": { "application/json": "{\n \"customerActivityId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"activityDetail\": \"Address changed from 123 Elm to 321 Elm\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2018-07-09T05:13:13.000Z\",\n \"lastUpdated\": \"2018-07-09T05:13:13.000Z\",\n \"activityTagList\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Change of address\"\n }\n ]\n}" } } } }, "put": { "tags": [ "Customer Activity" ], "summary": "Update a customer activity", "description": "Update a customer activity", "operationId": "customer-activity-update", "consumes": [], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CustomerActivity" } } ], "responses": { "200": { "description": "Status 200", "schema": { "$ref": "#/definitions/CustomerActivity" }, "examples": { "application/json": "{\n \"customerActivityId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"activityDetail\": \"Address changed from 123 Elm to 321 Elm\",\n \"authorName\": \"John Smith\",\n \"dateCreated\": \"2018-07-09T05:13:13.000Z\",\n \"lastUpdated\": \"2018-07-09T05:13:13.000Z\",\n \"activityTagList\": [\n {\n \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n \"tagName\": \"Change of address\"\n }\n ]\n}" } } } }, "delete": { "tags": [ "Customer Activity" ], "summary": "Delete a customer activity", "description": "Delete a customer activity", "operationId": "customer-activity-delete", "parameters": [], "responses": { "204": { "description": "Status 204" } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "customerActivityId", "in": "path", "required": true, "type": "string" } ] } }, "definitions": { "Customer": { "type": "object", "properties": { "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerAccountSourceTagList": { "type": "array", "items": { "$ref": "#/definitions/AccountSourceTag" } }, "customerAccountOwnerTagList": { "type": "array", "items": { "$ref": "#/definitions/AccountOwnerTag" } }, "customerSalesRepTagList": { "type": "array", "items": { "$ref": "#/definitions/SalesRepTag" } }, "customerImageURL": { "type": "string", "example": "https://members.chassi.com/123e4567-e89b-12d3-a456-426655440000.png" }, "customerName": { "type": "string", "example": "SlashNote.com" }, "customerEmail": { "type": "string", "example": "admin@slashnote.tld" }, "customerPhone": { "type": "string", "description": "800-555-1234", "example": "800-555-1234" }, "customerCreatedBy": { "type": "string", "example": "John Smith" }, "customerCreatedByUserId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerBillingAddress": { "$ref": "#/definitions/Address" }, "customerShippingAddress": { "$ref": "#/definitions/Address" }, "customerDescription": { "type": "string", "example": "Great customer for online notes" }, "crmIdentifier": { "type": "string", "example": "crm-a63424932" }, "accountNumber": { "type": "string", "example": "101567839" }, "customerSupportPIN": { "type": "string", "example": "555666" }, "websiteURL": { "type": "string", "example": "https://slashnotes.com" }, "customerFax": { "type": "string", "example": "800-555-1234" }, "customerBirthday": { "type": "string", "pattern": "yyyy-MM-dd", "example": "2018-02-18" }, "customerEmployeeCountTagId": { "$ref": "#/definitions/TagIdentifier" }, "customerSegmentTagList": { "type": "array", "items": { "$ref": "#/definitions/SegmentTag" } }, "customerTagList": { "type": "array", "items": { "$ref": "#/definitions/CustomerTag" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataElement" } }, "dateCreated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" } }, "description": "The Customer represents a relationship between a person and a team within a tenant." }, "Address": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "123 Elm Street" }, "addressLine2": { "type": "string", "example": "Suite 301" }, "city": { "type": "string", "example": "Phoenix" }, "stateOrProvince2Digit": { "type": "string", "example": "AZ" }, "postalCode": { "type": "string", "example": "85034" }, "countryCode2Digit": { "type": "string", "example": "US" } } }, "MetadataElement": { "type": "object", "properties": { "metadataTag": { "type": "string", "example": "Colors" }, "key": { "type": "string", "example": "Favorite Color" }, "value": { "type": "string", "example": "Red" }, "valueFormat": { "type": "string", "enum": [ "String", "Text", "Number", "Date", "Time", "Datetime", "Boolean" ], "example": "String" }, "displayLabel": { "type": "string", "example": "Favorite Color" } } }, "TagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "TagIdentifier": { "type": "object", "properties": { "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "Sales Dept" } } }, "CustomerNote": { "type": "object", "properties": { "customerNoteId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "noteDetail": { "type": "string", "example": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book." }, "authorName": { "type": "string", "example": "John Smith" }, "dateCreated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataElement" } } } }, "CustomerContact": { "type": "object", "properties": { "customerContactId": { "type": "string", "description": "Link between Customer and Contact", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "contactId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "contactTitle": { "type": "string", "example": "Dr" }, "contactName": { "type": "string", "example": "Sam Jones" }, "customerContactRoleId": { "type": "string", "description": "The optional id for a customer contact role", "example": "123e4567-e89b-12d3-a456-426655440000" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/definitions/EmailAddress" } }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/PhoneNumber" } }, "physicalAddresses": { "type": "array", "items": { "$ref": "#/definitions/PhysicalAddress" } }, "customerContactTags": { "type": "array", "items": { "$ref": "#/definitions/CustomerContactTag" } }, "primaryCustomerContact": { "type": "boolean", "description": "Flag to indicate if the customer contact is a primary one", "example": true }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataElement" } }, "dateCreated": { "type": "string", "format": "date-time", "example": "2018-01-01T00:00:00.000Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2018-03-01T12:13:16.000Z" } } }, "PhysicalAddress": { "type": "object", "properties": { "physicalAddressId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "contactId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "label": { "type": "string", "description": "A user defined label for this mailing address.", "example": "mailing" }, "attention": { "type": "string", "example": "Sam Smith" }, "addressLine1": { "type": "string", "example": "123 Elm" }, "addressLine2": { "type": "string", "example": "Suite 104" }, "city": { "type": "string", "example": "Anytown" }, "stateOrProvince2Digit": { "type": "string", "example": "AZ" }, "postalCode": { "type": "string", "example": "85034" }, "countryCode2Digit": { "type": "string", "example": "US" }, "primaryAddress": { "type": "boolean", "description": "Indicates a primary address", "default": false, "example": true } }, "description": "Treated only as an embedded object (not standalone entity) to be incorporated in other entities (e.g. Contact)." }, "PhoneNumber": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "contactId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "label": { "type": "string", "description": "A user defined label for this phone number.", "example": "Cell" }, "countryCode": { "type": "string", "description": "Phone number country code", "example": "1" }, "phoneNumber": { "type": "string", "example": "1 (555) 123-1234" }, "primaryPhoneNumber": { "type": "boolean", "description": "Is a primary phone number", "default": false, "example": true } }, "description": "Treated only as an embedded object (not standalone entity) to be incorporated in other entities (e.g. Contact).\n\nFollows the ITU E.164 International Public Telecommunication numbering plan: https://en.wikipedia.org/wiki/E.164\n\nAs used, by example Twilio: https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers" }, "EmailAddress": { "type": "object", "properties": { "emailAddressId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "contactId": { "type": "string", "example": "123e4567-e89b-12d3-a456-42665544000" }, "label": { "type": "string", "description": "A user defined label for this email address", "example": "Work email" }, "emailAddress": { "type": "string", "example": "indianajones@chassi.com" }, "primaryEmailAddress": { "type": "boolean", "description": "Flag indicating primary email", "default": false, "example": true } } }, "CustomerContactTag": { "type": "object", "properties": { "customerContactTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerContactId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "VIP Contact" } } }, "ContactIdList": { "type": "object", "properties": { "contactIdList": { "type": "array", "description": "An array of contact Ids", "items": { "type": "string", "example": "[\n \"123e4567-e89b-12d3-a456-426655440001\", \"123e4567-e89b-12d3-a456-426655440000\"\n]" } } } }, "CustomerContactNote": { "type": "object", "properties": { "customerContactNoteId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "noteDetail": { "type": "string", "example": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book." }, "authorName": { "type": "string", "example": "Adam Mann" }, "dateCreated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MetadataElement" } } } }, "CustomerContactRole": { "type": "object", "properties": { "customerContactRoleId": { "type": "string", "description": "The id for the customer contact role entity", "example": "123e4567-e89b-12d3-a456-426655440000" }, "roleName": { "type": "string", "description": "A user defined name for the contact role", "example": "Manager" }, "label": { "type": "string", "description": "A user defined label for the contact role" }, "primaryContactRole": { "type": "boolean", "description": "Indicates if the role is to be a primary contact", "default": false, "example": true }, "dateCreated": { "type": "string", "format": "date-time", "example": "2018-01-01T00:00:00.000Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2018-01-01T00:00:00.000Z" } } }, "CustomerTag": { "type": "object", "properties": { "customerTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "VIP Customer" } } }, "AccountOwnerTag": { "type": "object", "properties": { "accountOwnerTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "Adam Mann" } } }, "AccountSourceTag": { "type": "object", "properties": { "accountSourceTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "Adam Mann" } } }, "SalesRepTag": { "type": "object", "properties": { "salesRepTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "Adam Mann" } } }, "SegmentTag": { "type": "object", "properties": { "customerSegmentTagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "tagName": { "type": "string", "example": "Adam Mann" } } }, "CustomerJourney": { "type": "object", "properties": { "customerJourneyId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "customerId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "entityLifecycleId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "entityLifecycleLastUpdated": { "type": "string", "format": "date-time", "example": "2018-05-04T00:01:11.000Z" }, "entityLifecycleTags": { "type": "array", "description": "Tags from the EntityLifecycle", "items": { "$ref": "#/definitions/TagIdentifier" } }, "lifecycleId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "lifecycleName": { "type": "string", "example": "Customer Onboarding" }, "versionNo": { "type": "number", "description": "From LifecycleVersion.versionNo through EntityLifecycle.versionNo", "example": 2 }, "currentStepId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "stepType": { "type": "string", "description": "Copied from LifecycleStep dictionary for given step (server provided)", "enum": [ "In_Progress", "Not_Started", "Done" ], "example": "In_Progress" }, "stepName": { "type": "string", "description": "Copied from LifecycleStep dictionary for given step (server provided)", "example": "Customer Welcome" }, "stepStartCycleDatetime": { "type": "string", "format": "date-time", "description": "Start datetime of the step. Calculate difference from now to determine the age/duration.", "example": "2016-02-28T16:41:41.090Z" }, "cycleStartCycleDatetime": { "type": "string", "format": "date-time", "description": "Start datetime of the journey. Note that this is reset if the entity completes but starts over or is reset from a Done step. Calculate difference from now to determine the age/duration.", "example": "2016-02-28T16:41:41.090Z" } }, "description": "Compare with the generic EntityLifecycle DTO\n" }, "CustomerActivity": { "type": "object", "properties": { "customerActivityId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "dateCreated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "lastUpdated": { "type": "string", "format": "date-time", "example": "2016-02-28T16:41:41.090Z" }, "activityDetail": { "type": "string", "example": "Address changed from 123 Elm to 321 Elm" }, "authorName": { "type": "string", "example": "John Smith" }, "activityTagList": { "type": "array", "description": "List of applicable tags", "items": { "$ref": "#/definitions/TagIdentifier" } } } } } }